Studio¶
Not yet Class NotCreatable NotReplicated Service
Represents Roblox Studio's script editor settings.
Not implemented yet
This class exists in the current Roblox API but is not implemented in Nova yet. Scripts that reference it will fail at runtime.
0 Nova members · 205 modern Roblox members not implemented yet
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.
Inheritance¶
Properties¶
| Member | Signature | Summary |
|---|---|---|
"function" Color |
"function" Color: Color3 |
— |
"local" Color |
"local" Color: Color3 |
— |
"nil" Color |
"nil" Color: Color3 |
— |
"self" Color |
"self" Color: Color3 |
— |
"TODO" Color |
"TODO" Color: Color3 |
— |
ActionOnAutoResumeSync |
ActionOnAutoResumeSync: ActionOnAutoResumeSync |
— |
ActionOnStopSync |
ActionOnStopSync: ActionOnStopSync |
Sets the action Studio takes when stopping file sync. |
Active Color |
Active Color: Color3 |
— |
Active Hover Over Color |
Active Hover Over Color: Color3 |
— |
Always Save Script Changes |
Always Save Script Changes: bool |
— |
Animate Hover Over |
Animate Hover Over: bool |
— |
Animation Skeleton Scale |
Animation Skeleton Scale: float |
— |
Animation Skeleton Transparency |
Animation Skeleton Transparency: float |
— |
Auto Clean Empty Line |
Auto Clean Empty Line: bool |
— |
Auto Closing Brackets |
Auto Closing Brackets: bool |
— |
Auto Closing Quotes |
Auto Closing Quotes: bool |
— |
Auto Delete Closing Brackets and Quotes |
Auto Delete Closing Brackets and Quotes: bool |
— |
Auto Indent Rule |
Auto Indent Rule: AutoIndentRule |
— |
Auto-Recovery Enabled |
Auto-Recovery Enabled: bool |
— |
Auto-Recovery Interval (Minutes) |
Auto-Recovery Interval (Minutes): int |
— |
AutocompleteAcceptanceBehavior |
AutocompleteAcceptanceBehavior: CompletionAcceptanceBehavior |
Sets the key used to accept autocomplete suggestions in the script editor. |
Automatically trigger AI Code Completion |
Automatically trigger AI Code Completion: bool |
— |
AutoResumeSyncOnPlaceOpen |
AutoResumeSyncOnPlaceOpen: bool |
Controls whether file sync resumes automatically when a place is opened. |
AutoUpdateEnabled |
AutoUpdateEnabled: bool |
Controls whether Studio updates itself automatically when a new version is available. |
Background Color |
Background Color: Color3 |
— |
Basic Objects Display Mode |
Basic Objects Display Mode: ListDisplayMode |
— |
Bool Color |
Bool Color: Color3 |
— |
Bracket Color |
Bracket Color: Color3 |
— |
Built-in Function Color |
Built-in Function Color: Color3 |
— |
Camera Mouse Wheel Speed |
Camera Mouse Wheel Speed: float |
— |
Camera Pan Speed |
Camera Pan Speed: float |
— |
Camera Shift Speed |
Camera Shift Speed: float |
— |
Camera Speed |
Camera Speed: float |
— |
Camera Speed Adjust Binding |
Camera Speed Adjust Binding: CameraSpeedAdjustBinding |
— |
Camera Zoom to Mouse Position |
Camera Zoom to Mouse Position: bool |
— |
CameraAltLeftMouseToRotate |
CameraAltLeftMouseToRotate: bool |
— |
CameraKeyMoveSmoothing |
CameraKeyMoveSmoothing: bool |
— |
CameraMouseMultiplier |
CameraMouseMultiplier: float |
— |
CameraNavigationModel |
CameraNavigationModel: CameraNavigationModel |
Sets the navigation model used for camera movement in Studio. |
CameraRotateShiftFactor |
CameraRotateShiftFactor: float |
— |
CameraShiftFactor |
CameraShiftFactor: float |
Sets the speed multiplier applied to camera movement when Shift is held. |
CameraTweenFocus |
CameraTweenFocus: bool |
Controls whether the camera smoothly tweens when refocusing on a selected object. |
CameraZoomToMousePosition |
CameraZoomToMousePosition: bool |
— |
Clear Output On Start |
Clear Output On Start: bool |
— |
CommandBarEnterExec |
CommandBarEnterExec: bool |
Controls whether pressing Enter immediately executes the command bar input. |
CommandBarFont |
CommandBarFont: QFont |
Sets the font used in the Studio command bar. |
CommandBarHistoryLen |
CommandBarHistoryLen: int |
— |
CommandBarLocalState |
CommandBarLocalState: bool |
Controls whether the command bar retains its input state between sessions. |
Comment Color |
Comment Color: Color3 |
— |
Current Line Highlight Color |
Current Line Highlight Color: Color3 |
— |
Debugger Current Line Color |
Debugger Current Line Color: Color3 |
— |
Debugger Error Line Color |
Debugger Error Line Color: Color3 |
— |
DefaultInstancesDir |
DefaultInstancesDir: QDir |
Sets the default directory where Studio saves instance files. |
DefaultScriptSyncFileType |
DefaultScriptSyncFileType: DefaultScriptSyncFileType |
Sets the default file type used when syncing scripts to the file system. |
DeprecatedObjectsShown |
DeprecatedObjectsShown: bool |
If set to true, deprecated objects will be shown in the Advanced Objects window, as well as the Object Browser. |
DisplayLanguage |
DisplayLanguage: string |
Sets the display language used by the Studio interface. |
Doc View Code Background Color |
Doc View Code Background Color: Color3 |
— |
DraggerActiveColor |
DraggerActiveColor: Color3 |
Sets the color of the active dragger handle in Studio. |
DraggerLengthFactor |
DraggerLengthFactor: float |
Sets the length scale factor of dragger handles in Studio. |
DraggerMajorGridIncrement |
DraggerMajorGridIncrement: int |
Sets the major grid increment used when snapping with the dragger. |
DraggerMaxSoftSnaps |
DraggerMaxSoftSnaps: int |
Sets the maximum number of soft snap points shown by the dragger. |
DraggerPassiveColor |
DraggerPassiveColor: Color3 |
Sets the color of inactive dragger handles in Studio. |
DraggerScaleFactor |
DraggerScaleFactor: float |
Sets the scale factor controlling the overall size of dragger handles. |
DraggerShowAxisTicks |
DraggerShowAxisTicks: bool |
Controls whether tick marks are shown on dragger axis lines. |
DraggerShowDraggedPoint |
DraggerShowDraggedPoint: bool |
— |
DraggerShowHoverRuler |
DraggerShowHoverRuler: bool |
Controls whether a ruler is shown when hovering near the dragger. |
DraggerShowMeasurement |
DraggerShowMeasurement: bool |
Controls whether distance measurements are shown while dragging. |
DraggerShowNegativeAxes |
DraggerShowNegativeAxes: bool |
Controls whether negative axis handles are shown on the dragger. |
DraggerShowPlanes |
DraggerShowPlanes: bool |
Controls whether planar translation handles are shown on the dragger. |
DraggerShowTargetSnap |
DraggerShowTargetSnap: bool |
Controls whether the target snap indicator is shown on the dragger. |
DraggerShowTrackball |
DraggerShowTrackball: bool |
Controls whether the trackball handle is shown on the rotation dragger. |
DraggerShowWhileDragging |
DraggerShowWhileDragging: bool |
Controls whether dragger handles remain visible while actively dragging. |
DraggerSoftSnapMarginFactor |
DraggerSoftSnapMarginFactor: float |
Sets the margin factor used to determine proximity for soft snapping. |
DraggerSummonMarginFactor |
DraggerSummonMarginFactor: float |
Sets the margin factor used to summon the dragger near a surface. |
DraggerTiltRotateDuration |
DraggerTiltRotateDuration: float |
Sets the duration in seconds of the tilt rotation animation in the dragger. |
Enable Autocomplete |
Enable Autocomplete: bool |
— |
Enable Autocomplete Doc View |
Enable Autocomplete Doc View: bool |
— |
Enable Client/Server MDI |
Enable Client/Server MDI: bool |
— |
Enable CoreScript Debugger |
Enable CoreScript Debugger: bool |
— |
Enable Http Sandboxing |
Enable Http Sandboxing: bool |
— |
Enable Internal Beta Features |
Enable Internal Beta Features: bool |
— |
Enable Internal Features |
Enable Internal Features: bool |
— |
Enable Script Analysis |
Enable Script Analysis: bool |
— |
Enable Scrollbar Markers |
Enable Scrollbar Markers: bool |
— |
Enable Signature Help |
Enable Signature Help: bool |
— |
Enable Signature Help Doc View |
Enable Signature Help Doc View: bool |
— |
Enable Temporary Tabs |
Enable Temporary Tabs: bool |
— |
Enable Temporary Tabs In Explorer |
Enable Temporary Tabs In Explorer: bool |
— |
Enable Type Hover |
Enable Type Hover: bool |
— |
EnableCodeAssist |
EnableCodeAssist: bool |
Controls whether AI-powered code assist features are enabled in the script editor. |
EnableFindOnType |
EnableFindOnType: bool |
Controls whether the Find bar activates when typing in the script editor. |
EnableIndentationRulers |
EnableIndentationRulers: bool |
Controls whether indentation ruler lines are shown in the script editor. |
EnableOnTypeAutocomplete |
EnableOnTypeAutocomplete: bool |
— |
EnableOvertypeMode |
EnableOvertypeMode: bool |
— |
EnableSelectionTooltips |
EnableSelectionTooltips: bool |
Controls whether tooltips are shown when hovering over selected objects. |
EnableStudioStreaming |
EnableStudioStreaming: bool |
Controls whether Studio streaming mode is enabled. |
Error Color |
Error Color: Color3 |
— |
ExternalEditorMode |
ExternalEditorMode: ExternalEditorMode |
Sets the mode used when opening scripts in an external editor. |
ExternalEditorSelection |
ExternalEditorSelection: QDir |
Sets which external editor Studio opens scripts with. |
Find Selection Background Color |
Find Selection Background Color: Color3 |
— |
Font |
Font: QFont |
Specifies the font used in the script editor. |
Format On Paste |
Format On Paste: bool |
— |
Format On Type |
Format On Type: bool |
— |
Function Name Color |
Function Name Color: Color3 |
— |
Highlight Current Line |
Highlight Current Line: bool |
— |
Highlight Occurances |
Highlight Occurances: bool |
— |
HintColor |
HintColor: Color3 |
Sets the color of hint diagnostics in the script editor. |
Hover Animate Speed |
Hover Animate Speed: HoverAnimateSpeed |
— |
Hover Box Thickness |
Hover Box Thickness: float |
— |
Hover Line Thickness |
Hover Line Thickness: int |
— |
Hover Over Color |
Hover Over Color: Color3 |
— |
IconOverrideDir |
IconOverrideDir: QDir |
Sets the directory Studio uses to load icon overrides. |
Indent Using Spaces |
Indent Using Spaces: bool |
— |
IndentationRulerColor |
IndentationRulerColor: Color3 |
Sets the color of indentation rulers in the script editor. |
InformationColor |
InformationColor: Color3 |
Sets the color of information diagnostics in the script editor. |
Keyword Color |
Keyword Color: Color3 |
— |
LargeFileLineCountThreshold |
LargeFileLineCountThreshold: int |
Sets the line count at which a script is treated as a large file by the script editor. |
LargeFileThreshold |
LargeFileThreshold: int |
Sets the byte size at which a script is treated as a large file by the script editor. |
Line Thickness |
Line Thickness: float |
— |
LoadAllBuiltinPluginsInRunModes |
LoadAllBuiltinPluginsInRunModes: bool |
Controls whether all built-in plugins are loaded when using run modes. |
LoadInternalPlugins |
LoadInternalPlugins: bool |
Controls whether internal Roblox plugins are loaded in Studio. |
LoadUserPluginsInRunModes |
LoadUserPluginsInRunModes: bool |
Controls whether user-installed plugins are loaded when using run modes. |
LocalAssetsFolder |
LocalAssetsFolder: QDir |
Sets the local folder Studio uses for local asset storage. |
LuaDebuggerEnabled |
LuaDebuggerEnabled: bool |
Specifies whether or not the Lua Debugger feature is enabled. |
LuaDebuggerEnabledAtStartup |
LuaDebuggerEnabledAtStartup: bool |
Controls whether the Lua debugger is enabled when Studio starts. |
Luau Keyword Color |
Luau Keyword Color: Color3 |
— |
Main Volume |
Main Volume: float |
— |
Matching Word Background Color |
Matching Word Background Color: Color3 |
— |
MaxFindReplaceAllResults |
MaxFindReplaceAllResults: int |
Sets the maximum number of results returned by the Find All operation. |
Maximum Output Lines |
Maximum Output Lines: int |
— |
Menu Item Background Color |
Menu Item Background Color: Color3 |
— |
Method Color |
Method Color: Color3 |
— |
Number Color |
Number Color: Color3 |
— |
Only Play Audio from Window in Focus |
Only Play Audio from Window in Focus: bool |
— |
Operator Color |
Operator Color: Color3 |
— |
Output Font |
Output Font: QFont |
— |
Output Layout Mode |
Output Layout Mode: OutputLayoutMode |
— |
PermissionLevelShown |
PermissionLevelShown: PermissionLevelShown |
Sets the highest permission level that APIs have to have in order to be shown in the Object Browser. See PermissionLevelShown for mor… |
Physical Draggers Select Scope By Default |
Physical Draggers Select Scope By Default: bool |
— |
Pivot Snap To Geometry Color |
Pivot Snap To Geometry Color: Color3 |
— |
PluginDebuggingEnabled |
PluginDebuggingEnabled: bool |
Controls whether plugin script debugging is enabled in Studio. |
PluginsDir |
PluginsDir: QDir |
The directory where local plugins are stored. |
PreferredTextSize |
PreferredTextSize: PreferredTextSize |
Sets the preferred font size in the script editor. |
Primary Text Color |
Primary Text Color: Color3 |
— |
Property Color |
Property Color: Color3 |
— |
ReloadBuiltinPluginsOnChange |
ReloadBuiltinPluginsOnChange: bool |
Controls whether built-in plugins are automatically reloaded when their files change. |
ReloadLocalPluginsOnChange |
ReloadLocalPluginsOnChange: bool |
Controls whether local plugins are automatically reloaded when their files change. |
Respect Studio shortcuts when game has focus |
Respect Studio shortcuts when game has focus: bool |
— |
ReviewableChangeAddedTextColor |
ReviewableChangeAddedTextColor: Color3 |
— |
ReviewableChangeRemovedTextColor |
ReviewableChangeRemovedTextColor: Color3 |
— |
Ruler Color |
Ruler Color: Color3 |
— |
Rulers |
Rulers: string |
Sets the column positions at which vertical ruler lines are drawn in the script editor. |
RuntimeUndoBehavior |
RuntimeUndoBehavior: RuntimeUndoBehavior |
Sets how Studio handles undo operations during runtime playback. |
Script Editor Color Preset |
Script Editor Color Preset: StudioScriptEditorColorPresets |
— |
Script Editor Scrollbar Background Color |
Script Editor Scrollbar Background Color: Color3 |
— |
Script Editor Scrollbar Handle Color |
Script Editor Scrollbar Handle Color: Color3 |
— |
ScriptEditorMenuBorderColor |
ScriptEditorMenuBorderColor: Color3 |
— |
ScriptEditorShouldShowPluginMethods |
ScriptEditorShouldShowPluginMethods: bool |
— |
ScriptTimeoutLength |
ScriptTimeoutLength: int |
The time (in seconds) a script can wait to be resumed before timing out. |
Scroll Past Last Line |
Scroll Past Last Line: bool |
— |
Secondary Text Color |
Secondary Text Color: Color3 |
— |
Select Color |
Select Color: Color3 |
— |
Select/Hover Color |
Select/Hover Color: Color3 |
— |
Selected Menu Item Background Color |
Selected Menu Item Background Color: Color3 |
— |
Selected Text Color |
Selected Text Color: Color3 |
— |
Selection Background Color |
Selection Background Color: Color3 |
— |
Selection Box Thickness |
Selection Box Thickness: float |
— |
Selection Color |
Selection Color: Color3 |
— |
Selection Line Thickness |
Selection Line Thickness: int |
— |
Set Pivot of Imported Parts |
Set Pivot of Imported Parts: bool |
— |
Show Animation Skeleton |
Show Animation Skeleton: bool |
— |
Show Animation Skeleton Attachments |
Show Animation Skeleton Attachments: bool |
— |
Show Animation Skeleton Axes |
Show Animation Skeleton Axes: bool |
— |
Show Animation Skeleton Rotations |
Show Animation Skeleton Rotations: bool |
— |
Show Animation Skeleton Text |
Show Animation Skeleton Text: bool |
— |
Show Core GUI in Explorer while Playing |
Show Core GUI in Explorer while Playing: bool |
— |
Show Diagnostics Bar |
Show Diagnostics Bar: bool |
— |
Show FileSyncService |
Show FileSyncService: bool |
— |
Show Hidden Objects in Explorer |
Show Hidden Objects in Explorer: bool |
— |
Show Hover Over |
Show Hover Over: bool |
— |
Show Light Guides |
Show Light Guides: bool |
— |
Show Navigation Labels |
Show Navigation Labels: bool |
— |
Show Navigation Mesh |
Show Navigation Mesh: bool |
— |
Show Pathfinding Links |
Show Pathfinding Links: bool |
— |
Show Plugin GUI Service in Explorer |
Show Plugin GUI Service in Explorer: bool |
— |
Show plus button on hover in Explorer |
Show plus button on hover in Explorer: bool |
— |
Show Singly Selected Attachment Parent Frame |
Show Singly Selected Attachment Parent Frame: bool |
— |
Show Whitespace |
Show Whitespace: bool |
— |
ShowCorePackagesInExplorer |
ShowCorePackagesInExplorer: bool |
Controls whether core packages are shown in the Explorer panel. |
Skip Closing Brackets and Quotes |
Skip Closing Brackets and Quotes: bool |
— |
String Color |
String Color: Color3 |
— |
Tab Width |
Tab Width: int |
— |
Text Color |
Text Color: Color3 |
— |
Text Wrapping |
Text Wrapping: bool |
— |
Theme |
Theme: Instance |
Used to get/set current theme used by Studio. |
TypeColor |
TypeColor: Color3 |
Sets the color of type annotations in the script editor. |
UI Theme |
UI Theme: UITheme |
— |
Use Bounding Box Move Handles |
Use Bounding Box Move Handles: bool |
— |
UseDefaultExternalEditor |
UseDefaultExternalEditor: bool |
Controls whether Studio uses the system's default application to open scripts externally. |
VAxisColor |
VAxisColor: Color3 |
Sets the color of the V axis handle in Studio's draggers. |
Warning Color |
Warning Color: Color3 |
— |
Whitespace Color |
Whitespace Color: Color3 |
— |
XAxisColor |
XAxisColor: Color3 |
Sets the color of the X axis handle in Studio's draggers. |
YAxisColor |
YAxisColor: Color3 |
Sets the color of the Y axis handle in Studio's draggers. |
ZAxisColor |
ZAxisColor: Color3 |
Sets the color of the Z axis handle in Studio's draggers. |
Methods¶
| Member | Signature | Summary |
|---|---|---|
GetAvailableThemes |
Studio:GetAvailableThemes(): Array |
Returns a list of themes available in Studio. |
Events¶
| Member | Signature | Summary |
|---|---|---|
ThemeChanged |
ThemeChanged() |
Event called when Studio's theme changes. |
Roblox reference: Studio
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.