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 161

HistoryMember
553"TODO" Color: Color3
553"function" Color: Color3
553"local" Color: Color3
553"nil" Color: Color3
553"self" Color: Color3
643ActionOnStopSync: ActionOnStopSync
553Active Color: Color3
553Active Hover Over Color: Color3
553Always Save Script Changes: bool
553Animate Hover Over: bool
553Auto Clean Empty Line: bool
553Auto Closing Brackets: bool
553Auto Closing Quotes: bool
563Auto Delete Closing Brackets and Quotes: bool
553Auto Indent Rule: AutoIndentRule
553Auto-Recovery Enabled: bool
553Auto-Recovery Interval (Minutes): int
576Automatically trigger AI Code Completion: bool
553Background Color: Color3
553Basic Objects Display Mode: ListDisplayMode
553Bool Color: Color3
553Bracket Color: Color3
553Built-in Function Color: Color3
553Camera Mouse Wheel Speed: float
553Camera Pan Speed: float
553Camera Shift Speed: float
553Camera Speed: float
597Camera Speed Adjust Binding: CameraSpeedAdjustBinding
553Camera Zoom to Mouse Position: bool
591CameraAdaptiveSpeed: bool
591CameraTweenFocus: bool
553Clear Output On Start: bool
553CommandBarLocalState: bool
553Comment Color: Color3
553Current Line Highlight Color: Color3
553Debugger Current Line Color: Color3
553Debugger Error Line Color: Color3
553DefaultScriptFileDir: QDir
553DeprecatedObjectsShown: bool
553DisplayLanguage: string
611DraggerActiveColor: Color3
611DraggerMajorGridIncrement: int
611DraggerMaxSoftSnaps: int
611DraggerPassiveColor: Color3
611DraggerShowHoverRuler: bool
611DraggerShowMeasurement: bool
611DraggerShowTargetSnap: bool
611DraggerSoftSnapMarginFactor: float
611DraggerSummonMarginFactor: float
611DraggerTiltRotateDuration: float
553Enable Autocomplete: bool
553Enable Autocomplete Doc View: bool
553Enable CoreScript Debugger: bool
553Enable Http Sandboxing: bool
553Enable Internal Beta Features: bool
553Enable Internal Features: bool
553Enable Script Analysis: bool
553Enable Scrollbar Markers: bool
553Enable Signature Help: bool
553Enable Signature Help Doc View: bool
553Enable Temporary Tabs: bool
553Enable Temporary Tabs In Explorer: bool
553Enable Type Hover: bool
613EnableCodeAssist: bool
580EnableIndentationRulers: bool
553Error Color: Color3
553Find Selection Background Color: Color3
553Font: QFont
553Format On Paste: bool
553Format On Type: bool
593FreeCameraSpeedScroll: bool
553Function Name Color: Color3
553Highlight Current Line: bool
553Highlight Occurances: bool
573HintColor: Color3
553Hover Animate Speed: HoverAnimateSpeed
553Hover Box Thickness: float
553Hover Line Thickness: int
553Hover Over Color: Color3
553IconOverrideDir: QDir
553Indent Using Spaces: bool
580IndentationRulerColor: Color3
573InformationColor: Color3
553Keyword Color: Color3
592LargeFileLineCountThreshold: int
592LargeFileThreshold: int
553Line Thickness: float
614LoadAllBuiltinPluginsInRunModes: bool
614LoadUserPluginsInRunModes: bool
553LocalAssetsFolder: QDir
553LuaDebuggerEnabled: bool
553Luau Keyword Color: Color3
553Main Volume: float
553Matching Word Background Color: Color3
553Maximum Output Lines: int
553Menu Item Background Color: Color3
553Method Color: Color3
553Number Color: Color3
553Only Play Audio from Window in Focus: bool
553Operator Color: Color3
553Output Font: QFont
553Output Layout Mode: OutputLayoutMode
553PermissionLevelShown: PermissionLevelShown
553Physical Draggers Select Scope By Default: bool
553Pivot Snap To Geometry Color: Color3
553PluginDebuggingEnabled: bool
553PluginsDir: QDir
553Primary Text Color: Color3
553Property Color: Color3
582ReloadBuiltinPluginsOnChange: bool
582ReloadLocalPluginsOnChange: bool
553Respect Studio shortcuts when game has focus: bool
553Ruler Color: Color3
553Rulers: string
553RuntimeUndoBehavior: RuntimeUndoBehavior
553Script Editor Color Preset: StudioScriptEditorColorPresets
553Script Editor Scrollbar Background Color: Color3
553Script Editor Scrollbar Handle Color: Color3
553ScriptTimeoutLength: int
553Scroll Past Last Line: bool
553Secondary Text Color: Color3
553Select Color: Color3
553Select/Hover Color: Color3
553Selected Menu Item Background Color: Color3
553Selected Text Color: Color3
553Selection Background Color: Color3
567Selection Box Thickness: float
553Selection Color: Color3
553Selection Line Thickness: int
553Set Pivot of Imported Parts: bool
553Show Core GUI in Explorer while Playing: bool
553Show Diagnostics Bar: bool
553Show FileSyncService: bool
553Show Hidden Objects in Explorer: bool
553Show Hover Over: bool
553Show Light Guides: bool
553Show Navigation Labels: bool
553Show Navigation Mesh: bool
553Show Pathfinding Links: bool
553Show Plugin GUI Service in Explorer: bool
580Show Singly Selected Attachment Parent Frame: bool
553Show Whitespace: bool
553Show plus button on hover in Explorer: bool
553ShowCorePackagesInExplorer: bool
553Skip Closing Brackets and Quotes: bool
553String Color: Color3
553Tab Width: int
553Text Color: Color3
553Text Wrapping: bool
553Theme: Instance
553Use Bounding Box Move Handles: bool
553Warning Color: Color3
553Whitespace Color: Color3
462GetAvailableThemes(): Array
462ThemeChanged()
inherited from Instance
553Archivable: bool
635Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: 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
486GetDescendants(): Array
486GetFullName(): string
641GetStyled(name: string): Variant
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: 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()
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 37

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
492DEPRECATED_DisableAccuratePlaySolo: bool
366Debug Client In APS Mode: bool
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
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
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 705

