Reference API Roblox

Engine API

Website

Related

Reference API Roblox

Studio

This class is not replicated. Its interface does not cross the network boundary.
This class is not creatable. Instances of this class cannot be created with Instance.new.
This class is a service. It is a singleton that may be acquired with GetService.
Tags: [NotCreatable, Service, NotReplicated]

Member index 205

HistoryMember
725"TODO" Color: Color3
725"function" Color: Color3
725"local" Color: Color3
725"nil" Color: Color3
725"self" Color: Color3
668ActionOnAutoResumeSync: ActionOnAutoResumeSync
725ActionOnStopSync: ActionOnStopSync
725Active Color: Color3
725Active Hover Over Color: Color3
725Always Save Script Changes: bool
725Animate Hover Over: bool
726Animation Skeleton Scale: float
726Animation Skeleton Transparency: float
725Auto Clean Empty Line: bool
725Auto Closing Brackets: bool
725Auto Closing Quotes: bool
725Auto Delete Closing Brackets and Quotes: bool
725Auto Indent Rule: AutoIndentRule
725Auto-Recovery Enabled: bool
725Auto-Recovery Interval (Minutes): int
659AutoResumeSyncOnPlaceOpen: bool
689AutoUpdateEnabled: bool
656AutocompleteAcceptanceBehavior: CompletionAcceptanceBehavior
653Automatically trigger AI Code Completion: bool
725Background Color: Color3
725Basic Objects Display Mode: ListDisplayMode
725Bool Color: Color3
725Bracket Color: Color3
725Built-in Function Color: Color3
725Camera Mouse Wheel Speed: float
653Camera Pan Speed: float
725Camera Shift Speed: float
725Camera Speed: float
721Camera Speed Adjust Binding: CameraSpeedAdjustBinding
725Camera Zoom to Mouse Position: bool
724CameraAltLeftMouseToRotate: bool
734CameraKeyMoveSmoothing: bool
721CameraMouseMultiplier: float
709CameraNavigationModel: CameraNavigationModel
734CameraRotateShiftFactor: float
670CameraShiftFactor: float
653CameraTweenFocus: bool
728CameraZoomToMousePosition: bool
725Clear Output On Start: bool
707CommandBarEnterExec: bool
705CommandBarFont: QFont
725CommandBarHistoryLen: int
725CommandBarLocalState: bool
725Comment Color: Color3
725Current Line Highlight Color: Color3
725Debugger Current Line Color: Color3
725Debugger Error Line Color: Color3
695DefaultInstancesDir: QDir
697DefaultScriptSyncFileType: DefaultScriptSyncFileType
725DeprecatedObjectsShown: bool
653DisplayLanguage: string
653DraggerActiveColor: Color3
705DraggerLengthFactor: float
653DraggerMajorGridIncrement: int
653DraggerMaxSoftSnaps: int
653DraggerPassiveColor: Color3
705DraggerScaleFactor: float
705DraggerShowAxisTicks: bool
732DraggerShowDraggedPoint: bool
653DraggerShowHoverRuler: bool
653DraggerShowMeasurement: bool
705DraggerShowNegativeAxes: bool
705DraggerShowPlanes: bool
653DraggerShowTargetSnap: bool
705DraggerShowTrackball: bool
705DraggerShowWhileDragging: bool
653DraggerSoftSnapMarginFactor: float
653DraggerSummonMarginFactor: float
653DraggerTiltRotateDuration: float
725Enable Autocomplete: bool
653Enable Autocomplete Doc View: bool
729Enable Client/Server MDI: bool
725Enable CoreScript Debugger: bool
725Enable Http Sandboxing: bool
725Enable Internal Beta Features: bool
725Enable Internal Features: bool
653Enable Script Analysis: bool
653Enable Scrollbar Markers: bool
653Enable Signature Help: bool
653Enable Signature Help Doc View: bool
725Enable Temporary Tabs: bool
725Enable Temporary Tabs In Explorer: bool
653Enable Type Hover: bool
653EnableCodeAssist: bool
698EnableFindOnType: bool
653EnableIndentationRulers: bool
730EnableOvertypeMode: bool
669EnableSelectionTooltips: bool
687EnableStudioStreaming: bool
725Error Color: Color3
712ExternalEditorMode: ExternalEditorMode
708ExternalEditorSelection: QDir
725Find Selection Background Color: Color3
725Font: QFont
725Format On Paste: bool
725Format On Type: bool
725Function Name Color: Color3
725Highlight Current Line: bool
725Highlight Occurances: bool
725HintColor: Color3
725Hover Animate Speed: HoverAnimateSpeed
653Hover Box Thickness: float
653Hover Line Thickness: int
725Hover Over Color: Color3
653IconOverrideDir: QDir
725Indent Using Spaces: bool
653IndentationRulerColor: Color3
725InformationColor: Color3
725Keyword Color: Color3
653LargeFileLineCountThreshold: int
653LargeFileThreshold: int
725Line Thickness: float
653LoadAllBuiltinPluginsInRunModes: bool
684LoadInternalPlugins: bool
653LoadUserPluginsInRunModes: bool
653LocalAssetsFolder: QDir
725LuaDebuggerEnabled: bool
725Luau Keyword Color: Color3
653Main Volume: float
725Matching Word Background Color: Color3
691MaxFindReplaceAllResults: int
725Maximum Output Lines: int
725Menu Item Background Color: Color3
725Method Color: Color3
725Number Color: Color3
725Only Play Audio from Window in Focus: bool
725Operator Color: Color3
725Output Font: QFont
725Output Layout Mode: OutputLayoutMode
725PermissionLevelShown: PermissionLevelShown
653Physical Draggers Select Scope By Default: bool
653Pivot Snap To Geometry Color: Color3
725PluginDebuggingEnabled: bool
725PluginsDir: QDir
725PreferredTextSize: PreferredTextSize
725Primary Text Color: Color3
725Property Color: Color3
653ReloadBuiltinPluginsOnChange: bool
653ReloadLocalPluginsOnChange: bool
725Respect Studio shortcuts when game has focus: bool
725Ruler Color: Color3
725Rulers: string
725RuntimeUndoBehavior: RuntimeUndoBehavior
725Script Editor Color Preset: StudioScriptEditorColorPresets
725Script Editor Scrollbar Background Color: Color3
725Script Editor Scrollbar Handle Color: Color3
725ScriptTimeoutLength: int
725Scroll Past Last Line: bool
725Secondary Text Color: Color3
725Select Color: Color3
725Select/Hover Color: Color3
725Selected Menu Item Background Color: Color3
725Selected Text Color: Color3
725Selection Background Color: Color3
653Selection Box Thickness: float
725Selection Color: Color3
653Selection Line Thickness: int
725Set Pivot of Imported Parts: bool
726Show Animation Skeleton: bool
726Show Animation Skeleton Attachments: bool
726Show Animation Skeleton Axes: bool
726Show Animation Skeleton Rotations: bool
726Show Animation Skeleton Text: bool
725Show Core GUI in Explorer while Playing: bool
725Show Diagnostics Bar: bool
725Show FileSyncService: bool
725Show Hidden Objects in Explorer: bool
725Show Hover Over: bool
653Show Light Guides: bool
653Show Navigation Labels: bool
725Show Navigation Mesh: bool
653Show Pathfinding Links: bool
725Show Plugin GUI Service in Explorer: bool
653Show Singly Selected Attachment Parent Frame: bool
725Show Whitespace: bool
725Show plus button on hover in Explorer: bool
653ShowCorePackagesInExplorer: bool
725Skip Closing Brackets and Quotes: bool
725String Color: Color3
725Tab Width: int
725Text Color: Color3
725Text Wrapping: bool
725Theme: Instance
725TypeColor: Color3
653Use Bounding Box Move Handles: bool
708UseDefaultExternalEditor: bool
718VAxisColor: Color3
725Warning Color: Color3
725Whitespace Color: Color3
718XAxisColor: Color3
718YAxisColor: Color3
718ZAxisColor: Color3
462GetAvailableThemes(): Array
462ThemeChanged()
inherited from Instance
553Archivable: bool
670Capabilities: SecurityCapabilities
723IsInSandbox: bool
553Name: string
553Parent: Instance
702PredictionMode: PredictionMode
670Sandboxed: bool
680UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
707GetDescendants(): Instances
486GetFullName(): string
706GetStyled(name: string, selector: string?): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
698QueryDescendants(selector: string): Instances
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

