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.
Summary
Properties
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.
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.
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.
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.
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.
Sets the highlight color of matches in the script editor's Find Selection operation (Ctrl+F).
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.
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.
Sets the highlight color of double-clicked variables in the script editor.
The maximum number of lines that can be displayed in the output.
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.
Sets the text color of operator characters in the script editor.
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 Enum.PermissionLevelShown for more info.
The directory where local plugins are stored.
When set to true, Roblox Studio shortcuts will take priority over inputs being captured in the game window.
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.
Sets the text color of selected text in the script editor.
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.
Specifies the color of strings in the script editor.
Specifies how many spaces are used to represent a tab in the script editor.
Specifies the color of normal text in the script editor.
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.
Methods
Returns a list of themes available in Studio.
Events
Event called when Studio's theme changes.
Properties
"TODO" Color
"function" Color
"local" Color
"nil" Color
"self" Color
ActionOnStopSync
Active Color
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 Delete Closing Brackets and Quotes
Auto Indent Rule
Auto-Recovery Enabled
Auto-Recovery Interval (Minutes)
Automatically trigger AI Code Completion
Basic Objects Display Mode
Sets the scrolling mode of the Advanced Objects tab in Roblox Studio.
Bool Color
Bracket Color
Built-in Function Color
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 Adjust Binding
Camera Zoom to Mouse Position
CameraAdaptiveSpeed
CameraTweenFocus
Clear Output On Start
If set to true, the output will be automatically cleared when game sessions are switched.
CommandBarLocalState
Current Line Highlight Color
Debugger Current Line Color
Debugger Error Line Color
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
DraggerActiveColor
DraggerMajorGridIncrement
DraggerMaxSoftSnaps
DraggerPassiveColor
DraggerShowHoverRuler
DraggerShowMeasurement
DraggerShowTargetSnap
DraggerSoftSnapMarginFactor
DraggerSummonMarginFactor
DraggerTiltRotateDuration
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
EnableCodeAssist
EnableIndentationRulers
Error Color
Specifies the color of the wavy underline shown when malformed code is detected in the script editor.
Find Selection Background Color
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
FreeCameraSpeedScroll
Function Name Color
Highlight Current Line
Highlight Occurances
HintColor
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
IconOverrideDir
Indent Using Spaces
IndentationRulerColor
InformationColor
LargeFileLineCountThreshold
LargeFileThreshold
Line Thickness
Sets the thickness of the Model.PrimaryPart selection adornee. This value is constrained between 0 and 0.05.
LoadAllBuiltinPluginsInRunModes
LoadUserPluginsInRunModes
LocalAssetsFolder
LuaDebuggerEnabledAtStartup
Luau Keyword Color
Main Volume
Matching Word Background Color
Sets the highlight color of double-clicked variables in the script editor.
Menu Item Background Color
Method Color
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.
Output Font
Specifies the font used by the output.
PermissionLevelShown
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
Pivot Snap To Geometry Color
PluginDebuggingEnabled
PluginsDir
The directory where local plugins are stored.
Primary Text Color
Property Color
ReloadBuiltinPluginsOnChange
ReloadLocalPluginsOnChange
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
Rulers
RuntimeUndoBehavior
Script Editor Color Preset
Script Editor Scrollbar Background Color
Script Editor Scrollbar Handle Color
Scroll Past Last Line
Secondary Text Color
Selected Menu Item Background Color
Selected Text Color
Selection Box Thickness
Selection Line Thickness
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 FileSyncService
Show Hidden Objects in Explorer
Show Light Guides
Show Navigation Labels
Show Navigation Mesh
When set to true, the navigation mesh used by the PathfindingService will be visualized.
Show Pathfinding Links
Show Plugin GUI Service in Explorer
When set to true, the PluginGuiService will be shown in Roblox Studio's explorer.
Show Singly Selected Attachment Parent Frame
Show Whitespace
Show plus button on hover in Explorer
ShowCorePackagesInExplorer
Skip Closing Brackets and Quotes
Theme
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
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.
Whitespace Color
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
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.