Studio

Represents Roblox Studio's script editor settings.

Memory category: Instances
Own members: 207
Inherited members: 75
Subclasses: 0
Siblings: 608

Properties228

Inherited fromObject2

Property categoryData

Object.ClassName: string
A read-only string representing the class this Object belongs to.
- Read only
Object.className: string
Deprecated: This deprecated property is a variant of Object.ClassName which should be used instead.
- Deprecated
- Read only
Use ClassName instead.

Inherited fromInstance21

Property categoryBehavior

Instance.Archivable: boolean
Determines if an Instance and its descendants can be cloned using Instance:Clone(), and can be saved/published.
Instance.archivable: boolean
Deprecated: This deprecated property is a variant of Instance.Archivable which should be used instead.
- Deprecated
- Hidden
- Not replicated
- Load only
Use Archivable instead.

Property categoryData

Instance.Attributes: string
- Hidden
- Not scriptable
- Read only
- Roblox engine security
Instance.AttributesReplicate: string
- Hidden
- Not scriptable
- Roblox engine security
Instance.AttributesSerialize: string
- Hidden
- Not replicated
- Not scriptable
- Roblox engine security
Instance.HistoryId: UniqueId
- Hidden
- Not replicated
- Not scriptable
- Roblox engine security
Instance.Name: string
A non-unique identifier of the Instance.
Instance.Parent: Instance
Determines the hierarchical parent of the Instance.
- Not replicated
- Load only
Instance.PredictionMode: Enum.PredictionMode
Reflects the client-side prediction mode applied to the instance under server-authoritative physics.
- Not scriptable
- Read only
Instance.PropertyStatusStudio: Enum.PropertyStatus
- Hidden
- Not scriptable
- Read only
- Roblox engine security
Instance.RobloxLocked: boolean
A deprecated property that used to protect CoreGui objects.
- Hidden
- Plugin security
Instance.SerializedOverrides: string
- Hidden
- Not replicated
- Not scriptable
- Roblox engine security
Instance.SourceAssetId: number
- Hidden
- Roblox script security
Instance.Tags: SharedString
- Hidden
- Not scriptable
- Roblox engine security
Instance.UniqueId: UniqueId
A unique identifier for the instance.
- Not replicated
- Read: Roblox script security
- Write: Roblox engine security
Instance.numExpectedDirectChildren: number
- Hidden
- Not scriptable
Instance.DataCost: number
- Deprecated
- Hidden
- Read only
- Local user security

Property categoryPermissions

Instance.Capabilities: SecurityCapabilities
The set of capabilities allowed to be used for scripts inside this container.
- Capabilities: CapabilityControl
Instance.DefinesCapabilities: boolean
- Hidden
- Not scriptable
- Roblox engine security
Instance.IsInSandbox: boolean
Indicates whether the instance is inside a sandboxed container.
- Not scriptable
- Read only
Instance.Sandboxed: boolean
When enabled, the instance can only access abilities in its Capabilities list.
- Not replicated
- Capabilities: CapabilityControl

Defined byStudio205

Property categoryAdvanced

Studio.Enable Client/Server MDI: boolean
- Roblox script security
Studio.Enable CoreScript Debugger: boolean
Controls whether the CoreScript debugger is available in Studio.
- Plugin security
Studio.Enable Http Sandboxing: boolean
Controls whether HTTP requests from plugins are sandboxed.
- Plugin security
Studio.Enable Internal Beta Features: boolean
Controls whether internal beta features are accessible in Studio.
- Plugin security
Studio.Enable Internal Features: boolean
Controls whether internal developer features are accessible in Studio.
- Plugin security
Studio.Respect Studio shortcuts when game has focus: boolean
When set to true, Roblox Studio shortcuts will take priority over inputs being captured in the game window.
- Plugin security
Studio.Set Pivot of Imported Parts: boolean
Sets whether the pivot point is repositioned when parts are imported.
- Plugin security
Studio.Show Diagnostics Bar: boolean
If set to true, basic diagnostic information is shown in the bottom right.
- Plugin security

Property categoryAudio

Studio.Main Volume: number
Sets the main audio playback volume in Studio.
- Roblox script security
Studio.Only Play Audio from Window in Focus: boolean
If set to true, audio being played will only be heard if the game window is being focused on.
- Plugin security

Property categoryAuto-Recovery

Studio.Auto-Recovery Enabled: boolean
Controls whether Studio automatically saves recovery files at a set interval.
- Plugin security
Studio.Auto-Recovery Interval (Minutes): number
- Plugin security

Property categoryBrowsing

Studio.DeprecatedObjectsShown: boolean
If set to true, deprecated objects will be shown in the Advanced Objects window, as well as the Object Browser.
- Plugin security
Studio.PermissionLevelShown: Enum.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.
- Plugin security

Property categoryCamera

Studio.Camera Mouse Wheel Speed: number
Sets how many studs the camera will move forward or backwards when using the mouse wheel.
- Plugin security
Studio.Camera Pan Speed: number
Sets the speed of camera panning in Studio.
- Roblox script security
Studio.Camera Shift Speed: number
Sets the speed in studs/sec that the camera moves while holding down Shift with the movement keys.
- Plugin security
Studio.Camera Speed: number
Sets the speed in studs/sec that the camera moves when movement keys are pressed.
- Plugin security
Studio.Camera Speed Adjust Binding: Enum.CameraSpeedAdjustBinding
Sets the mouse button used to adjust the camera speed in Studio.
- Roblox script security
Studio.Camera Zoom to Mouse Position: boolean
Controls whether the camera zooms toward the mouse cursor position.
- Plugin security
Studio.CameraAltLeftMouseToRotate: boolean
- Roblox script security
Studio.CameraKeyMoveSmoothing: boolean
- Roblox script security
Studio.CameraMouseMultiplier: number
- Roblox script security
Studio.CameraNavigationModel: Enum.CameraNavigationModel
Sets the navigation model used for camera movement in Studio.
- Roblox script security
Studio.CameraRotateShiftFactor: number
- Roblox script security
Studio.CameraShiftFactor: number
Sets the speed multiplier applied to camera movement when Shift is held.
- Roblox script security
Studio.CameraTweenFocus: boolean
Controls whether the camera smoothly tweens when refocusing on a selected object.
- Roblox script security
Studio.CameraZoomToMousePosition: boolean
- Roblox script security