Removed member index 46

HistoryMember
454"export" Color: Color3
454"type" Color: Color3
387Attach Debugger To: DEPRECATED_DebuggerDataModelPreference
443Auto Indent: bool
637Auto-Recovery Path: QDir
383Auto-Save Enabled: bool
383Auto-Save Interval (Minutes): int
383Auto-Save Path: QDir
616Automatically commit locked scripts when you save or publish to Roblox: bool
735CameraAdaptiveSpeed: bool
735CameraOrbitSensitivity: float
735CameraPanSensitivity: float
712CameraSpeedLockDefault: bool
735CameraZoomSpeed: float
492DEPRECATED_DisableAccuratePlaySolo: bool
366Debug Client In APS Mode: bool
671DefaultScriptFileDir: QDir
443Device Pairing Code: int
489Disable Accurate Play Solo: bool
577Display Team Create toggle when creating a new experience: bool
583Drag Multiple Parts As Single Part: bool
458Enable Intellisense: bool
488Enable Linting: bool
577File > New creates a place with Team Create off: bool
685FreeCameraSpeedScroll: bool
383Import mesh files as single mesh: bool
468Language: LanguagePreference
454Maximum Table Depth: int
526OverrideCoreScripts: bool
526OverrideCoreScriptsDir: QDir
454Preprocessor Color: Color3
419RecentSavesDir: QDir
592Render Throttle Percentage: int
583Search Content For Core Scripts: bool
583Selection Highlight Thickness: float
626Server Audio Behavior: ServerAudioBehavior
483Show CorePackages: bool
570Show Deployment Warnings: bool
526Show Navigation Areas: bool
587Show QT warnings in output: bool
412Show Roblox Plugin GUI Service in Explorer: bool
368Split Meshes: bool
691StudioStreamingMaxRadius: int
691StudioStreamingMinRadius: int
359Use Accurate Play Solo: bool
358FindTheme(themeName: string): Instance

Description

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.

History 1147

Members 205

"TODO" Color

TypeDefault
Color3

Sets the color of TODO comments in the script editor. This must be set in Studio Settings > Studio tab.

This property is not replicated. Its interface does not cross the network boundary.

History 8

Tags: [NotReplicated]

"function" Color

TypeDefault
Color3

Sets the color of the function keyword in the script editor. This must be set in Studio Settings > Studio tab.

This property is not replicated. Its interface does not cross the network boundary.

History 8

Tags: [NotReplicated]

"local" Color

TypeDefault
Color3

Sets the color of the local keyword in the script editor. This must be set in Studio Settings > Studio tab.

This property is not replicated. Its interface does not cross the network boundary.

History 8

Tags: [NotReplicated]

"nil" Color

TypeDefault
Color3

