PcoWSkbVqDnWTu_dm2ix
The Developer Hub is now deprecated and information on this page may no longer be accurate. Instead, you should go to our new and improved documentation. You can also learn more about the future of documentation.
Collapse Sidebar
  1. API Reference
  2. Studio

Studio

Show deprecated
Hide content
  1. apireference
  2. studio

Studio

Show deprecated

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

Color3

"TODO" Color

[NotReplicated]
Color3

"function" Color

[NotReplicated]
Color3

"local" Color

[NotReplicated]
Color3

"nil" Color

[NotReplicated]
Color3

"self" Color

[NotReplicated]
Color3

Active Color

Color3

Active Hover Over Color

bool

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.
bool

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 Studio/Hover Over Color and Studio/Select Color based on the Studio/Hover Animate Speed.
bool

Auto Clean Empty Line

bool

Auto Closing Brackets

bool

Auto Closing Quotes

AutoIndentRule

Auto Indent Rule

bool

Auto-Recovery Enabled

int

Auto-Recovery Interval (Minutes)

QDir

Auto-Recovery Path

Color3

Background Color

[NotReplicated]

Specifies the background color of Roblox Studio’s script editor.
ListDisplayMode

Basic Objects Display Mode

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

Bool Color

[NotReplicated]
Color3

Bracket Color

[NotReplicated]
Color3

Built-in Function Color

[NotReplicated]

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

Camera Mouse Wheel Speed

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

Camera Shift Speed

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

Camera Speed

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

Camera Zoom to Mouse Position

bool

Clear Output On Start

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

CommandBarLocalState

Color3

Comment Color

[NotReplicated]

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

Current Line Highlight Color

[NotReplicated]
Color3

Debugger Current Line Color

[NotReplicated]
Color3

Debugger Error Line Color

[NotReplicated]
QDir

DefaultScriptFileDir

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

DeprecatedObjectsShown

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

DisplayLanguage

Color3

Doc View Code Background Color

[Hidden] [NotReplicated]
bool

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.
bool

Enable Autocomplete

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

Enable Autocomplete Doc View

bool

Enable CoreScript Debugger

bool

Enable Http Sandboxing

bool

Enable Internal Beta Features

bool

Enable Internal Features

bool

Enable Script Analysis

bool

Enable Scrollbar Markers

bool

Enable Signature Help

bool

Enable Signature Help Doc View

bool

Enable Temporary Tabs

bool

Enable Temporary Tabs In Explorer

bool

Enable Type Hover

bool

EnableOnTypeAutocomplete

[Hidden] [NotReplicated]
Color3

Error Color

[NotReplicated]

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

Find Selection Background Color

[NotReplicated]

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

Font

Specifies the font used in the script editor.
bool

Format On Paste

bool

Format On Type

Color3

Function Name Color

[NotReplicated]
bool

Highlight Current Line

bool

Highlight Occurances

HoverAnimateSpeed

Hover Animate Speed

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

Hover Box Thickness

Color3

Hover Over Color

Specifies the color that the hover selection box uses.
bool

Indent Using Spaces

Color3

Keyword Color

[NotReplicated]

Sets the text color of built-in Lua keywords.
float

Line Thickness

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

LocalAssetsFolder

bool

LuaDebuggerEnabled

Specifies whether or not the Lua Debugger feature is enabled.
bool

LuaDebuggerEnabledAtStartup

[Hidden] [ReadOnly] [NotReplicated]
Color3

Luau Keyword Color

[NotReplicated]
Color3

Matching Word Background Color

[NotReplicated]

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

Maximum Output Lines

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

Menu Item Background Color

[NotReplicated]
Color3

Method Color

[NotReplicated]
Color3

Number Color

[NotReplicated]

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

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.
Color3

Operator Color

[NotReplicated]

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

Output Font

Specifies the font used by the output.
OutputLayoutMode

Output Layout Mode

Sets the layout mode of the output.
bool

OverrideCoreScripts

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

OverrideCoreScriptsDir

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

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.
bool

Physical Draggers Select Scope By Default

Color3

Pivot Snap To Geometry Color

bool

PluginDebuggingEnabled

QDir

PluginsDir

The directory where local plugins are stored.
Color3

Primary Text Color

[NotReplicated]
Color3

Property Color

[NotReplicated]
int

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.
bool

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.
Color3

Ruler Color

[NotReplicated]
string

Rulers

RuntimeUndoBehavior

RuntimeUndoBehavior

StudioScriptEditorColorPresets

Script Editor Color Preset

Color3

Script Editor Scrollbar Background Color

[NotReplicated]
Color3

Script Editor Scrollbar Handle Color

[NotReplicated]
Color3

ScriptEditorMenuBorderColor

[Hidden] [NotReplicated]
bool

ScriptEditorShouldShowPluginMethods

[Hidden] [NotReplicated]
int

ScriptTimeoutLength

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

Scroll Past Last Line

bool

Search Content For Core Scripts

Color3

Secondary Text Color

[NotReplicated]
UITheme

UI Theme

[Hidden] [ReadOnly] [NotReplicated] [Deprecated]

Specifies the color scheme of Roblox Studio.

Inherited from Instance: Show Hide

bool

Archivable

Determines if an Instance can be cloned using /Instance/Clone or saved to file.
string

ClassName