Property categoryData

Studio.DraggerActiveColor: Color3
Sets the color of the active dragger handle in Studio.
- Roblox script security
Studio.DraggerLengthFactor: number
Sets the length scale factor of dragger handles in Studio.
- Roblox script security
Studio.DraggerMajorGridIncrement: number
Sets the major grid increment used when snapping with the dragger.
- Roblox script security
Studio.DraggerMaxSoftSnaps: number
Sets the maximum number of soft snap points shown by the dragger.
- Roblox script security
Studio.DraggerPassiveColor: Color3
Sets the color of inactive dragger handles in Studio.
- Roblox script security
Studio.DraggerScaleFactor: number
Sets the scale factor controlling the overall size of dragger handles.
- Roblox script security
Studio.DraggerShowAxisTicks: boolean
Controls whether tick marks are shown on dragger axis lines.
- Roblox script security
Studio.DraggerShowDraggedPoint: boolean
- Roblox script security
Studio.DraggerShowHoverRuler: boolean
Controls whether a ruler is shown when hovering near the dragger.
- Roblox script security
Studio.DraggerShowMeasurement: boolean
Controls whether distance measurements are shown while dragging.
- Roblox script security
Studio.DraggerShowNegativeAxes: boolean
Controls whether negative axis handles are shown on the dragger.
- Roblox script security
Studio.DraggerShowPlanes: boolean
Controls whether planar translation handles are shown on the dragger.
- Roblox script security
Studio.DraggerShowTargetSnap: boolean
Controls whether the target snap indicator is shown on the dragger.
- Roblox script security
Studio.DraggerShowTrackball: boolean
Controls whether the trackball handle is shown on the rotation dragger.
- Roblox script security
Studio.DraggerShowWhileDragging: boolean
Controls whether dragger handles remain visible while actively dragging.
- Roblox script security
Studio.DraggerSoftSnapMarginFactor: number
Sets the margin factor used to determine proximity for soft snapping.
- Roblox script security
Studio.DraggerSummonMarginFactor: number
Sets the margin factor used to summon the dragger near a surface.
- Roblox script security
Studio.DraggerTiltRotateDuration: number
Sets the duration in seconds of the tilt rotation animation in the dragger.
- Roblox script security
Studio.EnableFindOnType: boolean
Controls whether the Find bar activates when typing in the script editor.
- Roblox script security
Studio.LoadAllBuiltinPluginsInRunModes: boolean
Controls whether all built-in plugins are loaded when using run modes.
- Roblox script security
Studio.LoadInternalPlugins: boolean
Controls whether internal Roblox plugins are loaded in Studio.
- Roblox engine security
Studio.LoadUserPluginsInRunModes: boolean
Controls whether user-installed plugins are loaded when using run modes.
- Roblox script security
Studio.MaxFindReplaceAllResults: number
Sets the maximum number of results returned by the Find All operation.
- Roblox script security
Studio.VAxisColor: Color3
Sets the color of the V axis handle in Studio's draggers.
- Roblox script security
Studio.XAxisColor: Color3
Sets the color of the X axis handle in Studio's draggers.
- Roblox script security
Studio.YAxisColor: Color3
Sets the color of the Y axis handle in Studio's draggers.
- Roblox script security
Studio.ZAxisColor: Color3
Sets the color of the Z axis handle in Studio's draggers.
- Roblox script security

Property categoryDirectories

Studio.ActionOnAutoResumeSync: Enum.ActionOnAutoResumeSync
- Roblox script security
Studio.ActionOnStopSync: Enum.ActionOnStopSync
Sets the action Studio takes when stopping file sync.
- Plugin security
Studio.AutoResumeSyncOnPlaceOpen: boolean
Controls whether file sync resumes automatically when a place is opened.
- Roblox engine security
Studio.DefaultInstancesDir: QDir
Sets the default directory where Studio saves instance files.
- Roblox engine security
Studio.DefaultScriptSyncFileType: Enum.DefaultScriptSyncFileType
Sets the default file type used when syncing scripts to the file system.
- Roblox script security
Studio.ExternalEditorMode: Enum.ExternalEditorMode
Sets the mode used when opening scripts in an external editor.
- Roblox script security
Studio.ExternalEditorSelection: QDir
Sets which external editor Studio opens scripts with.
- Roblox script security
Studio.IconOverrideDir: QDir
Sets the directory Studio uses to load icon overrides.
- Roblox script security
Studio.LocalAssetsFolder: QDir
Sets the local folder Studio uses for local asset storage.
- Write: Roblox script security
Studio.PluginsDir: QDir
The directory where local plugins are stored.
- Plugin security
Studio.ReloadBuiltinPluginsOnChange: boolean
Controls whether built-in plugins are automatically reloaded when their files change.
- Roblox engine security
Studio.ReloadLocalPluginsOnChange: boolean
Controls whether local plugins are automatically reloaded when their files change.
- Roblox engine security
Studio.UseDefaultExternalEditor: boolean
Controls whether Studio uses the system's default application to open scripts externally.
- Roblox script security