Sets the color of the nil keyword in the script editor. This must be set in Studio Settings > Studio tab.

This property is not replicated. Its interface does not cross the network boundary.

History 8

Tags: [NotReplicated]

"self" Color

TypeDefault
Color3

Sets the color of the self keyword in the script editor. This must be set in Studio Settings > Studio tab.

This property is not replicated. Its interface does not cross the network boundary.

History 8

Tags: [NotReplicated]

ActionOnAutoResumeSync

TypeDefault
ActionOnAutoResumeSync

Sets the action Studio takes when auto-resuming file sync. This must be set in Studio Settings > Studio tab.

History 1

ActionOnStopSync

TypeDefault
ActionOnStopSync

Sets the action Studio takes when stopping file sync. This must be set in Studio Settings > Studio tab.

History 4

Active Color

TypeDefault
Color3

Sets the color of active UI elements in Studio. This must be set in Studio Settings > Studio tab.

History 7

Active Hover Over Color

TypeDefault
Color3

Sets the color of active UI elements when hovered in Studio. This must be set in Studio Settings > Studio tab.

History 7

Always Save Script Changes

TypeDefault
bool

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

History 7

Animate Hover Over

TypeDefault
bool

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.

History 7

Animation Skeleton Scale

TypeDefault
float

History 1

Animation Skeleton Transparency

TypeDefault
float

History 1

Auto Clean Empty Line

TypeDefault
bool

Controls whether trailing whitespace is automatically removed from empty lines in the script editor. This must be set in Studio Settings > Studio tab.

History 7

Auto Closing Brackets

TypeDefault
bool

Controls whether the script editor automatically inserts a matching closing bracket. This must be set in Studio Settings > Studio tab.

History 7

Auto Closing Quotes

TypeDefault
bool

Controls whether the script editor automatically inserts a matching closing quote. This must be set in Studio Settings > Studio tab.

History 7

Auto Delete Closing Brackets and Quotes

TypeDefault
bool

Controls whether deleting an opening bracket or quote also removes its closing counterpart. This must be set in Studio Settings > Studio tab.

History 4

Auto Indent Rule

TypeDefault
AutoIndentRule

Sets the rule used to determine automatic indentation in the script editor. This must be set in Studio Settings > Studio tab.

History 7

Auto-Recovery Enabled

TypeDefault
bool

Controls whether Studio automatically saves recovery files at a set interval. This must be set in Studio Settings > Studio tab.

History 7

Auto-Recovery Interval (Minutes)

TypeDefault
int

Sets the interval in minutes at which Studio saves auto-recovery files. This must be set in Studio Settings > Studio tab.

History 7

AutoResumeSyncOnPlaceOpen

TypeDefault
bool

Controls whether file sync resumes automatically when a place is opened. This must be set in Studio Settings > Studio tab.

History 1

AutoUpdateEnabled

TypeDefault
bool

Controls whether Studio updates itself automatically when a new version is available. This must be set in Studio Settings > Studio tab.

History 1

AutocompleteAcceptanceBehavior

TypeDefault
CompletionAcceptanceBehavior

Sets the key used to accept autocomplete suggestions in the script editor. This must be set in Studio Settings > Studio tab.

History 1

Automatically trigger AI Code Completion

TypeDefault
bool

Controls whether AI code completion suggestions trigger automatically while typing. This must be set in Studio Settings > Studio tab.

History 2

Background Color

TypeDefault
Color3

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

This property is not replicated. Its interface does not cross the network boundary.

History 10

Tags: [NotReplicated]

Basic Objects Display Mode

TypeDefault
ListDisplayMode

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

History 7

Bool Color

TypeDefault
Color3

Sets the color of boolean literals in the script editor. This must be set in Studio Settings > Studio tab.

This property is not replicated. Its interface does not cross the network boundary.

History 8

Tags: [NotReplicated]

Bracket Color

TypeDefault
Color3

Sets the color of brackets in the script editor. This must be set in Studio Settings > Studio tab.

This property is not replicated. Its interface does not cross the network boundary.

History 7

Tags: [NotReplicated]

Built-in Function Color

TypeDefault
Color3

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

This property is not replicated. Its interface does not cross the network boundary.

History 10

Tags: [NotReplicated]

Camera Mouse Wheel Speed

TypeDefault
float

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

History 7

Camera Pan Speed

TypeDefault
float

Sets the speed of camera panning in Studio. This must be set in Studio Settings > Studio tab.

History 3

Camera Shift Speed

TypeDefault
float

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

History 7

Camera Speed

TypeDefault
float

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

History 7

Camera Speed Adjust Binding

TypeDefault
CameraSpeedAdjustBinding

Sets the mouse button used to adjust the camera speed in Studio. This must be set in Studio Settings > Studio tab.

History 4

Camera Zoom to Mouse Position

TypeDefault
bool

Controls whether the camera zooms toward the mouse cursor position. This must be set in Studio Settings > Studio tab.

History 7

CameraAltLeftMouseToRotate

TypeDefault
bool

History 1

CameraKeyMoveSmoothing

TypeDefault
bool

History 1

CameraMouseMultiplier

TypeDefault
float

History 1

CameraNavigationModel

TypeDefault
CameraNavigationModel

Sets the navigation model used for camera movement in Studio. This must be set in Studio Settings > Studio tab.

History 1

CameraRotateShiftFactor

TypeDefault
float

History 1

CameraShiftFactor

TypeDefault
float

Sets the speed multiplier applied to camera movement when Shift is held. This must be set in Studio Settings > Studio tab.

History 1

CameraTweenFocus

TypeDefault
bool

