API:Class/Studio

Filtered-inheritance mode: While this class technically inherits all Instance class members, some (if not all) have been hidden because they serve no purpose for this object.
Settings: This object has been marked as a settings object. It is used to hold persistent settings, which may be accessible by Roblox Studio's settings menu, or the in-game menu. This object cannot be created.
Studio Only: This API only exists in Roblox Studio.

Configuration icon.pngStudio : Object Icon.pngInstance

The Studio object is a settings object that is exclusive to Roblox Studio. It can be found in Roblox Studio's settings under the Studio tab.

Properties

Properties [toggle]

boolAlways Save Script Changes [StudioOnly]

If set to true, Roblox Studio will attempt to transfer script changes that were made during a Play Solo session to the opened place.

|RMD member="API:Class/Studio/Always Save Script Changes"|If set to true, Roblox Studio will attempt to transfer script changes that were made during a Play Solo session to the opened place.|/RMD|
boolAnimate Hover Over [StudioOnly]

If set to true, the hover selection box that is shown when mousing over selectable objects in the Workspace will flash between Hover Over Color and Select Color based on the Hover Animate Speed.

|RMD member="API:Class/Studio/Animate Hover Over"|If set to true, the hover selection box that is shown when mousing over selectable objects in the Workspace will flash between Hover Over Color and Select Color based on the Hover Animate Speed.|/RMD|
boolAuto Indent [StudioOnly]

If set to true, the script editor will automatically indent when a new stack is created in the script.

|RMD member="API:Class/Studio/Auto Indent"|If set to true, the script editor will automatically indent when a new stack is created in the script.|/RMD|
boolAuto-Save Enabled [StudioOnly]

If set to true, the auto-save mode will be enabled.

|RMD member="API:Class/Studio/Auto-Save Enabled"|If set to true, the auto-save mode will be enabled.|/RMD|
boolAuto-Save Interval (Minutes) [StudioOnly]

Sets the interval (in minutes) that Roblox auto-saves at.

|RMD member="API:Class/Studio/Auto-Save Interval (Minutes)"|Sets the interval (in minutes) that Roblox auto-saves at.|/RMD|
QDirAuto-Save Path [NotAccessibleSecurity] [StudioOnly]

Specifies the directory where auto-save files will be saved in.

|RMD member="API:Class/Studio/Auto-Save Path"|Specifies the directory where auto-save files will be saved in.|/RMD|
Color3Background Color [StudioOnly]

Specifies the background color of Roblox Studio's script editor.

|RMD member="API:Class/Studio/Background Color"|Specifies the background color of Roblox Studio's script editor.|/RMD|
ListDisplayModeBasic Objects Display Mode [StudioOnly]

Sets the scrolling mode of the Advanced Objects tab in Roblox Studio.

|RMD member="API:Class/Studio/Basic Objects Display Mode"|Sets the scrolling mode of the Advanced Objects tab in Roblox Studio.|/RMD|
Color3Built-in Function Color [StudioOnly]

Sets the color of built-in functions and keywords in the script editor.

|RMD member="API:Class/Studio/Built-in Function Color"|Sets the color of built-in functions and keywords in the script editor.|/RMD|
floatCamera Mouse Wheel Speed [StudioOnly]

Sets how many studs the camera will move forward or backwards when using the mouse wheel.

|RMD member="API:Class/Studio/Camera Mouse Wheel Speed"|Sets how many studs the camera will move forward or backwards when using the mouse wheel.|/RMD|
floatCamera Shift Speed [StudioOnly]

Sets the speed in studs/sec that the camera moves while holding down Shift with the movement keys.

|RMD member="API:Class/Studio/Camera Shift Speed"|Sets the speed in studs/sec that the camera moves while holding down Shift with the movement keys.|/RMD|
floatCamera Speed [StudioOnly]

Sets the speed in studs/sec that the camera moves when movement keys are pressed.

|RMD member="API:Class/Studio/Camera Speed"|Sets the speed in studs/sec that the camera moves when movement keys are pressed.|/RMD|
boolClear Output On Start [StudioOnly]

If set to true, the output will be automatically cleared when game sessions are switched.

|RMD member="API:Class/Studio/Clear Output On Start"|If set to true, the output will be automatically cleared when game sessions are switched.|/RMD|
Color3Comment Color [StudioOnly]

Specifies the color of comments in Roblox Studio's script editor.

|RMD member="API:Class/Studio/Comment Color"|Specifies the color of comments in Roblox Studio's script editor.|/RMD|
QDirDefaultScriptFileDir [NotAccessibleSecurity] [StudioOnly]