Property categoryExplorer

Studio.Show Core GUI in Explorer while Playing: boolean
If set to true, the CoreGui will be visible in the Explorer while the game is running.
- Plugin security
Studio.Show FileSyncService: boolean
Controls whether FileSyncService is shown in the Explorer panel.
- Plugin security
Studio.Show Hidden Objects in Explorer: boolean
Controls whether hidden objects are visible in the Explorer panel.
- Plugin security
Studio.Show Plugin GUI Service in Explorer: boolean
When set to true, the PluginGuiService will be shown in Roblox Studio's explorer.
- Plugin security
Studio.Show plus button on hover in Explorer: boolean
Controls whether a plus button appears when hovering over items in the Explorer.
- Plugin security
Studio.ShowCorePackagesInExplorer: boolean
Controls whether core packages are shown in the Explorer panel.
- Roblox script security

Property categoryGeneral

Studio.Always Save Script Changes: boolean
If set to true, Roblox Studio will attempt to transfer script changes that were made during a Play Solo session to the opened place.
- Plugin security
Studio.Basic Objects Display Mode: Enum.ListDisplayMode
Sets the scrolling mode of the Advanced Objects tab in Roblox Studio.
- Plugin security
Studio.DisplayLanguage: string
Sets the display language used by the Studio interface.
- Roblox script security
Studio.PreferredTextSize: Enum.PreferredTextSize
Sets the preferred font size in the script editor.
- Plugin security
Studio.Theme: Instance
Used to get/set current theme used by Studio.
- Plugin security
Studio.UI Theme: Enum.UITheme
Deprecated:
Specifies the color scheme of Roblox Studio.
- Deprecated
- Hidden
- Read only
- Plugin security
- Save only

Property categoryLua Debugger

Studio.CommandBarLocalState: boolean
Controls whether the command bar retains its input state between sessions.
- Plugin security
Studio.LuaDebuggerEnabled: boolean
Specifies whether or not the Lua Debugger feature is enabled.
- Plugin security
Studio.LuaDebuggerEnabledAtStartup: boolean
Controls whether the Lua debugger is enabled when Studio starts.
- Hidden
- Read only
- Plugin security
Studio.PluginDebuggingEnabled: boolean
Controls whether plugin script debugging is enabled in Studio.
- Roblox script security
Studio.ScriptTimeoutLength: number
The time (in seconds) a script can wait to be resumed before timing out.
- Plugin security

Property categoryOutput

Studio.Clear Output On Start: boolean
If set to true, the output will be automatically cleared when game sessions are switched.
- Plugin security
Studio.Maximum Output Lines: number
The maximum number of lines that can be displayed in the output.
- Plugin security
Studio.Output Font: QFont
Specifies the font used by the output.
- Plugin security
Studio.Output Layout Mode: Enum.OutputLayoutMode
Sets the layout mode of the output.
- Plugin security

Property categoryPrimary Part

Studio.Line Thickness: number
Sets the thickness of the Model.PrimaryPart selection adornee. This value is constrained between 0 and 0.05.
- Plugin security
Studio.Select/Hover Color: Color3
- Plugin security

Property categoryScript Editor

Studio.Auto Clean Empty Line: boolean
Controls whether trailing whitespace is automatically removed from empty lines in the script editor.
- Plugin security
Studio.Auto Closing Brackets: boolean
Controls whether the script editor automatically inserts a matching closing bracket.
- Plugin security
Studio.Auto Closing Quotes: boolean
Controls whether the script editor automatically inserts a matching closing quote.
- Plugin security
Studio.Auto Delete Closing Brackets and Quotes: boolean
Controls whether deleting an opening bracket or quote also removes its closing counterpart.
- Plugin security
Studio.Auto Indent Rule: Enum.AutoIndentRule
Sets the rule used to determine automatic indentation in the script editor.
- Plugin security
Studio.AutocompleteAcceptanceBehavior: Enum.CompletionAcceptanceBehavior
Sets the key used to accept autocomplete suggestions in the script editor.
- Roblox script security
Studio.Automatically trigger AI Code Completion: boolean
Controls whether AI code completion suggestions trigger automatically while typing.
- Roblox script security
Studio.CommandBarEnterExec: boolean
Controls whether pressing Enter immediately executes the command bar input.
- Roblox script security
Studio.CommandBarFont: QFont
Sets the font used in the Studio command bar.
- Roblox script security
Studio.CommandBarHistoryLen: number
- Roblox script security
Studio.Enable Autocomplete: boolean
When set to true, the script editor and command bar will show an autocomplete menu while writing.
- Plugin security
Studio.Enable Autocomplete Doc View: boolean
Controls whether documentation is shown alongside autocomplete suggestions.
- Roblox script security
Studio.Enable Script Analysis: boolean
Controls whether the script editor performs real-time Luau script analysis.
- Roblox script security
Studio.Enable Scrollbar Markers: boolean
Controls whether error and warning markers are shown on the script editor scrollbar.
- Roblox script security
Studio.Enable Signature Help: boolean
Controls whether function signature help popups are shown while typing.
- Roblox script security
Studio.Enable Signature Help Doc View: boolean
Controls whether documentation is shown alongside signature help popups.
- Roblox script security
Studio.Enable Temporary Tabs: boolean
Controls whether opening a script creates a temporary tab that is replaced on the next open.
- Plugin security
Studio.Enable Temporary Tabs In Explorer: boolean
Controls whether clicking a script in the Explorer opens it in a temporary tab.
- Plugin security
Studio.Enable Type Hover: boolean
Controls whether hovering over an identifier shows its inferred type.
- Roblox script security
Studio.EnableCodeAssist: boolean
Controls whether AI-powered code assist features are enabled in the script editor.
- Roblox script security
Studio.EnableIndentationRulers: boolean
Controls whether indentation ruler lines are shown in the script editor.
- Roblox script security
Studio.EnableOnTypeAutocomplete: boolean
- Hidden
- Not replicated
- Roblox script security
Studio.EnableOvertypeMode: boolean
- Roblox script security
Studio.EnableSelectionTooltips: boolean
Controls whether tooltips are shown when hovering over selected objects.
- Roblox script security
Studio.Font: QFont
Specifies the font used in the script editor.
- Plugin security
Studio.Format On Paste: boolean
Controls whether pasted code is automatically formatted in the script editor.
- Plugin security
Studio.Format On Type: boolean
Controls whether code is automatically formatted as you type in the script editor.
- Plugin security
Studio.Highlight Current Line: boolean
Controls whether the current line is highlighted in the script editor.
- Plugin security
Studio.Highlight Occurances: boolean
Controls whether other occurrences of the word under the cursor are highlighted.
- Plugin security
Studio.Indent Using Spaces: boolean
Controls whether the script editor uses spaces instead of tabs for indentation.
- Plugin security
Studio.LargeFileLineCountThreshold: number
Sets the line count at which a script is treated as a large file by the script editor.
- Roblox script security
Studio.LargeFileThreshold: number
Sets the byte size at which a script is treated as a large file by the script editor.
- Roblox script security
Studio.Rulers: string
Sets the column positions at which vertical ruler lines are drawn in the script editor.
- Plugin security
Studio.ScriptEditorShouldShowPluginMethods: boolean
- Hidden
- Not replicated
- Roblox script security
Studio.Scroll Past Last Line: boolean
Controls whether the script editor allows scrolling below the last line.
- Plugin security
Studio.Show Whitespace: boolean
Controls whether whitespace characters are shown as visible glyphs in the script editor.
- Plugin security
Studio.Skip Closing Brackets and Quotes: boolean
Controls whether the cursor skips over a typed closing bracket or quote if one already exists.
- Plugin security
Studio.Tab Width: number
Specifies how many spaces are used to represent a tab in the script editor.
- Plugin security
Studio.Text Wrapping: boolean
If set to true, text in the script editor will be wrapped.
- Plugin security