Controls whether the camera smoothly tweens when refocusing on a selected object. This must be set in Studio Settings > Studio tab.

History 2

CameraZoomToMousePosition

TypeDefault
bool

History 1

Clear Output On Start

TypeDefault
bool

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

History 7

CommandBarEnterExec

TypeDefault
bool

Controls whether pressing Enter immediately executes the command bar input. This must be set in Studio Settings > Studio tab.

History 1

CommandBarFont

TypeDefault
QFont

Sets the font used in the Studio command bar. This must be set in Studio Settings > Studio tab.

History 1

CommandBarHistoryLen

TypeDefault
int

History 1

CommandBarLocalState

TypeDefault
bool

Controls whether the command bar retains its input state between sessions. This must be set in Studio Settings > Studio tab.

History 7

Comment Color

TypeDefault
Color3

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

This property is not replicated. Its interface does not cross the network boundary.

History 10

Tags: [NotReplicated]

Current Line Highlight Color

TypeDefault
Color3

Sets the color of the current line highlight in the script editor. This must be set in Studio Settings > Studio tab.

This property is not replicated. Its interface does not cross the network boundary.

History 10

Tags: [NotReplicated]

Debugger Current Line Color

TypeDefault
Color3

Sets the color of the current debugger line in the script editor. This must be set in Studio Settings > Studio tab.

This property is not replicated. Its interface does not cross the network boundary.

History 12

Tags: [NotReplicated]

Debugger Error Line Color

TypeDefault
Color3

Sets the color of debugger error lines in the script editor. This must be set in Studio Settings > Studio tab.

This property is not replicated. Its interface does not cross the network boundary.

History 12

Tags: [NotReplicated]

DefaultInstancesDir

TypeDefault
QDir

Sets the default directory where Studio saves instance files. This must be set in Studio Settings > Studio tab.

History 1

DefaultScriptSyncFileType

TypeDefault
DefaultScriptSyncFileType

Sets the default file type used when syncing scripts to the file system. This must be set in Studio Settings > Studio tab.

History 1

DeprecatedObjectsShown

TypeDefault
bool

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

History 7

DisplayLanguage

TypeDefault
string

Sets the display language used by the Studio interface. This must be set in Studio Settings > Studio tab.

History 4

DraggerActiveColor

TypeDefault
Color3

Sets the color of the active dragger handle in Studio. This must be set in Studio Settings > Studio tab.

History 2

DraggerLengthFactor

TypeDefault
float

Sets the length scale factor of dragger handles in Studio. This must be set in Studio Settings > Studio tab.

History 1

DraggerMajorGridIncrement

TypeDefault
int

Sets the major grid increment used when snapping with the dragger. This must be set in Studio Settings > Studio tab.

History 2

DraggerMaxSoftSnaps

TypeDefault
int

Sets the maximum number of soft snap points shown by the dragger. This must be set in Studio Settings > Studio tab.

History 2

DraggerPassiveColor

TypeDefault
Color3

Sets the color of inactive dragger handles in Studio. This must be set in Studio Settings > Studio tab.

History 2

DraggerScaleFactor

TypeDefault
float

Sets the scale factor controlling the overall size of dragger handles. This must be set in Studio Settings > Studio tab.

History 1

DraggerShowAxisTicks

TypeDefault
bool

Controls whether tick marks are shown on dragger axis lines. This must be set in Studio Settings > Studio tab.

History 1

DraggerShowDraggedPoint

TypeDefault
bool

History 1

DraggerShowHoverRuler

TypeDefault
bool

Controls whether a ruler is shown when hovering near the dragger. This must be set in Studio Settings > Studio tab.

History 2

DraggerShowMeasurement

TypeDefault
bool

Controls whether distance measurements are shown while dragging. This must be set in Studio Settings > Studio tab.

History 2

DraggerShowNegativeAxes

TypeDefault
bool

Controls whether negative axis handles are shown on the dragger. This must be set in Studio Settings > Studio tab.

History 1

DraggerShowPlanes

TypeDefault
bool

Controls whether planar translation handles are shown on the dragger. This must be set in Studio Settings > Studio tab.

History 1

DraggerShowTargetSnap

TypeDefault
bool

Controls whether the target snap indicator is shown on the dragger. This must be set in Studio Settings > Studio tab.

History 2

DraggerShowTrackball

TypeDefault
bool

Controls whether the trackball handle is shown on the rotation dragger. This must be set in Studio Settings > Studio tab.

History 1

DraggerShowWhileDragging

TypeDefault
bool

Controls whether dragger handles remain visible while actively dragging. This must be set in Studio Settings > Studio tab.

History 1

DraggerSoftSnapMarginFactor

TypeDefault
float

Sets the margin factor used to determine proximity for soft snapping. This must be set in Studio Settings > Studio tab.

History 2

DraggerSummonMarginFactor

TypeDefault
float

Sets the margin factor used to summon the dragger near a surface. This must be set in Studio Settings > Studio tab.

History 2

DraggerTiltRotateDuration

TypeDefault
float

Sets the duration in seconds of the tilt rotation animation in the dragger. This must be set in Studio Settings > Studio tab.

History 2

Enable Autocomplete

TypeDefault
bool

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

History 8

Enable Autocomplete Doc View

TypeDefault
bool

Controls whether documentation is shown alongside autocomplete suggestions. This must be set in Studio Settings > Studio tab.

History 3

Enable Client/Server MDI

TypeDefault
bool

History 1

Enable CoreScript Debugger

TypeDefault
bool

Controls whether the CoreScript debugger is available in Studio. This must be set in Studio Settings > Studio tab.

History 7

Enable Http Sandboxing

TypeDefault
bool