Specifies the default prompt directory that will be opened when the user activates the Execute Script button in Roblox Studio.

|RMD member="API:Class/Studio/DefaultScriptFileDir"|Specifies the default prompt directory that will be opened when the user activates the Execute Script button in Roblox Studio.|/RMD|
boolDeprecatedObjectsShown [StudioOnly]

If set to true, deprecated objects will be shown in the Advanced Objects window, as well as the Object Browser.

|RMD member="API:Class/Studio/DeprecatedObjectsShown"|If set to true, deprecated objects will be shown in the Advanced Objects window, as well as the Object Browser.|/RMD|
intDevice Pairing Code [StudioOnly]

A 4 digit code that can be used by Roblox's mobile pairing app to connect to your instance of Roblox Studio on the local network.

|RMD member="API:Class/Studio/Device Pairing Code"|A 4 digit code that can be used by Roblox's mobile pairing app to connect to your instance of Roblox Studio on the local network.|/RMD|
boolDrag Multiple Parts As Single Part [StudioOnly]

If set to true, the bounding box of a selection will be used for collision detection while dragging, instead of each individual part being checked. This makes the dragger perform smoother, but with notably less precision.

|RMD member="API:Class/Studio/Drag Multiple Parts As Single Part"|If set to true, the bounding box of a selection will be used for collision detection while dragging, instead of each individual part being checked.

This makes the dragger perform smoother, but with notably less precision.|/RMD|

boolEnable Intellisense [StudioOnly]

Sets the enabled state of the intellisense feature, which is the autofill popup that appears while typing a line in a script.

|RMD member="API:Class/Studio/Enable Intellisense"|Sets the enabled state of the intellisense feature, which is the autofill popup that appears while typing a line in a script.|/RMD|
Color3Error Color [StudioOnly]

Specifies the color of the wavy underline shown when malformed code is detected in the script editor.

|RMD member="API:Class/Studio/Error Color"|Specifies the color of the wavy underline shown when malformed code is detected in the script editor.|/RMD|
Color3Find Selection Background Color [StudioOnly]

Sets the highlight color of matches in the script editor's Find Selection operation (Ctrl+F).

|RMD member="API:Class/Studio/Find Selection Background Color"|Sets the highlight color of matches in the script editor's Find Selection operation (Ctrl+F).|/RMD|
QFontFont [NotAccessibleSecurity] [StudioOnly]

Specifies the font used in the script editor.

|RMD member="API:Class/Studio/Font"|Specifies the font used in the script editor.|/RMD|
HoverAnimateSpeedHover Animate Speed [StudioOnly]

Specifies how frequently the hover animation flashes when the mouse is hovering over a selectable object in the Workspace.

|RMD member="API:Class/Studio/Hover Animate Speed"|Specifies how frequently the hover animation flashes when the mouse is hovering over a selectable object in the Workspace.|/RMD|
Color3Hover Over Color [StudioOnly]

Specifies the color that the hover selection box uses.

|RMD member="API:Class/Studio/Hover Over Color"|Specifies the color that the hover selection box uses.|/RMD|
Color3Keyword Color [StudioOnly]

Sets the text color of built-in Lua keywords.

|RMD member="API:Class/Studio/Keyword Color"|Sets the text color of built-in Lua keywords.|/RMD|
floatLine Thickness [StudioOnly]

Sets the thickness of the PrimaryPart selection adornee. This value is constrained between 0 and 0.05.

|RMD member="API:Class/Studio/Line Thickness"|Sets the thickness of the PrimaryPart selection adornee.

This value is constrained between 0 and 0.05.|/RMD|

boolLuaDebuggerEnabled [StudioOnly]

Specifies whether or not the Lua Debugger feature is enabled.

|RMD member="API:Class/Studio/LuaDebuggerEnabled"|Specifies whether or not the Lua Debugger feature is enabled.|/RMD|
Color3Matching Word Background Color [StudioOnly]

Sets the highlight color of double-clicked variables in the script editor.

|RMD member="API:Class/Studio/Matching Word Background Color"|Sets the highlight color of double-clicked variables in the script editor.|/RMD|
intMaximum Output Lines [StudioOnly]

The maximum number of lines that can be displayed in the output.

|RMD member="API:Class/Studio/Maximum Output Lines"|The maximum number of lines that can be displayed in the output.|/RMD|
Color3Number Color [StudioOnly]