Members 161

"TODO" Color

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

History 5

Tags: [NotReplicated]

"function" Color

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

History 5

Tags: [NotReplicated]

"local" Color

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

History 5

Tags: [NotReplicated]

"nil" Color

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

History 5

Tags: [NotReplicated]

"self" Color

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

History 5

Tags: [NotReplicated]

ActionOnStopSync

TypeDefault
ActionOnStopSync

History 1

Active Color

TypeDefault
Color3

History 4

Active Hover Over Color

TypeDefault
Color3

History 4

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 4

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 4

Auto Clean Empty Line

TypeDefault
bool

History 4

Auto Closing Brackets

TypeDefault
bool

History 4

Auto Closing Quotes

TypeDefault
bool

History 4

Auto Delete Closing Brackets and Quotes

TypeDefault
bool

History 1

Auto Indent Rule

TypeDefault
AutoIndentRule

History 4

Auto-Recovery Enabled

TypeDefault
bool

History 4

Auto-Recovery Interval (Minutes)

TypeDefault
int

History 4

Automatically trigger AI Code Completion

TypeDefault
bool

History 1

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 7

Tags: [NotReplicated]

Basic Objects Display Mode

TypeDefault
ListDisplayMode

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

History 4

Bool Color

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

History 5

Tags: [NotReplicated]

Bracket Color

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

History 4

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 7

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 4

Camera Pan Speed

TypeDefault
float

History 2

Camera Shift Speed

TypeDefault
float

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

History 4

Camera Speed

TypeDefault
float

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

History 4

Camera Speed Adjust Binding

TypeDefault
CameraSpeedAdjustBinding

History 1

Camera Zoom to Mouse Position

TypeDefault
bool

History 4

CameraAdaptiveSpeed

TypeDefault
bool

History 1

CameraTweenFocus

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 4

CommandBarLocalState

TypeDefault
bool

History 4

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 7

Tags: [NotReplicated]

Current Line Highlight Color

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

History 7

Tags: [NotReplicated]

Debugger Current Line Color

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

History 9

Tags: [NotReplicated]

Debugger Error Line Color

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

History 9

Tags: [NotReplicated]

DefaultScriptFileDir

TypeDefault
QDir

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

History 4

DeprecatedObjectsShown

TypeDefault
bool

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

History 4

DisplayLanguage

TypeDefault
string

History 3

DraggerActiveColor

TypeDefault
Color3

History 1

DraggerMajorGridIncrement

TypeDefault
int

History 1

DraggerMaxSoftSnaps

TypeDefault
int

History 1

DraggerPassiveColor

TypeDefault
Color3

History 1

DraggerShowHoverRuler

TypeDefault
bool

History 1

DraggerShowMeasurement

TypeDefault
bool

History 1

DraggerShowTargetSnap

TypeDefault
bool

History 1

DraggerSoftSnapMarginFactor

TypeDefault
float

History 1

DraggerSummonMarginFactor

TypeDefault
float

History 1

DraggerTiltRotateDuration

TypeDefault
float

History 1

Enable Autocomplete

TypeDefault
bool

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

History 5