Controls whether HTTP requests from plugins are sandboxed. This must be set in Studio Settings > Studio tab.

History 7

Enable Internal Beta Features

TypeDefault
bool

Controls whether internal beta features are accessible in Studio. This must be set in Studio Settings > Studio tab.

History 7

Enable Internal Features

TypeDefault
bool

Controls whether internal developer features are accessible in Studio. This must be set in Studio Settings > Studio tab.

History 7

Enable Script Analysis

TypeDefault
bool

Controls whether the script editor performs real-time Luau script analysis. This must be set in Studio Settings > Studio tab.

History 3

Enable Scrollbar Markers

TypeDefault
bool

Controls whether error and warning markers are shown on the script editor scrollbar. This must be set in Studio Settings > Studio tab.

History 3

Enable Signature Help

TypeDefault
bool

Controls whether function signature help popups are shown while typing. This must be set in Studio Settings > Studio tab.

History 4

Enable Signature Help Doc View

TypeDefault
bool

Controls whether documentation is shown alongside signature help popups. This must be set in Studio Settings > Studio tab.

History 3

Enable Temporary Tabs

TypeDefault
bool

Controls whether opening a script creates a temporary tab that is replaced on the next open. This must be set in Studio Settings > Studio tab.

History 7

Enable Temporary Tabs In Explorer

TypeDefault
bool

Controls whether clicking a script in the Explorer opens it in a temporary tab. This must be set in Studio Settings > Studio tab.

History 9

Enable Type Hover

TypeDefault
bool

Controls whether hovering over an identifier shows its inferred type. This must be set in Studio Settings > Studio tab.

History 4

EnableCodeAssist

TypeDefault
bool

Controls whether AI-powered code assist features are enabled in the script editor. This must be set in Studio Settings > Studio tab.

History 2

EnableFindOnType

TypeDefault
bool

Controls whether the Find bar activates when typing in the script editor. This must be set in Studio Settings > Studio tab.

History 1

EnableIndentationRulers

TypeDefault
bool

Controls whether indentation ruler lines are shown in the script editor. This must be set in Studio Settings > Studio tab.

History 2

EnableOvertypeMode

TypeDefault
bool

History 1

EnableSelectionTooltips

TypeDefault
bool

Controls whether tooltips are shown when hovering over selected objects. This must be set in Studio Settings > Studio tab.

History 1

EnableStudioStreaming

TypeDefault
bool

Controls whether Studio streaming mode is enabled. This must be set in Studio Settings > Studio tab.

History 1

Error Color

TypeDefault
Color3

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

This property is not replicated. Its interface does not cross the network boundary.

History 10

Tags: [NotReplicated]

ExternalEditorMode

TypeDefault
ExternalEditorMode

Sets the mode used when opening scripts in an external editor. This must be set in Studio Settings > Studio tab.

History 1

ExternalEditorSelection

TypeDefault
QDir

Sets which external editor Studio opens scripts with. This must be set in Studio Settings > Studio tab.

History 1

Find Selection Background Color

TypeDefault
Color3

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

This property is not replicated. Its interface does not cross the network boundary.

History 10

Tags: [NotReplicated]

Font

TypeDefault
QFont

Specifies the font used in the script editor.

History 7

  • 725 Change WriteSecurity of Font from None to PluginSecurity
  • 725 Change ReadSecurity of Font from None to PluginSecurity
  • 653 Change Default of Font from to
  • 553 Change Default of Font from to
  • 486 Change ThreadSafety of Font from ReadOnly to ReadSafe
  • 462 Change ThreadSafety of Font from to ReadOnly
  • 349 Add Font

Format On Paste

TypeDefault
bool

Controls whether pasted code is automatically formatted in the script editor. This must be set in Studio Settings > Studio tab.

History 7

Format On Type

TypeDefault
bool

Controls whether code is automatically formatted as you type in the script editor. This must be set in Studio Settings > Studio tab.

History 7

Function Name Color

TypeDefault
Color3

Sets the color of function names in the script editor. This must be set in Studio Settings > Studio tab.

This property is not replicated. Its interface does not cross the network boundary.

History 8

Tags: [NotReplicated]

GetAvailableThemes

Parameters (0)
No parameters.
Returns (1)
Array

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

History 2

Highlight Current Line

TypeDefault
bool

Controls whether the current line is highlighted in the script editor. This must be set in Studio Settings > Studio tab.

History 7

Highlight Occurances

TypeDefault
bool

Controls whether other occurrences of the word under the cursor are highlighted. This must be set in Studio Settings > Studio tab.

History 7

HintColor

TypeDefault
Color3

Sets the color of hint diagnostics in the script editor. This must be set in Studio Settings > Studio tab.

This property is not replicated. Its interface does not cross the network boundary.

History 4

Tags: [NotReplicated]

Hover Animate Speed

TypeDefault
HoverAnimateSpeed

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

History 7

Hover Box Thickness

TypeDefault
float

Sets the thickness of the selection box shown when hovering over objects. This must be set in Studio Settings > Studio tab.

History 4

Hover Line Thickness

TypeDefault
int

Sets the line thickness of the hover selection box. This must be set in Studio Settings > Studio tab.

History 3

Hover Over Color

TypeDefault
Color3

Specifies the color that the hover selection box uses.

History 7

IconOverrideDir

TypeDefault
QDir

Sets the directory Studio uses to load icon overrides. This must be set in Studio Settings > Studio tab.

History 3

Indent Using Spaces

TypeDefault
bool

Controls whether the script editor uses spaces instead of tabs for indentation. This must be set in Studio Settings > Studio tab.

History 7

IndentationRulerColor