Specifies the color of numbers in Roblox Studio's script editor.

|RMD member="API:Class/Studio/Number Color"|Specifies the color of numbers in Roblox Studio's script editor.|/RMD|
boolOnly Play Audio from Window in Focus [StudioOnly]

If set to true, audio being played will only be heard if the game window is being focused on.

|RMD member="API:Class/Studio/Only Play Audio from Window in Focus"|If set to true, audio being played will only be heard if the game window is being focused on.|/RMD|
Color3Operator Color [StudioOnly]

Sets the text color of operator characters in the script editor.

|RMD member="API:Class/Studio/Operator Color"|Sets the text color of operator characters in the script editor.|/RMD|
QFontOutput Font [NotAccessibleSecurity] [StudioOnly]

Specifies the font used by the output.

|RMD member="API:Class/Studio/Output Font"|Specifies the font used by the output.|/RMD|
OutputLayoutModeOutput Layout Mode [StudioOnly]

Sets the layout mode of the output.

|RMD member="API:Class/Studio/Output Layout Mode"|Sets the layout mode of the output.|/RMD|
boolOverrideCoreScripts [StudioOnly]

If set to true, the OverrideCoreScriptsDir will be used for CoreScripts in Roblox Studio, instead of the default rbxasset://scripts directory.

|RMD member="API:Class/Studio/OverrideCoreScripts"|If set to true, the OverrideCoreScriptsDir will be used for CoreScripts in Roblox Studio, instead of the default rbxasset://scripts directory.|/RMD|
QDirOverrideCoreScriptsDir [NotAccessibleSecurity] [StudioOnly]

The directory used when overriding core scripts. This should point to a clone of Roblox's CoreScript GitHub repository.

|RMD member="API:Class/Studio/OverrideCoreScriptsDir"|The directory used when overriding core scripts.

This should point to a clone of Roblox's CoreScript GitHub repository.|/RMD|

PermissionLevelShownPermissionLevelShown [StudioOnly]

Sets the highest permission level that APIs have to have in order to be shown in the Object Browser. See PermissionLevelShown for more info.

|RMD member="API:Class/Studio/PermissionLevelShown"|Sets the highest permission level that APIs have to have in order to be shown in the Object Browser.

See PermissionLevelShown for more info.|/RMD|

QDirPluginsDir [NotAccessibleSecurity] [StudioOnly]

The directory where local plugins are stored.

|RMD member="API:Class/Studio/PluginsDir"|The directory where local plugins are stored.|/RMD|
Color3Preprocessor Color [StudioOnly]

(OBSOLETE).

|RMD member="API:Class/Studio/Preprocessor Color"|(OBSOLETE).|/RMD|
QDirRecentSavesDir [NotAccessibleSecurity] [StudioOnly]

The directory where recent saves are stored in.

|RMD member="API:Class/Studio/RecentSavesDir"|The directory where recent saves are stored in.|/RMD|
intRender Throttle Percentage [StudioOnly]

Scales how much rendering will be throttled when the game window isn't being focused on. In practice, this property isn't very well understood, and is probably intended for internal use only.

|RMD member="API:Class/Studio/Render Throttle Percentage"|Scales how much rendering will be throttled when the game window isn't being focused on.

In practice, this property isn't very well understood, and is probably intended for internal use only.|/RMD|

intScriptTimeoutLength [StudioOnly]

The time (in seconds) a script can wait to be resumed before timing out.

|RMD member="API:Class/Studio/ScriptTimeoutLength"|The time (in seconds) a script can wait to be resumed before timing out.|/RMD|
Color3Select Color [StudioOnly]

The color of the selection box used with object selections in the Workspace.

|RMD member="API:Class/Studio/Select Color"|The color of the selection box used with object selections in the Workspace.|/RMD|
Color3Select/Hover Color [StudioOnly]

Sets the color of the PrimaryPart selection box.

|RMD member="API:Class/Studio/Select/Hover Color"|Sets the color of the PrimaryPart selection box.|/RMD|
Color3Selection Background Color [StudioOnly]

Sets the background color of selected text in the script editor.

|RMD member="API:Class/Studio/Selection Background Color"|Sets the background color of selected text in the script editor.|/RMD|
Color3Selection Color [StudioOnly]

Sets the text color of selected text in the script editor.

|RMD member="API:Class/Studio/Selection Color"|Sets the text color of selected text in the script editor.|/RMD|
ServerAudioBehaviorServer Audio Behavior [StudioOnly]

Documentation incomplete.