Property categoryScript Editor Colors

Studio."function" Color: Color3
- Not replicated
- Plugin security
Studio."local" Color: Color3
- Not replicated
- Plugin security
Studio."nil" Color: Color3
- Not replicated
- Plugin security
Studio."self" Color: Color3
- Not replicated
- Plugin security
Studio."TODO" Color: Color3
- Not replicated
- Plugin security
Studio.Background Color: Color3
Specifies the background color of Roblox Studio's script editor.
- Not replicated
- Plugin security
Studio.Bool Color: Color3
Sets the color of boolean literals in the script editor.
- Not replicated
- Plugin security
Studio.Bracket Color: Color3
Sets the color of brackets in the script editor.
- Not replicated
- Plugin security
Studio.Built-in Function Color: Color3
Sets the color of built-in functions and keywords in the script editor.
- Not replicated
- Plugin security
Studio.Comment Color: Color3
Specifies the color of comments in Roblox Studio's script editor.
- Not replicated
- Plugin security
Studio.Current Line Highlight Color: Color3
Sets the color of the current line highlight in the script editor.
- Not replicated
- Plugin security
Studio.Debugger Current Line Color: Color3
Sets the color of the current debugger line in the script editor.
- Not replicated
- Plugin security
Studio.Debugger Error Line Color: Color3
Sets the color of debugger error lines in the script editor.
- Not replicated
- Plugin security
Studio.Doc View Code Background Color: Color3
- Hidden
- Not replicated
- Roblox script security
Studio.Error Color: Color3
Specifies the color of the wavy underline shown when malformed code is detected in the script editor.
- Not replicated
- Plugin security
Studio.Find Selection Background Color: Color3
Sets the highlight color of matches in the script editor's Find Selection operation (Ctrl+F).
- Not replicated
- Plugin security
Studio.Function Name Color: Color3
Sets the color of function names in the script editor.
- Not replicated
- Plugin security
Studio.HintColor: Color3
Sets the color of hint diagnostics in the script editor.
- Not replicated
- Plugin security
Studio.IndentationRulerColor: Color3
Sets the color of indentation rulers in the script editor.
- Not replicated
- Roblox script security
Studio.InformationColor: Color3
Sets the color of information diagnostics in the script editor.
- Not replicated
- Plugin security
Studio.Keyword Color: Color3
Sets the text color of built-in Luau keywords.
- Not replicated
- Plugin security
Studio.Luau Keyword Color: Color3
Sets the color of Luau-specific keywords in the script editor.
- Not replicated
- Plugin security
Studio.Matching Word Background Color: Color3
Sets the highlight color of double-clicked variables in the script editor.
- Not replicated
- Plugin security
Studio.Menu Item Background Color: Color3
Sets the background color of menu items in Studio.
- Not replicated
- Plugin security
Studio.Method Color: Color3
Sets the color of method names in the script editor.
- Not replicated
- Plugin security
Studio.Number Color: Color3
Specifies the color of numbers in Roblox Studio's script editor.
- Not replicated
- Plugin security
Studio.Operator Color: Color3
Sets the text color of operator characters in the script editor.
- Not replicated
- Plugin security
Studio.Primary Text Color: Color3
Sets the primary text color in Studio.
- Not replicated
- Plugin security
Studio.Property Color: Color3
Sets the color of property names in the script editor.
- Not replicated
- Plugin security
Studio.ReviewableChangeAddedTextColor: Color3
- Hidden
- Not replicated
- Roblox script security
Studio.ReviewableChangeRemovedTextColor: Color3
- Hidden
- Not replicated
- Roblox script security
Studio.Ruler Color: Color3
Sets the color of the column ruler in the script editor.
- Not replicated
- Plugin security
Studio.Script Editor Color Preset: Enum.StudioScriptEditorColorPresets
Sets the color preset applied to the script editor.
- Plugin security
Studio.Script Editor Scrollbar Background Color: Color3
Sets the background color of the script editor scrollbar in Studio.
- Not replicated
- Plugin security
Studio.Script Editor Scrollbar Handle Color: Color3
Sets the handle color of the script editor scrollbar in Studio.
- Not replicated
- Plugin security
Studio.ScriptEditorMenuBorderColor: Color3
- Hidden
- Not replicated
- Roblox script security
Studio.Secondary Text Color: Color3
Sets the secondary text color in Studio.
- Not replicated
- Plugin security
Studio.Selected Menu Item Background Color: Color3
Sets the background color of selected menu items in Studio.
- Not replicated
- Plugin security
Studio.Selected Text Color: Color3
Sets the color of selected text in Studio.
- Not replicated
- Plugin security
Studio.Selection Background Color: Color3
Sets the background color of selected text in the script editor.
- Not replicated
- Plugin security
Studio.Selection Color: Color3
Sets the text color of selected text in the script editor.
- Not replicated
- Plugin security
Studio.String Color: Color3
Specifies the color of strings in the script editor.
- Not replicated
- Plugin security
Studio.Text Color: Color3
Specifies the color of normal text in the script editor.
- Not replicated
- Plugin security
Studio.TypeColor: Color3
Sets the color of type annotations in the script editor.
- Not replicated
- Plugin security
Studio.Warning Color: Color3
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
- Plugin security
Studio.Whitespace Color: Color3
Sets the color of visible whitespace characters in the script editor.
- Not replicated
- Plugin security