TypeDefault
Color3

Sets the color of indentation rulers in the script editor. This must be set in Studio Settings > Studio tab.

This property is not replicated. Its interface does not cross the network boundary.

History 2

Tags: [NotReplicated]

InformationColor

TypeDefault
Color3

Sets the color of information diagnostics in the script editor. This must be set in Studio Settings > Studio tab.

This property is not replicated. Its interface does not cross the network boundary.

History 4

Tags: [NotReplicated]

Keyword Color

TypeDefault
Color3

Sets the text color of built-in Luau keywords.

This property is not replicated. Its interface does not cross the network boundary.

History 10

Tags: [NotReplicated]

LargeFileLineCountThreshold

TypeDefault
int

Sets the line count at which a script is treated as a large file by the script editor. This must be set in Studio Settings > Studio tab.

History 2

LargeFileThreshold

TypeDefault
int

Sets the byte size at which a script is treated as a large file by the script editor. This must be set in Studio Settings > Studio tab.

History 2

Line Thickness

TypeDefault
float

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

History 7

LoadAllBuiltinPluginsInRunModes

TypeDefault
bool

Controls whether all built-in plugins are loaded when using run modes. This must be set in Studio Settings > Studio tab.

History 2

LoadInternalPlugins

TypeDefault
bool

Controls whether internal Roblox plugins are loaded in Studio. This must be set in Studio Settings > Studio tab.

History 1

LoadUserPluginsInRunModes

TypeDefault
bool

Controls whether user-installed plugins are loaded when using run modes. This must be set in Studio Settings > Studio tab.

History 2

LocalAssetsFolder

TypeDefault
QDir

Sets the local folder Studio uses for local asset storage. This must be set in Studio Settings > Studio tab.

History 5

LuaDebuggerEnabled

TypeDefault
bool

Specifies whether or not the Lua Debugger feature is enabled.

History 7

Luau Keyword Color

TypeDefault
Color3

Sets the color of Luau-specific keywords in the script editor. This must be set in Studio Settings > Studio tab.

This property is not replicated. Its interface does not cross the network boundary.

History 8

Tags: [NotReplicated]

Main Volume

TypeDefault
float

Sets the main audio playback volume in Studio. This must be set in Studio Settings > Studio tab.

History 3

Matching Word Background Color

TypeDefault
Color3

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

This property is not replicated. Its interface does not cross the network boundary.

History 10

Tags: [NotReplicated]

MaxFindReplaceAllResults

TypeDefault
int

Sets the maximum number of results returned by the Find All operation. This must be set in Studio Settings > Studio tab.

History 1

Maximum Output Lines

TypeDefault
int

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

History 7

Menu Item Background Color

TypeDefault
Color3

Sets the background color of menu items in Studio. This must be set in Studio Settings > Studio tab.

This property is not replicated. Its interface does not cross the network boundary.

History 6

Tags: [NotReplicated]

Method Color

TypeDefault
Color3

Sets the color of method names in the script editor. This must be set in Studio Settings > Studio tab.

This property is not replicated. Its interface does not cross the network boundary.

History 8

Tags: [NotReplicated]

Number Color

TypeDefault
Color3

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

This property is not replicated. Its interface does not cross the network boundary.

History 10

Tags: [NotReplicated]

Only Play Audio from Window in Focus

TypeDefault
bool

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

History 7

Operator Color

TypeDefault
Color3

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

This property is not replicated. Its interface does not cross the network boundary.

History 10

Tags: [NotReplicated]

Output Font

TypeDefault
QFont

Specifies the font used by the output.

History 7

Output Layout Mode

TypeDefault
OutputLayoutMode

Sets the layout mode of the output.

History 7

PermissionLevelShown

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

History 7

Physical Draggers Select Scope By Default

TypeDefault
bool

Controls whether physical draggers default to selecting within the current scope. This must be set in Studio Settings > Studio tab.

History 4

Pivot Snap To Geometry Color

TypeDefault
Color3

Sets the color of the pivot snap-to-geometry indicator in Studio. This must be set in Studio Settings > Studio tab.

History 4

PluginDebuggingEnabled

TypeDefault
bool

Controls whether plugin script debugging is enabled in Studio. This must be set in Studio Settings > Studio tab.

History 7

PluginsDir

TypeDefault
QDir

The directory where local plugins are stored.

History 7

PreferredTextSize

TypeDefault
PreferredTextSize

Sets the preferred font size in the script editor. This must be set in Studio Settings > Studio tab.

History 3

Primary Text Color

TypeDefault
Color3

Sets the primary text color in Studio. This must be set in Studio Settings > Studio tab.

This property is not replicated. Its interface does not cross the network boundary.

History 6

Tags: [NotReplicated]

Property Color

TypeDefault
Color3

Sets the color of property names in the script editor. This must be set in Studio Settings > Studio tab.

This property is not replicated. Its interface does not cross the network boundary.

History 8

Tags: [NotReplicated]

ReloadBuiltinPluginsOnChange

TypeDefault
bool

Controls whether built-in plugins are automatically reloaded when their files change. This must be set in Studio Settings > Studio tab.

History 2

ReloadLocalPluginsOnChange

TypeDefault
bool

Controls whether local plugins are automatically reloaded when their files change. This must be set in Studio Settings > Studio tab.

History 2

Respect Studio shortcuts when game has focus

TypeDefault
bool

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

History 7

Ruler Color

TypeDefault
Color3

Sets the color of the column ruler in the script editor. This must be set in Studio Settings > Studio tab.

This property is not replicated. Its interface does not cross the network boundary.

History 8

Tags: [NotReplicated]

Rulers

