Studio

Show Deprecated
Not Creatable
Service
Not Replicated

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.

Summary

Properties

NOT REPLICATED
NOT REPLICATED
NOT REPLICATED
NOT REPLICATED
NOT REPLICATED

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

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.

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

NOT REPLICATED

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

NOT REPLICATED
NOT REPLICATED

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

NOT REPLICATED

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

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

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.

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

NOT REPLICATED

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.

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.

When set to true, the script editor and command bar will show an autocomplete menu while writing.

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

NOT REPLICATED

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

NOT REPLICATED

Specifies the font used in the script editor.

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

Specifies the color that the hover selection box uses.

Sets the text color of built-in Lua keywords.

NOT REPLICATED

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

Specifies whether or not the Lua Debugger feature is enabled.

NOT REPLICATED

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

NOT REPLICATED

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

NOT REPLICATED

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

NOT REPLICATED

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

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

NOT REPLICATED

Specifies the font used by the output.

Sets the layout mode of the output.

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

The directory where local plugins are stored.

NOT REPLICATED
NOT REPLICATED

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.

When set to true, Roblox Studio shortcuts will take priority over inputs being captured in the game window.

NOT REPLICATED

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

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

Sets the color of the Model.PrimaryPart selection box.

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

NOT REPLICATED

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

NOT REPLICATED

An unused Roblox Studio setting that does not appear to have any functionality.

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

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

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

When set to true, the navigation mesh used by the PathfindingService will be visualized.

When set to true, the PluginGuiService will be shown in Roblox Studio's explorer.

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

Specifies the color of strings in the script editor.

NOT REPLICATED

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

Specifies the color of normal text in the script editor.

NOT REPLICATED

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

Used to get/set current theme used by Studio.

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

NOT REPLICATED
NOT REPLICATED

Events


Event called when Studio's theme changes.

Methods


Returns a list of themes available in Studio.

Properties

"TODO" Color

Not Replicated

"function" Color

Not Replicated

"local" Color

Not Replicated

"nil" Color

Not Replicated

"self" Color

Not Replicated

Active Hover Over Color

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.

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.

Auto Clean Empty Line

Auto Closing Brackets

Auto Closing Quotes

Auto-Recovery Enabled

Auto-Recovery Interval (Minutes)

Auto-Recovery Path

Background Color

Not Replicated

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

Basic Objects Display Mode

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

Bool Color

Not Replicated

Bracket Color

Not Replicated

Built-in Function Color

Not Replicated

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

Camera Mouse Wheel Speed

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

Camera Pan Speed

Camera Shift Speed

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

Camera Speed

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

Camera Zoom to Mouse Position

Clear Output On Start

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

CommandBarLocalState

Comment Color

Not Replicated

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

Current Line Highlight Color

Not Replicated

Debugger Current Line Color

Not Replicated

Debugger Error Line Color

Not Replicated

DefaultScriptFileDir

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

DeprecatedObjectsShown

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

DisplayLanguage

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.

Enable Autocomplete

When set to true, the script editor and command bar will show an autocomplete menu while writing.

Enable Autocomplete Doc View

Enable CoreScript Debugger

Enable Http Sandboxing

Enable Internal Beta Features

Enable Internal Features

Enable Script Analysis

Enable Scrollbar Markers

Enable Signature Help

Enable Signature Help Doc View

Enable Temporary Tabs

Enable Temporary Tabs In Explorer

Enable Type Hover

Error Color

Not Replicated

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

Find Selection Background Color

Not Replicated

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

Font

Specifies the font used in the script editor.

Format On Paste

Format On Type

Function Name Color

Not Replicated

Highlight Current Line

Highlight Occurances

Hover Animate Speed

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

Hover Box Thickness

Hover Line Thickness

Hover Over Color

Specifies the color that the hover selection box uses.

IconOverrideDir

Indent Using Spaces

Keyword Color

Not Replicated

Sets the text color of built-in Lua keywords.

Line Thickness

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

LocalAssetsFolder

LuaDebuggerEnabled

Specifies whether or not the Lua Debugger feature is enabled.

Luau Keyword Color

Not Replicated

Matching Word Background Color

Not Replicated

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

Maximum Output Lines

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

Not Replicated

Method Color

Not Replicated

Number Color

Not Replicated

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

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.

Operator Color

Not Replicated

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

Output Font

Specifies the font used by the output.

Output Layout Mode

Sets the layout mode of the output.

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.

Physical Draggers Select Scope By Default

Pivot Snap To Geometry Color

PluginDebuggingEnabled

PluginsDir

The directory where local plugins are stored.

Primary Text Color

Not Replicated

Property Color

Not Replicated

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.

Respect Studio shortcuts when game has focus

When set to true, Roblox Studio shortcuts will take priority over inputs being captured in the game window.

Ruler Color

Not Replicated

Script Editor Scrollbar Background Color

Not Replicated

Script Editor Scrollbar Handle Color

Not Replicated

ScriptTimeoutLength

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

Scroll Past Last Line

Search Content For Core Scripts

Secondary Text Color

Not Replicated

Select Color

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

Select/Hover Color

Sets the color of the Model.PrimaryPart selection box.

Selected Menu Item Background Color

Not Replicated

Selected Text Color

Not Replicated

Selection Background Color

Not Replicated

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

Selection Color

Not Replicated

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

Selection Highlight Thickness

Selection Line Thickness

Server Audio Behavior

An unused Roblox Studio setting that does not appear to have any functionality.

Set Pivot of Imported Parts

Show Core GUI in Explorer while Playing

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

Show Deployment Warnings

Show Diagnostics Bar

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

Show FileSyncService

Show Hidden Objects in Explorer

Show Hover Over

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

Show Light Guides

Show Navigation Labels

Show Navigation Mesh

When set to true, the navigation mesh used by the PathfindingService will be visualized.

Show Plugin GUI Service in Explorer

When set to true, the PluginGuiService will be shown in Roblox Studio's explorer.

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.

Show Whitespace

Show plus button on hover in Explorer

ShowCorePackagesInExplorer

Skip Closing Brackets and Quotes

String Color

Not Replicated

Specifies the color of strings in the script editor.

Tab Width

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

Text Color

Not Replicated

Specifies the color of normal text in the script editor.

Text Wrapping

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

The Theme property is used to get/set the current StudioTheme used by Studio.

This is intended for use within Plugins, but will also execute in the Command Line. You can access the function via:


1settings().Studio.Theme
2

For instance, if you would like to print the current Studio theme:


1print("The current Studio theme is:", settings().Studio.Theme)
2

Use Bounding Box Move Handles

Warning Color

Not Replicated

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

Whitespace Color

Not Replicated

Events

ThemeChanged

Plugin Security

The ThemeChanged event fires when Studio's Theme changes. The best use of this event is to get the colors from the theme that changed and update your plugin's UI accordingly.


Methods

GetAvailableThemes

Plugin Security

The GetAvailableThemes() function returns a list of StudioThemes available in Studio. You can access the function via:


1settings().Studio:GetAvailableThemes()
2

Returns

A list of themes available in Studio.

Code Samples

Output Studio Themes

1local themes = settings().Studio:GetAvailableThemes()
2
3for _, theme in pairs(themes) do
4 print(theme)
5end