Property categoryStreaming

Studio.EnableStudioStreaming: boolean
Controls whether Studio streaming mode is enabled.
- Roblox script security

Property categoryTools

Studio.Active Color: Color3
Sets the color of active UI elements in Studio.
- Plugin security
Studio.Active Hover Over Color: Color3
Sets the color of active UI elements when hovered in Studio.
- Plugin security
Studio.Animate Hover Over: boolean
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.
- Plugin security
Studio.Hover Animate Speed: Enum.HoverAnimateSpeed
Specifies how frequently the hover animation flashes when the mouse is hovering over a selectable object in the Workspace.
- Plugin security
Studio.Hover Box Thickness: number
Sets the thickness of the selection box shown when hovering over objects.
- Roblox engine security
Studio.Hover Line Thickness: number
Sets the line thickness of the hover selection box.
- Roblox engine security
Studio.Hover Over Color: Color3
Specifies the color that the hover selection box uses.
- Plugin security
Studio.Physical Draggers Select Scope By Default: boolean
Controls whether physical draggers default to selecting within the current scope.
- Roblox script security
Studio.Pivot Snap To Geometry Color: Color3
Sets the color of the pivot snap-to-geometry indicator in Studio.
- Roblox engine security
Studio.Select Color: Color3
The color of the selection box used with object selections in the Workspace.
- Plugin security
Studio.Selection Box Thickness: number
Sets the thickness of the selection box around selected objects.
- Roblox engine security
Studio.Selection Line Thickness: number
Sets the line thickness of the selection box around selected objects.
- Roblox engine security
Studio.Show Hover Over: boolean
If set to true, hovering over an object in the Workspace will show a selection box.
- Plugin security
Studio.Use Bounding Box Move Handles: boolean
Controls whether move handles are placed at the bounding box edges instead of the pivot.
- Roblox script security

Property categoryUndo

Studio.RuntimeUndoBehavior: Enum.RuntimeUndoBehavior
Sets how Studio handles undo operations during runtime playback.
- Plugin security

Property categoryUpdates

Studio.AutoUpdateEnabled: boolean
Controls whether Studio updates itself automatically when a new version is available.
- Roblox script security

Property categoryVisualization

Studio.Animation Skeleton Scale: number
- Plugin security
Studio.Animation Skeleton Transparency: number
- Plugin security
Studio.Show Animation Skeleton: boolean
- Plugin security
Studio.Show Animation Skeleton Attachments: boolean
- Plugin security
Studio.Show Animation Skeleton Axes: boolean
- Plugin security
Studio.Show Animation Skeleton Rotations: boolean
- Plugin security
Studio.Show Animation Skeleton Text: boolean
- Plugin security
Studio.Show Light Guides: boolean
Controls whether light guide visualizations are shown in the viewport.
- Roblox script security
Studio.Show Navigation Labels: boolean
Controls whether navigation mesh region labels are shown in the viewport.
- Roblox script security
Studio.Show Navigation Mesh: boolean
When set to true, the navigation mesh used by the PathfindingService will be visualized.
- Plugin security
Studio.Show Pathfinding Links: boolean
Controls whether PathfindingLink visualizations are shown in the viewport.
- Roblox script security
Studio.Show Singly Selected Attachment Parent Frame: boolean
Controls whether the parent part frame is shown when a single attachment is selected.
- Roblox script security

Methods43

Inherited fromObject3