TypeDefault
string

Sets the column positions at which vertical ruler lines are drawn in the script editor. This must be set in Studio Settings > Studio tab.

History 7

  • 725 Change WriteSecurity of Rulers from None to PluginSecurity
  • 725 Change ReadSecurity of Rulers from None to PluginSecurity
  • 653 Change Default of Rulers from to
  • 553 Change Default of Rulers from to
  • 486 Change ThreadSafety of Rulers from ReadOnly to ReadSafe
  • 462 Change ThreadSafety of Rulers from to ReadOnly
  • 432 Add Rulers

RuntimeUndoBehavior

TypeDefault
RuntimeUndoBehavior

Sets how Studio handles undo operations during runtime playback. This must be set in Studio Settings > Studio tab.

History 7

Script Editor Color Preset

TypeDefault
StudioScriptEditorColorPresets

Sets the color preset applied to the script editor. This must be set in Studio Settings > Studio tab.

History 7

Script Editor Scrollbar Background Color

TypeDefault
Color3

Sets the background color of the script editor scrollbar in Studio. This must be set in Studio Settings > Studio tab.

This property is not replicated. Its interface does not cross the network boundary.

History 6

Tags: [NotReplicated]

Script Editor Scrollbar Handle Color

TypeDefault
Color3

Sets the handle color of the script editor scrollbar in Studio. This must be set in Studio Settings > Studio tab.

This property is not replicated. Its interface does not cross the network boundary.

History 6

Tags: [NotReplicated]

ScriptTimeoutLength

TypeDefault
int

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

History 7

Scroll Past Last Line

TypeDefault
bool

Controls whether the script editor allows scrolling below the last line. This must be set in Studio Settings > Studio tab.

History 7

Secondary Text Color

TypeDefault
Color3

Sets the secondary text color in Studio. This must be set in Studio Settings > Studio tab.

This property is not replicated. Its interface does not cross the network boundary.

History 6

Tags: [NotReplicated]

Select Color

TypeDefault
Color3

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

History 7

Select/Hover Color

TypeDefault
Color3

Sets the color of the Model.PrimaryPart selection box.

History 7

Selected Text Color

TypeDefault
Color3

Sets the color of selected text in Studio. This must be set in Studio Settings > Studio tab.

This property is not replicated. Its interface does not cross the network boundary.

History 6

Tags: [NotReplicated]

Selection Background Color

TypeDefault
Color3

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

This property is not replicated. Its interface does not cross the network boundary.

History 10

Tags: [NotReplicated]

Selection Box Thickness

TypeDefault
float

Sets the thickness of the selection box around selected objects. This must be set in Studio Settings > Studio tab.

History 2

Selection Color

TypeDefault
Color3

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

This property is not replicated. Its interface does not cross the network boundary.

History 10

Tags: [NotReplicated]

Selection Line Thickness

TypeDefault
int

Sets the line thickness of the selection box around selected objects. This must be set in Studio Settings > Studio tab.

History 3

Set Pivot of Imported Parts

TypeDefault
bool

Sets whether the pivot point is repositioned when parts are imported. This must be set in Studio Settings > Studio tab.

History 5

Show Animation Skeleton

TypeDefault
bool

History 1

Show Animation Skeleton Attachments

TypeDefault
bool

History 1

Show Animation Skeleton Axes

TypeDefault
bool

History 1

Show Animation Skeleton Rotations

TypeDefault
bool

History 1

Show Animation Skeleton Text

TypeDefault
bool

History 1

Show Core GUI in Explorer while Playing

TypeDefault
bool

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

History 8

Show Diagnostics Bar

TypeDefault
bool

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

History 7

Show FileSyncService

TypeDefault
bool

Controls whether FileSyncService is shown in the Explorer panel. This must be set in Studio Settings > Studio tab.

History 8

Show Hidden Objects in Explorer

TypeDefault
bool

Controls whether hidden objects are visible in the Explorer panel. This must be set in Studio Settings > Studio tab.

History 7

Show Hover Over

TypeDefault
bool

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

History 7

Show Light Guides

TypeDefault
bool

Controls whether light guide visualizations are shown in the viewport. This must be set in Studio Settings > Studio tab.

History 3

Show Plugin GUI Service in Explorer

TypeDefault
bool

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

History 8

Show Singly Selected Attachment Parent Frame

TypeDefault
bool

Controls whether the parent part frame is shown when a single attachment is selected. This must be set in Studio Settings > Studio tab.

History 2

Show Whitespace

TypeDefault
bool

Controls whether whitespace characters are shown as visible glyphs in the script editor. This must be set in Studio Settings > Studio tab.

History 9

Show plus button on hover in Explorer

TypeDefault
bool

Controls whether a plus button appears when hovering over items in the Explorer. This must be set in Studio Settings > Studio tab.

History 8

ShowCorePackagesInExplorer

TypeDefault
bool

Controls whether core packages are shown in the Explorer panel. This must be set in Studio Settings > Studio tab.

History 4

Skip Closing Brackets and Quotes

TypeDefault
bool

Controls whether the cursor skips over a typed closing bracket or quote if one already exists. This must be set in Studio Settings > Studio tab.

History 7

String Color

TypeDefault
Color3

Specifies the color of strings in the script editor.

This property is not replicated. Its interface does not cross the network boundary.

History 10

Tags: [NotReplicated]

Tab Width

TypeDefault
int

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

History 7

Text Color

TypeDefault
Color3

Specifies the color of normal text in the script editor.

This property is not replicated. Its interface does not cross the network boundary.

History 10

Tags: [NotReplicated]

Text Wrapping

TypeDefault
bool

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

