Engine

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

Methods

Events

Properties

"TODO" Color

not replicated
read parallel

"function" Color

not replicated
read parallel

"local" Color

not replicated
read parallel

"nil" Color

not replicated
read parallel

"self" Color

not replicated
read parallel

Active Color

read parallel

Active Hover Over Color

read parallel

Always Save Script Changes

read parallel

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

read parallel

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

read parallel

Auto Closing Brackets

read parallel

Auto Closing Quotes

read parallel

Auto Delete Closing Brackets and Quotes

read parallel

Auto Indent Rule

read parallel

Auto-Recovery Enabled

read parallel

Auto-Recovery Interval (Minutes)

read parallel

Auto-Recovery Path

QDir
read parallel

Automatically commit locked scripts when you save or publish to Roblox

read parallel

Automatically trigger AI Code Completion

read parallel

Background Color

not replicated
read parallel

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

Basic Objects Display Mode

read parallel

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

Bool Color

not replicated
read parallel

Bracket Color

not replicated
read parallel

Built-in Function Color

not replicated
read parallel

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

Camera Mouse Wheel Speed

read parallel

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

Camera Pan Speed

read parallel

Camera Shift Speed

read parallel

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

Camera Speed

read parallel

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

Camera Speed Adjust Binding

read parallel

Camera Zoom to Mouse Position

read parallel

CameraAdaptiveSpeed

read parallel

CameraTweenFocus

read parallel

Clear Output On Start

read parallel

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

CommandBarLocalState

read parallel

Comment Color

not replicated
read parallel

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

Current Line Highlight Color

not replicated
read parallel

Debugger Current Line Color

not replicated
read parallel

Debugger Error Line Color

not replicated
read parallel

DefaultScriptFileDir

QDir
read parallel

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

DeprecatedObjectsShown

read parallel

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

DisplayLanguage

read parallel

DraggerActiveColor

read parallel

DraggerMajorGridIncrement

read parallel

DraggerMaxSoftSnaps

read parallel

DraggerPassiveColor

read parallel

DraggerShowHoverRuler

read parallel

DraggerShowMeasurement

read parallel

DraggerShowTargetSnap

read parallel

DraggerSoftSnapMarginFactor

read parallel

DraggerSummonMarginFactor

read parallel

DraggerTiltRotateDuration

read parallel

Enable Autocomplete

read parallel

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

Enable Autocomplete Doc View

read parallel

Enable CoreScript Debugger

read parallel

Enable Http Sandboxing

read parallel

Enable Internal Beta Features

read parallel

Enable Internal Features

read parallel

Enable Script Analysis

read parallel

Enable Scrollbar Markers

read parallel

Enable Signature Help

read parallel

Enable Signature Help Doc View

read parallel

Enable Temporary Tabs

read parallel

Enable Temporary Tabs In Explorer

read parallel

Enable Type Hover

read parallel

EnableCodeAssist

read parallel

EnableIndentationRulers

read parallel

Error Color

not replicated
read parallel

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

Find Selection Background Color

not replicated
read parallel

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

Font

QFont
read parallel

Specifies the font used in the script editor.

Format On Paste

read parallel

Format On Type

read parallel

FreeCameraSpeedScroll

read parallel

Function Name Color

not replicated
read parallel

Highlight Current Line

read parallel

Highlight Occurances

read parallel

HintColor

not replicated
read parallel

Hover Animate Speed

read parallel

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

Hover Box Thickness

read parallel

Hover Line Thickness

read parallel

Hover Over Color

read parallel

Specifies the color that the hover selection box uses.

IconOverrideDir

QDir
read parallel

Indent Using Spaces

read parallel

IndentationRulerColor

not replicated
read parallel

InformationColor

not replicated
read parallel

Keyword Color

not replicated
read parallel

Sets the text color of built-in Lua keywords.

LargeFileLineCountThreshold

read parallel

LargeFileThreshold

read parallel

Line Thickness

read parallel

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

LoadAllBuiltinPluginsInRunModes

read parallel

LoadUserPluginsInRunModes

read parallel

LocalAssetsFolder

QDir
read parallel

LuaDebuggerEnabled

read parallel

Specifies whether or not the Lua Debugger feature is enabled.

LuaDebuggerEnabledAtStartup

hidden
read only
not replicated
read parallel

Luau Keyword Color

not replicated
read parallel

Main Volume

read parallel

Matching Word Background Color

not replicated
read parallel

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

Maximum Output Lines

read parallel

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

not replicated
read parallel

Method Color

not replicated
read parallel

Number Color

not replicated
read parallel

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

Only Play Audio from Window in Focus

read parallel

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

Operator Color

not replicated
read parallel

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

Output Font

QFont
read parallel

Specifies the font used by the output.

Output Layout Mode

read parallel

Sets the layout mode of the output.

PermissionLevelShown

read parallel

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

Physical Draggers Select Scope By Default

read parallel

Pivot Snap To Geometry Color

read parallel

PluginDebuggingEnabled

read parallel

PluginsDir

QDir
read parallel

The directory where local plugins are stored.

Primary Text Color

not replicated
read parallel

Property Color

not replicated
read parallel

ReloadBuiltinPluginsOnChange

read parallel

ReloadLocalPluginsOnChange

read parallel

Respect Studio shortcuts when game has focus

read parallel

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

Ruler Color

not replicated
read parallel

Rulers

read parallel

RuntimeUndoBehavior

read parallel

Script Editor Color Preset

read parallel

Script Editor Scrollbar Background Color

not replicated
read parallel

Script Editor Scrollbar Handle Color

not replicated
read parallel

ScriptTimeoutLength

read parallel

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

Scroll Past Last Line

read parallel

Secondary Text Color

not replicated
read parallel

Select Color

read parallel

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

Select/Hover Color

read parallel

Sets the color of the Model.PrimaryPart selection box.

Selected Menu Item Background Color

not replicated
read parallel

Selected Text Color

not replicated
read parallel

Selection Background Color

not replicated
read parallel

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

Selection Box Thickness

read parallel

Selection Color

not replicated
read parallel

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

Selection Line Thickness

read parallel

Server Audio Behavior

read parallel

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

Set Pivot of Imported Parts

read parallel

Show Core GUI in Explorer while Playing

read parallel

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

Show Diagnostics Bar

read parallel

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

Show FileSyncService

read parallel

Show Hidden Objects in Explorer

read parallel

Show Hover Over

read parallel

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

Show Light Guides

read parallel

Show Navigation Labels

read parallel

Show Navigation Mesh

read parallel

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

read parallel

Show Plugin GUI Service in Explorer

read parallel

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

Show Singly Selected Attachment Parent Frame

read parallel

Show Whitespace

read parallel

Show plus button on hover in Explorer

read parallel

ShowCorePackagesInExplorer

read parallel

Skip Closing Brackets and Quotes

read parallel

String Color

not replicated
read parallel

Specifies the color of strings in the script editor.

Tab Width

read parallel

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

Text Color

not replicated
read parallel

Specifies the color of normal text in the script editor.

Text Wrapping

read parallel

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

read parallel

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:


settings().Studio.Theme

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


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

Use Bounding Box Move Handles

read parallel

Warning Color

not replicated
read parallel

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
read parallel

Methods

GetAvailableThemes

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


settings().Studio:GetAvailableThemes()

Returns

A list of themes available in Studio.

Code Samples

Output Studio Themes

local themes = settings().Studio:GetAvailableThemes()
for _, theme in pairs(themes) do
print(theme)
end

Events

ThemeChanged

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.