Skip to main content

​
Description

Stops the current play mode or server session in Roblox Studio, equivalent to clicking the “Stop” button.

​
Endpoint

stop_play

​
Parameters

This tool takes no parameters.

​
Response

​
ok
boolean
Returns true if the session was stopped successfully
​
mode
string
Returns "edit" to indicate the mode after stopping
​
error
string
Error message if there was no active session to stop

​
Examples

​
Stop play mode

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

​
Not running

{}
Response: 
{
  "error": "Not running"
}

​
Notes

  • Works for both play mode and server mode
  • The operation is asynchronous
  • Returns to edit mode after stopping
  • Use get_studio_mode to verify the mode after stopping

Build docs developers (and LLMs) love

Get started for freeTalk to us