[ReadOnly] [NotReplicated]

A read-only string representing the class this Instance belongs to
int

DataCost

[Hidden] [ReadOnly] [NotReplicated] [Deprecated]

The cost of saving the instance using data persistence.
string

Name

A non-unique identifier of the Instance
Instance

Parent

[NotReplicated]

Determines the hierarchical parent of the Instance
bool

RobloxLocked

[Hidden]

A deprecated property that used to protect CoreGui objects
int64

SourceAssetId

[Hidden] [NotReplicated]
bool

archivable

[Hidden] [NotReplicated] [Deprecated]
string

className

[ReadOnly] [NotReplicated] [Deprecated]

Functions

Array

GetAvailableThemes ( )

Returns a list of StudioTheme|themes available in Studio

Inherited from Instance: Show Hide

void

ClearAllChildren ( )

This function destroys all of an Instance’s children.
Instance

Clone ( )

Create a copy of an object and all its descendants, ignoring objects that are not Instance/Archivable|Archivable
void

Destroy ( )

Sets the Instance/Parent property to nil, locks the Instance/Parent property, disconnects all connections, and calls Destroy on all children.
Instance

FindFirstAncestor ( string name )

Returns the first ancestor of the Instance whose Instance/Name is equal to the given name.
Instance

FindFirstAncestorOfClass ( string className )

Returns the first ancestor of the Instance whose Instance/ClassName is equal to the given className.
Instance

FindFirstAncestorWhichIsA ( string className )

Returns the first ancestor of the Instance for whom Instance/IsA returns true for the given className.
Instance

FindFirstChild ( string name , bool recursive )

Returns the first child of the Instance found with the given name.
Instance

FindFirstChildOfClass ( string className )

Returns the first child of the Instance whose Instance/ClassName|ClassName is equal to the given className.
Instance

FindFirstChildWhichIsA ( string className , bool recursive )

Returns the first child of the Instance for whom Instance/IsA returns true for the given className.
Instance

FindFirstDescendant ( string name )

Returns the first descendant found with the given Instance/Name.
Actor

GetActor ( )

Returns the Actor associated with the Instance, usually the first Actor ancestor
Variant

GetAttribute ( string attribute )

Returns the attribute which has been assigned to the given name
RBXScriptSignal

GetAttributeChangedSignal ( string attribute )

Returns an event that fires when the given attribute changes
Dictionary

GetAttributes ( )

Returns a dictionary of string → variant pairs for each of the Instance|Instance’s attributes
Objects

GetChildren ( )

Returns an array containing all of the Instance’s children.
string

GetDebugId ( int scopeLength )

[NotBrowsable]

Returns a coded string of the Instances DebugId used internally by Roblox.
Array

GetDescendants ( )

[CustomLuaState]

Returns an array containing all of the descendants of the instance
string

GetFullName ( )

Returns a string describing the Instance’s ancestry.
RBXScriptSignal

GetPropertyChangedSignal ( string property )

Get an event that fires when a given property of an object changes.
bool

IsA ( string className )

[CustomLuaState]

Returns true if an Instance’s class matches or inherits from a given class
bool

IsAncestorOf ( Instance descendant )

Returns true if an Instance is an ancestor of the given descendant.
bool

IsDescendantOf ( Instance ancestor )

Returns true if an Instance is a descendant of the given ancestor.
void

Remove ( )

[Deprecated]

Sets the object’s Parent to nil, and does the same for all its descendants.
void

SetAttribute ( string attribute , Variant value )

Sets the attribute with the given name to the given value
Instance

WaitForChild ( string childName , double timeOut )

[CustomLuaState] [CanYield]

Returns the child of the Instance with the given name. If the child does not exist, it will yield the current thread until it does.
Objects

children ( )

[Deprecated]

Returns an array of the object’s children.
Instance

clone ( )

[Deprecated]
void

destroy ( )

[Deprecated]
Instance

findFirstChild ( string name , bool recursive )

[Deprecated]
Objects

getChildren ( )

[Deprecated]
bool

isA ( string className )

[Deprecated] [CustomLuaState]
bool

isDescendantOf ( Instance ancestor )

[Deprecated]
void

remove ( )

[Deprecated]

Events

RBXScriptSignal

ThemeChanged ( )

Event called when Studio’s StudioTheme|theme changes

Inherited from Instance: Show Hide

RBXScriptSignal

AncestryChanged ( Instance child , Instance parent )

Fires when the Instance/Parent property of the object or one of its ancestors is changed.
RBXScriptSignal

AttributeChanged ( string attribute )

Fires whenever an attribute is changed on the Instance
RBXScriptSignal

Changed ( string property )

Fired immediately after a property of an object changes.
RBXScriptSignal

ChildAdded ( Instance child )

Fires after an object is parented to this Instance.
RBXScriptSignal

ChildRemoved ( Instance child )

Fires after a child is removed from this Instance.
RBXScriptSignal

DescendantAdded ( Instance descendant )

Fires after a descendant is added to the Instance
RBXScriptSignal

DescendantRemoving ( Instance descendant )

Fires immediately before a descendant of the Instance is removed.
RBXScriptSignal

Destroying ( )

Fires immediately before the instance is destroyed via Instance/Destroy.
RBXScriptSignal

childAdded ( Instance child )

[Deprecated]
RenderSettings TaskScheduler