Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/nnaridz/RbxGenie/llms.txt

Use this file to discover all available pages before exploring further.

​
Description

Returns the current execution mode of Roblox Studio: edit, play, or server.

​
Endpoint

get_studio_mode

​
Parameters

This tool takes no parameters.

​
Response

​
ok
boolean
Always returns true
​
mode
string
The current mode: "edit", "play", or "server"

​
Mode Values

  • edit: Studio is in edit mode (not running)
  • play: Studio is in play mode (client + server)
  • server: Studio is in server-only mode (no client)

​
Examples

​
In edit mode

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

​
In play mode

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

​
In server mode

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

​
Use Cases

  • Check if Studio is running before starting a test
  • Verify mode after starting or stopping play mode
  • Conditional logic based on current execution context
  • Debugging state issues