|RMD member="API:Class/Studio/Server Audio Behavior"|Documentation incomplete.|/RMD|
boolShow Core GUI in Explorer while Playing [StudioOnly]

If set to true, the StarterGui icon.pngCoreGui will be visible in the Explorer while the game is running.

|RMD member="API:Class/Studio/Show Core GUI in Explorer while Playing"|If set to true, the StarterGui icon.pngCoreGui will be visible in the Explorer while the game is running.|/RMD|
boolShow Diagnostics Bar [StudioOnly]

If set to true, basic diagnostic information is shown in the bottom right.

|RMD member="API:Class/Studio/Show Diagnostics Bar"|If set to true, basic diagnostic information is shown in the bottom right.|/RMD|
boolShow Hover Over [StudioOnly]

If set to true, hovering over an object in the Workspace will show a selection box.

|RMD member="API:Class/Studio/Show Hover Over"|If set to true, hovering over an object in the Workspace will show a selection box.|/RMD|
boolShow Navigation Mesh [StudioOnly]

No documentation found.

|RMD member="API:Class/Studio/Show Navigation Mesh"|No documentation found.|/RMD|
boolShow QT warnings in output [StudioOnly]

If set to true, certain internal error messages regarding the QT framework that Roblox uses will be shown in the output.

|RMD member="API:Class/Studio/Show QT warnings in output"|If set to true, certain internal error messages regarding the QT framework that Roblox uses will be shown in the output.|/RMD|
Color3String Color [StudioOnly]

Specifies the color of strings in the script editor.

|RMD member="API:Class/Studio/String Color"|Specifies the color of strings in the script editor.|/RMD|
intTab Width [StudioOnly]

Specifies how many spaces are used to represent a tab in the script editor.

|RMD member="API:Class/Studio/Tab Width"|Specifies how many spaces are used to represent a tab in the script editor.|/RMD|
Color3Text Color [StudioOnly]

Specifies the color of normal text in the script editor.

|RMD member="API:Class/Studio/Text Color"|Specifies the color of normal text in the script editor.|/RMD|
boolText Wrapping [StudioOnly]

If set to true, text in the script editor will be wrapped.

|RMD member="API:Class/Studio/Text Wrapping"|If set to true, text in the script editor will be wrapped.|/RMD|
UIStyleUI Style [StudioOnly]

Specifies whether Studio uses the new RibbonBar UI style, or the legacy SystemMenu UI style. SystemMenu is deprecated and newer features may not work correctly with it.

|RMD member="API:Class/Studio/UI Style"|Specifies whether Studio uses the new RibbonBar UI style, or the legacy SystemMenu UI style.

SystemMenu is deprecated and newer features may not work correctly with it.|/RMD|

Color3Warning Color [StudioOnly]

Specifies the color of the wavy underline shown when the script analyzer picks up a problem that should be addressed in the script editor.