Object:GetPropertyChangedSignal(property: string): RBXScriptSignal
Get an event that fires when a given property of the object changes.
Parameters
Parameter Description
property: string
The property to connect to.
Returns
Type Description
RBXScriptSignal
A signal that fires whenever the property changes.
Object:IsA(className: string): boolean
Returns true if an object's class matches or inherits from a given class.
- Custom Lua state
- Thread safe
Parameters
Parameter Description
className: string
The class against which the Object's class will be checked. Case-sensitive.
Returns
Type Description
boolean
Describes whether the Object's class matched or is a subclass of the given class.
Object:isA(className: string): boolean
Deprecated: This deprecated function is a variant of Object:IsA() which should be used instead.
- Deprecated
- Custom Lua state
Parameters
Parameter
className: string
Returns
Type
boolean
Use IsA instead.

Parameters
Parameter	Description
`property: string`	The property to connect to.

Returns
Type	Description
`RBXScriptSignal`	A signal that fires whenever the property changes.

Parameters
Parameter	Description
`className: string`	The class against which the Object's class will be checked. Case-sensitive.

Returns
Type	Description
`boolean`	Describes whether the Object's class matched or is a subclass of the given class.

Parameters
Parameter
`className: string`

Returns
Type
`boolean`

Inherited fromInstance39

