Skip to main content

​
Description

Starts play mode in Roblox Studio, equivalent to clicking the “Play” button. Requires StudioTestService to be available.

​
Endpoint

start_play

​
Parameters

This tool takes no parameters.

​
Response

​
ok
boolean
Returns true if play mode was started successfully
​
mode
string
Returns "play" to indicate the mode that was started
​
error
string
Error message if play mode could not be started

​
Examples

​
Start play mode

{}
Response: 
{
  "ok": true,
  "mode": "play"
}

​
Already running

{}
Response: 
{
  "error": "Already running — stop first"
}

​
Service unavailable

{}
Response: 
{
  "error": "StudioTestService not available"
}

​
Notes

  • The operation is asynchronous and returns immediately
  • You must stop play mode before starting it again
  • Use get_studio_mode to check the current mode
  • Use stop_play to stop the current session

Build docs developers (and LLMs) love

Get started for freeTalk to us