History 7

Theme

TypeDefault
Instance

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:

1
settings().Studio.Theme

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

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

History 7

  • 725 Change ReadSecurity of Theme from None to PluginSecurity
  • 725 Change WriteSecurity of Theme from None to PluginSecurity
  • 653 Change Default of Theme from to
  • 553 Change Default of Theme from to
  • 486 Change ThreadSafety of Theme from ReadOnly to ReadSafe
  • 462 Change ThreadSafety of Theme from to ReadOnly
  • 350 Add Theme

ThemeChanged

Parameters (0)
No parameters.

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.

History 2

TypeColor

TypeDefault
Color3

Sets the color of type annotations in the script editor. This must be set in Studio Settings > Studio tab.

This property is not replicated. Its interface does not cross the network boundary.

History 4

Tags: [NotReplicated]

Use Bounding Box Move Handles

TypeDefault
bool

Controls whether move handles are placed at the bounding box edges instead of the pivot. This must be set in Studio Settings > Studio tab.

History 3

UseDefaultExternalEditor

TypeDefault
bool

Controls whether Studio uses the system's default application to open scripts externally. This must be set in Studio Settings > Studio tab.

History 1

VAxisColor

TypeDefault
Color3

Sets the color of the V axis handle in Studio's draggers. This must be set in Studio Settings > Studio tab.

History 1

Warning Color

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

This property is not replicated. Its interface does not cross the network boundary.

History 10

Tags: [NotReplicated]

Whitespace Color

TypeDefault
Color3

Sets the color of visible whitespace characters in the script editor. This must be set in Studio Settings > Studio tab.

This property is not replicated. Its interface does not cross the network boundary.

History 12

Tags: [NotReplicated]

XAxisColor

TypeDefault
Color3

Sets the color of the X axis handle in Studio's draggers. This must be set in Studio Settings > Studio tab.

History 1

YAxisColor

TypeDefault
Color3

Sets the color of the Y axis handle in Studio's draggers. This must be set in Studio Settings > Studio tab.

History 1

ZAxisColor

TypeDefault
Color3

Sets the color of the Z axis handle in Studio's draggers. This must be set in Studio Settings > Studio tab.

History 1

Removed members 46

"export" Color

TypeDefault
Color3
This property is not replicated. Its interface does not cross the network boundary.

History 2

Tags: [NotReplicated]

"type" Color

TypeDefault
Color3
This property is not replicated. Its interface does not cross the network boundary.

History 2

Tags: [NotReplicated]

Attach Debugger To

TypeDefault
DEPRECATED_DebuggerDataModelPreference

History 2

Auto Indent

TypeDefault
bool

History 4

Auto-Recovery Path

TypeDefault
QDir

History 5

Auto-Save Enabled

TypeDefault
bool

History 2

Auto-Save Interval (Minutes)

TypeDefault
int

History 2

Auto-Save Path

TypeDefault
QDir

History 2

Automatically commit locked scripts when you save or publish to Roblox

TypeDefault
bool

History 2

CameraAdaptiveSpeed

TypeDefault
bool

History 3

CameraOrbitSensitivity

TypeDefault
float

History 2

CameraPanSensitivity

TypeDefault
float

History 2

CameraSpeedLockDefault

TypeDefault
bool

History 2

CameraZoomSpeed

TypeDefault
float

History 2

DEPRECATED_DisableAccuratePlaySolo

TypeDefault
bool

History 2

Debug Client In APS Mode

TypeDefault
bool

History 2

DefaultScriptFileDir

TypeDefault
QDir

History 6

Device Pairing Code

TypeDefault
int

History 2

Disable Accurate Play Solo

TypeDefault
bool

History 4

Display Team Create toggle when creating a new experience

TypeDefault
bool

History 2

Drag Multiple Parts As Single Part

TypeDefault
bool

History 5

Enable Intellisense

TypeDefault
bool
This property is deprecated. It exists only for backward compatibility, and should not be used for new work.
This property is not replicated. Its interface does not cross the network boundary.

History 2

Tags: [NotReplicated, Deprecated]

Enable Linting

TypeDefault
bool

History 3

File > New creates a place with Team Create off

TypeDefault
bool

History 3

FindTheme

Parameters (1)
themeNamestring
Returns (1)
Instance

History 2

FreeCameraSpeedScroll

TypeDefault
bool

History 3

Import mesh files as single mesh

TypeDefault
bool

History 2

Language

TypeDefault
LanguagePreference
This property is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 4

Tags: [Deprecated]

Maximum Table Depth

TypeDefault
int

History 4

OverrideCoreScripts

TypeDefault
bool

History 5

OverrideCoreScriptsDir

TypeDefault
QDir

History 5

Preprocessor Color

TypeDefault
Color3
This property is not replicated. Its interface does not cross the network boundary.

History 4

Tags: [NotReplicated]

RecentSavesDir

TypeDefault
QDir

History 2

Render Throttle Percentage

TypeDefault
int

History 5

Selection Highlight Thickness

TypeDefault
float

History 3

Server Audio Behavior

TypeDefault
ServerAudioBehavior

History 5

Show CorePackages

TypeDefault
bool

History 4

Show Deployment Warnings

TypeDefault
bool

History 4

Show QT warnings in output

TypeDefault
bool

History 5

Show Roblox Plugin GUI Service in Explorer

TypeDefault
bool

History 2

Split Meshes

TypeDefault
bool

History 2

StudioStreamingMaxRadius

TypeDefault
int

History 2

StudioStreamingMinRadius

TypeDefault
int

History 2

Use Accurate Play Solo

TypeDefault
bool

History 2

Settings