Instance:AddTag(tag: string)
Applies a tag to the instance.
Parameters
Parameter Description
tag: string
The tag to apply to the instance.
Instance:ClearAllChildren()
This method destroys all of an instance's children.
Instance:Clone(): Instance
Create a copy of an instance and all its descendants, ignoring instances that are not Archivable.
- Capabilities: CreateInstances
- Simulation access
Returns
Type Description
Instance
A copy of the instance, or nil if the instance is not Archivable.
Instance:Destroy()
Sets the Instance.Parent property to nil, locks the Instance.Parent property, disconnects all connections, and calls Destroy() on all children.
Instance:FindFirstAncestor(name: string): Instance
Returns the first ancestor of the Instance whose Instance.Name is equal to the given name.
- Thread safe
Parameters
Parameter Description
name: string
The Instance.Name to be looked for.
Returns
Type Description
Instance
The Instance found.
Instance:FindFirstAncestorOfClass(className: string): Instance
Returns the first ancestor of the Instance whose Object.ClassName is equal to the given className.
- Thread safe
Parameters
Parameter Description
className: string
The Object.ClassName to be looked for.
Returns
Type Description
Instance
The Instance found.
Instance:FindFirstAncestorWhichIsA(className: string): Instance
Returns the first ancestor of the Instance for whom Object:IsA() returns true for the given className.
- Thread safe
Parameters
Parameter Description
className: string
The Object.ClassName to be looked for.
Returns
Type Description
Instance
The Instance found.
Instance:FindFirstChild(name: string, recursive: boolean? = false): Instance
Returns the first child of the Instance found with the given name.
- Thread safe
- Simulation access
Parameters
Parameter Description
name: string
The Instance.Name to be searched for.
recursive: boolean? = false
Whether or not the search should be conducted recursively.
Returns
Type Description
Instance
The Instance found.
Instance:FindFirstChildOfClass(className: string): Instance
Returns the first child of the Instance whose ClassName is equal to the given class name.
- Thread safe
Parameters
Parameter Description
className: string
The Object.ClassName to be looked for.
Returns
Type Description
Instance
The Instance found.
Instance:FindFirstChildWhichIsA(className: string,recursive: boolean? = false,): Instance
Returns the first child of the Instance for whom Object:IsA() returns true for the given className.
- Thread safe
- Simulation access
Parameters
Parameter Description
className: string
The Object.ClassName to be searched for.
recursive: boolean? = false
Whether or not the search should be conducted recursively.
Returns
Type Description
Instance
The Instance found.
Instance:FindFirstDescendant(name: string): Instance
Returns the first descendant found with the given Instance.Name.
- Thread safe
Parameters
Parameter Description
name: string
The Instance.Name to search for.
Returns
Type Description
Instance
The Instance found.
Instance:GetActor(): Actor
Returns the Actor associated with the Instance, if any.
- Thread safe
Returns
Type Description
Actor
The Actor found.
Instance:GetAttribute(attribute: string): any
Returns the value which has been assigned to the given attribute name.
- Thread safe
- Simulation access
Parameters
Parameter Description
attribute: string
The name of the attribute being retrieved.
Returns
Type Description
any
The value which has been assigned to the given attribute name. If no attribute has been assigned, nil is returned.
Instance:GetAttributeChangedSignal(attribute: string): RBXScriptSignal
Returns an event that fires when the given attribute changes.
Parameters
Parameter Description
attribute: string
The name of the specified attribute for which the change signal is being returned.
Returns
Type Description
RBXScriptSignal
An event that fires when the given attribute changes.
Instance:GetAttributes(): { [string]: any }
Returns a dictionary of the instance's attributes.
- Custom Lua state
- Thread safe
- Simulation access
Returns
Type Description
{ [string]: any }
A dictionary of string → variant pairs for each attribute where the string is the name of the attribute and the variant is a non-nil value.
Instance:GetChildren(): { Instance }
Returns an array containing all of the instance's children.
- Thread safe
- Simulation access
Returns
Type Description
{ Instance }
An array containing the instance's children.
Instance:GetDebugId(scopeLength: number? = 4): string
Returns a coded string of the debug ID used internally by Roblox.
- Not browsable
- Plugin security
Parameters
Parameter Description
scopeLength: number? = 4
The scope length.
Returns
Type Description
string
The Debug ID string.
Instance:GetDescendants(): { Instance }
Returns an array containing all of the descendants of the instance.
- Custom Lua state
- Thread safe
- Simulation access
Returns
Type Description
{ Instance }
An array containing the instance's descendants.
Instance:GetFullName(): string
Returns a string describing the instance's ancestry.
- Thread safe
- Simulation access
Returns
Type Description
string
The full name of the Instance.
Instance:GetStyled(name: string, selector: string?): any
Returns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified.
Parameters
Parameter Description
name: string
Name of the property to query.
selector: string?
Optional selector for the pseudo instance you are targeting on the instance.
Returns
Type Description
any
The styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified.
Instance:GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
Returns an event that fires when the given style property changes on the instance.
Parameters
Parameter Description
property: string
Name of the style property for which to listen for changes.
Returns
Type Description
RBXScriptSignal
Event that fires when the given style property changes.
Instance:GetTags(): { any }
Gets an array of all tags applied to the instance.
- Thread safe
- Simulation access
Returns
Type Description
{ any }
An array of strings, each representing a tag applied to the instance.
Instance:HasTag(tag: string): boolean
Check whether the instance has a given tag.
- Thread safe
- Simulation access
Parameters
Parameter Description
tag: string
The tag to check for on the instance.
Returns
Type Description
boolean
true if the instance has the given tag, false otherwise.
Instance:IsAncestorOf(descendant: Instance): boolean
Returns true if an Instance is an ancestor of the given descendant.
- Thread safe
- Simulation access
Parameters
Parameter Description
descendant: Instance
The descendant Instance.
Returns
Type Description
boolean
True if the Instance is an ancestor of the given descendant.
Instance:IsDescendantOf(ancestor: Instance): boolean
Returns true if an Instance is a descendant of the given ancestor.
- Thread safe
- Simulation access
Parameters
Parameter Description
ancestor: Instance
The ancestor Instance.
Returns
Type Description
boolean
True if the Instance is a descendant of the given ancestor.
Instance:IsPropertyModified(property: string): boolean
Returns true if the value stored in the specified property is not equal to the code-instantiated default.
- Simulation access
Parameters
Parameter Description
property: string
Name of the property to query.
Returns
Type Description
boolean
Boolean indicating whether the property is modified from its code‑instantiated default.
Instance:QueryDescendants(selector: string): { Instance }
Returns an array containing all descendants of the instance that match the selector string.
- Custom Lua state
- Simulation access
Parameters
Parameter Description
selector: string
Selector string used to filter elements.
Returns
Type Description
{ Instance }
An array of instances (empty if nothing matched the selector).
Instance:RemoveTag(tag: string)
Removes a tag from the instance.
Parameters
Parameter Description
tag: string
The tag to remove from the instance.
Instance:ResetPropertyToDefault(property: string)
Resets a property to its default value.
Parameters
Parameter Description
property: string
Name of the property to reset.
Instance:SetAttribute(attribute: string, value: any)
Sets the attribute with the given name to the given value.
- Simulation access
Parameters
Parameter Description
attribute: string
The name of the attribute being set.
value: any
The value to set the specified attribute to.
Instance:WaitForChild(childName: string, timeOut: number): Instance
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.
- Can yield
- Custom Lua state
Parameters
Parameter Description
childName: string
The Instance.Name to be looked for.
timeOut: number
An optional time out parameter.
Returns
Type Description
Instance
The Instance found.
Instance:Remove()
Deprecated: This item is deprecated in favor of Instance:Destroy() and Instance:ClearAllChildren(). If you must remove an object from the game, and wish to use the object later, set its Parent property to nil instead of using this method.
Sets the object's Parent to nil, and does the same for all its descendants.
- Deprecated
Instance:children(): { Instance }
Deprecated: This item has been superseded by Instance:GetChildren() which should be used in all new work.
Returns an array of the object's children.
- Deprecated
Returns
Type Description
{ Instance }
Array of child objects/instances.
Use GetChildren instead.
Instance:clone(): Instance
Deprecated: This deprecated function is a variant of Instance:Clone() which should be used instead.
- Deprecated
- Capabilities: CreateInstances
- Simulation access
Returns
Type
Instance
Use Clone instead.
Instance:destroy()
Deprecated: This deprecated function is a variant of Instance:Destroy() which should be used instead.
- Deprecated
Use Destroy instead.
Instance:findFirstChild(name: string, recursive: boolean? = false): Instance
Deprecated: This deprecated function is a variant of Instance:FindFirstChild() which should be used instead.
- Deprecated
- Simulation access
Parameters
Parameter
name: string
recursive: boolean? = false
Returns
Type
Instance
Use FindFirstChild instead.
Instance:getChildren(): { Instance }
Deprecated: This deprecated function is a variant of Instance:GetChildren() which should be used instead.
- Deprecated
Returns
Type
{ Instance }
Use GetChildren instead.
Instance:isDescendantOf(ancestor: Instance): boolean
Deprecated: This deprecated function is a variant of Instance:IsDescendantOf() which should be used instead.
- Deprecated
- Simulation access
Parameters
Parameter
ancestor: Instance
Returns
Type
boolean
Use IsDescendantOf instead.
Instance:remove()
Deprecated: This deprecated function is a variant of Instance:Remove() which has also been deprecated. Neither function should be used in new work.
- Deprecated
Use Remove instead.

Parameters
Parameter	Description
`tag: string`	The tag to apply to the instance.

Returns
Type	Description
`Instance`	A copy of the instance, or `nil` if the instance is not `Archivable`.

Parameters
Parameter	Description
`name: string`	The `Instance.Name` to be looked for.

Returns
Type	Description
`Instance`	The `Instance` found.

Parameters
Parameter	Description
`className: string`	The `Object.ClassName` to be looked for.

Returns
Type	Description
`Instance`	The `Instance` found.

Parameters
Parameter	Description
`className: string`	The `Object.ClassName` to be looked for.

Returns
Type	Description
`Instance`	The `Instance` found.