|RMD member="API:Class/Studio/Warning Color"|Specifies the color of the wavy underline shown when the script analyzer picks up a problem that should be addressed in the script editor.|/RMD|
If set to true, Roblox Studio will attempt to transfer script changes that were made during a Play Solo session to the opened place.
Animate Hover Over [StudioOnly]
If set to true, the hover selection box that is shown when mousing over selectable objects in the Workspace will flash between Hover Over Color and Select Color based on the Hover Animate Speed.
Auto Indent [StudioOnly]
If set to true, the script editor will automatically indent when a new stack is created in the script.
Auto-Save Enabled [StudioOnly]
If set to true, the auto-save mode will be enabled.
Sets the interval (in minutes) that Roblox auto-saves at.
Auto-Save Path [NotAccessibleSecurity] [StudioOnly]
Specifies the directory where auto-save files will be saved in.
Background Color [StudioOnly]
Specifies the background color of Roblox Studio's script editor.
Sets the scrolling mode of the Advanced Objects tab in Roblox Studio.
Sets the color of built-in functions and keywords in the script editor.
Sets how many studs the camera will move forward or backwards when using the mouse wheel.
Camera Shift Speed [StudioOnly]
Sets the speed in studs/sec that the camera moves while holding down Shift with the movement keys.
Camera Speed [StudioOnly]
Sets the speed in studs/sec that the camera moves when movement keys are pressed.
If set to true, the output will be automatically cleared when game sessions are switched.
Comment Color [StudioOnly]
Specifies the color of comments in Roblox Studio's script editor.
DefaultScriptFileDir [NotAccessibleSecurity] [StudioOnly]
Specifies the default prompt directory that will be opened when the user activates the Execute Script button in Roblox Studio.
If set to true, deprecated objects will be shown in the Advanced Objects window, as well as the Object Browser.
Device Pairing Code [StudioOnly]
A 4 digit code that can be used by Roblox's mobile pairing app to connect to your instance of Roblox Studio on the local network.
If set to true, the bounding box of a selection will be used for collision detection while dragging, instead of each individual part being checked. This makes the dragger perform smoother, but with notably less precision.
Enable Intellisense [StudioOnly]
Sets the enabled state of the intellisense feature, which is the autofill popup that appears while typing a line in a script.
Error Color [StudioOnly]
Specifies the color of the wavy underline shown when malformed code is detected in the script editor.
Sets the highlight color of matches in the script editor's Find Selection operation (Ctrl+F).
Font [NotAccessibleSecurity] [StudioOnly]
Specifies the font used in the script editor.
Hover Animate Speed [StudioOnly]
Specifies how frequently the hover animation flashes when the mouse is hovering over a selectable object in the Workspace.
Hover Over Color [StudioOnly]
Specifies the color that the hover selection box uses.
Keyword Color [StudioOnly]
Sets the text color of built-in Lua keywords.
Line Thickness [StudioOnly]
Sets the thickness of the PrimaryPart selection adornee. This value is constrained between 0 and 0.05.
LuaDebuggerEnabled [StudioOnly]
Specifies whether or not the Lua Debugger feature is enabled.
Sets the highlight color of double-clicked variables in the script editor.
The maximum number of lines that can be displayed in the output.
Number Color [StudioOnly]
Specifies the color of numbers in Roblox Studio's script editor.
If set to true, audio being played will only be heard if the game window is being focused on.
Operator Color [StudioOnly]
Sets the text color of operator characters in the script editor.
Output Font [NotAccessibleSecurity] [StudioOnly]
Specifies the font used by the output.
Output Layout Mode [StudioOnly]
Sets the layout mode of the output.
OverrideCoreScripts [StudioOnly]
If set to true, the OverrideCoreScriptsDir will be used for CoreScripts in Roblox Studio, instead of the default rbxasset://scripts directory.
OverrideCoreScriptsDir [NotAccessibleSecurity] [StudioOnly]
The directory used when overriding core scripts. This should point to a clone of Roblox's CoreScript GitHub repository.
Sets the highest permission level that APIs have to have in order to be shown in the Object Browser. See PermissionLevelShown for more info.
PluginsDir [NotAccessibleSecurity] [StudioOnly]
The directory where local plugins are stored.
Preprocessor Color [StudioOnly]
(OBSOLETE).
RecentSavesDir [NotAccessibleSecurity] [StudioOnly]
The directory where recent saves are stored in.
Scales how much rendering will be throttled when the game window isn't being focused on. In practice, this property isn't very well understood, and is probably intended for internal use only.
ScriptTimeoutLength [StudioOnly]
The time (in seconds) a script can wait to be resumed before timing out.
Select Color [StudioOnly]
The color of the selection box used with object selections in the Workspace.
Select/Hover Color [StudioOnly]
Sets the color of the PrimaryPart selection box.
Sets the background color of selected text in the script editor.
Selection Color [StudioOnly]
Sets the text color of selected text in the script editor.
Documentation incomplete.
If set to true, the StarterGui icon.pngCoreGui will be visible in the Explorer while the game is running.
If set to true, basic diagnostic information is shown in the bottom right.
Show Hover Over [StudioOnly]
If set to true, hovering over an object in the Workspace will show a selection box.
No documentation found.
If set to true, certain internal error messages regarding the QT framework that Roblox uses will be shown in the output.
String Color [StudioOnly]
Specifies the color of strings in the script editor.
Tab Width [StudioOnly]
Specifies how many spaces are used to represent a tab in the script editor.
Text Color [StudioOnly]
Specifies the color of normal text in the script editor.
Text Wrapping [StudioOnly]
If set to true, text in the script editor will be wrapped.
UI Style [StudioOnly]
Specifies whether Studio uses the new RibbonBar UI style, or the legacy SystemMenu UI style. SystemMenu is deprecated and newer features may not work correctly with it.
Warning Color [StudioOnly]
Specifies the color of the wavy underline shown when the script analyzer picks up a problem that should be addressed in the script editor.



|RMD member="API:Class/Studio"|The Studio object is a settings object that is exclusive to Roblox Studio. It can be found in Roblox Studio's settings under the Studio tab. |/RMD|