Parameters
Parameter	Description
`name: string`	The `Instance.Name` to be searched for.
`recursive: boolean? = false`	Whether or not the search should be conducted recursively.

Returns
Type	Description
`Instance`	The `Instance` found.

Parameters
Parameter	Description
`className: string`	The `Object.ClassName` to be looked for.

Returns
Type	Description
`Instance`	The `Instance` found.

Parameters
Parameter	Description
`className: string`	The `Object.ClassName` to be searched for.
`recursive: boolean? = false`	Whether or not the search should be conducted recursively.

Returns
Type	Description
`Instance`	The `Instance` found.

Parameters
Parameter	Description
`name: string`	The `Instance.Name` to search for.

Returns
Type	Description
`Instance`	The `Instance` found.

Returns
Type	Description
`Actor`	The `Actor` found.

Parameters
Parameter	Description
`attribute: string`	The name of the attribute being retrieved.

Returns
Type	Description
`any`	The value which has been assigned to the given attribute name. If no attribute has been assigned, `nil` is returned.

Parameters
Parameter	Description
`attribute: string`	The name of the specified attribute for which the change signal is being returned.

Returns
Type	Description
`RBXScriptSignal`	An event that fires when the given attribute changes.

Returns
Type	Description
`{ [string]: any }`	A dictionary of string → variant pairs for each attribute where the string is the name of the attribute and the variant is a non-nil value.

Returns
Type	Description
`{ Instance }`	An array containing the instance's children.

Parameters
Parameter	Description
`scopeLength: number? = 4`	The scope length.

Returns
Type	Description
`string`	The Debug ID string.

Returns
Type	Description
`{ Instance }`	An array containing the instance's descendants.

Returns
Type	Description
`string`	The full name of the `Instance`.

Parameters
Parameter	Description
`name: string`	Name of the property to query.
`selector: string?`	Optional selector for the pseudo instance you are targeting on the instance.

Returns
Type	Description
`any`	The styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified.

Parameters
Parameter	Description
`property: string`	Name of the style property for which to listen for changes.

Returns
Type	Description
`RBXScriptSignal`	Event that fires when the given style property changes.

Returns
Type	Description
`{ any }`	An array of strings, each representing a tag applied to the instance.

Parameters
Parameter	Description
`tag: string`	The tag to check for on the instance.

Returns
Type	Description
`boolean`	`true` if the instance has the given tag, `false` otherwise.

Parameters
Parameter	Description
`descendant: Instance`	The descendant `Instance`.

Returns
Type	Description
`boolean`	True if the `Instance` is an ancestor of the given descendant.

Parameters
Parameter	Description
`ancestor: Instance`	The ancestor `Instance`.

Returns
Type	Description
`boolean`	True if the `Instance` is a descendant of the given ancestor.

Parameters
Parameter	Description
`property: string`	Name of the property to query.

Returns
Type	Description
`boolean`	Boolean indicating whether the property is modified from its code‑instantiated default.

Parameters
Parameter	Description
`selector: string`	Selector string used to filter elements.

Returns
Type	Description
`{ Instance }`	An array of instances (empty if nothing matched the selector).

Parameters
Parameter	Description
`tag: string`	The tag to remove from the instance.

Parameters
Parameter	Description
`property: string`	Name of the property to reset.

Defined byStudio1

Studio:GetAvailableThemes(): { any }
Returns a list of themes available in Studio.
- Plugin security
Returns
Type Description
{ any }
A list of themes available in Studio.

Events11

Inherited fromObject1

Object.Changed: RBXScriptSignal<(property: string)>
Fires immediately after a property of the object changes, with some limitations.
Parameters
Parameter
property: string

Inherited fromInstance9

Instance.AncestryChanged: RBXScriptSignal<(child: Instance, parent: Instance)>
Fires when the Instance.Parent property of this object or one of its ancestors is changed.
Parameters
Parameter
child: Instance
parent: Instance
Instance.AttributeChanged: RBXScriptSignal<(attribute: string)>
Fires whenever an attribute is changed on the Instance.
Parameters
Parameter
attribute: string
Instance.ChildAdded: RBXScriptSignal<(child: Instance)>
Fires after an object is parented to this Instance.
Parameters
Parameter
child: Instance
Instance.ChildRemoved: RBXScriptSignal<(child: Instance)>
Fires after a child is removed from this Instance.
Parameters
Parameter
child: Instance
Instance.DescendantAdded: RBXScriptSignal<(descendant: Instance)>
Fires after a descendant is added to the Instance.
Parameters
Parameter
descendant: Instance
Instance.DescendantRemoving: RBXScriptSignal<(descendant: Instance)>
Fires immediately before a descendant of the Instance is removed.
Parameters
Parameter
descendant: Instance
Instance.Destroying: RBXScriptSignal<()>
Fires immediately before (or is deferred until after) the instance is destroyed via Instance:Destroy().
Instance.StyledPropertiesChanged: RBXScriptSignal<()>
Fires whenever any style property is changed on the instance, including when a property is set to nil.
Instance.childAdded: RBXScriptSignal<(child: Instance)>
Deprecated: This deprecated event is a variant of Instance.ChildAdded which should be used instead.
- Deprecated
Parameters
Parameter
child: Instance
Use ChildAdded instead.

Defined byStudio1

Studio.ThemeChanged: RBXScriptSignal<()>
Event called when Studio's theme changes.
- Plugin security

Parameter	Description
`attribute: string`	The name of the attribute being set.
`value: any`	The value to set the specified attribute to.

Parameter	Description
`childName: string`	The `Instance.Name` to be looked for.
`timeOut: number`	An optional time out parameter.