13 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

StudioService

Inherits from: Instance → Object

StudioService provides access to configuration of Roblox Studio, allows

information. It is intended to be used by Plugins in order to provide a consistent user experience.

Plugins that allow the user to move objects may find GridSize, RotateIncrement and UseLocalSpace useful.
Plugins that require the user to import files should use PromptImportFileAsync or PromptImportFilesAsync in order to receive File objects.
Plugins that display icons of Instance classes can use GetClassIcon.
Plugins that care about which script is currently being edited (if any) can read this from ActiveScript.

Inherits from: Instance

Memory category: Instances

Tags: NotCreatable, Service, NotReplicated

Properties

Name	Type / Returns	Description
StudioService.ActiveScript	Instance	Reflects the `LuaSourceContainer` currently being edited (if any).
StudioService.DraggerSolveConstraints	boolean	Reflects whether Studio's draggers solve constraints while moving objects.
StudioService.DrawConstraintsOnTop	boolean	Deprecated property that previously controlled whether constraints were drawn on top of other objects in the viewport.
StudioService.GridSize	float	Determines the distance in studs by which Studio's drag and move tools move objects each tick.
StudioService.RotateIncrement	float	Determines the degrees by which Studio's rotation tool will rotate selected objects each tick.
StudioService.Secrets	string	A JSON string storing the local secrets for the current experience, used by Studio to support HttpService:GetSecret().
StudioService.ShowConstraintDetails	boolean	Reflects whether constraint details are drawn in the 3D viewport.
StudioService.ShowWeldDetails	boolean	Reflects whether weld details are drawn in the 3D viewport.
StudioService.StudioLocaleId	string	The locale currently in-use by Studio, e.g. `en_US`.
StudioService.UseLocalSpace	boolean	Determines whether Studio tools will use local space of an object or global space.

Inherited from Instance

Name	Type / Returns	Description
Instance.Archivable	boolean	Determines if an `Instance` and its descendants can be cloned using `Instance:Clone()`, and can be saved/published.
Instance.archivable	boolean
Instance.Capabilities	SecurityCapabilities	The set of capabilities allowed to be used for scripts inside this container.
Instance.IsInSandbox	boolean	Indicates whether the instance is inside a sandboxed container.
Instance.Name	string	A non-unique identifier of the `Instance`.
Instance.Parent	Instance	Determines the hierarchical parent of the `Instance`.
Instance.PredictionMode	PredictionMode	Reflects the client-side prediction mode applied to the instance under server-authoritative physics.
Instance.RobloxLocked	boolean	A deprecated property that used to protect `CoreGui` objects.
Instance.Sandboxed	boolean	When enabled, the instance can only access abilities in its `Capabilities` list.
Instance.UniqueId	UniqueId	A unique identifier for the instance.

Inherited from Object

Name	Type / Returns	Description
Object.ClassName	string	A read-only string representing the class this `Object` belongs to.
Object.className	string

StudioService.ActiveScript

ActiveScript refers to the LuaSourceContainer currently being edited by the user. If the user is not editing a script, this will be nil. Below is an example that shows how you can use this property to measure for how long a script was active.

Field	Value
type	Instance
tags	["ReadOnly","NotReplicated"]
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	State
serialization	{"can_load":false,"can_save":false}

Code samples: View on Creator Hub (StudioService-ActiveScript).

StudioService.DraggerSolveConstraints

Reflects whether Studio's move, scale, and rotate draggers solve constraints while dragging, so that manipulating one part of a constrained mechanism moves the connected parts according to their constraints. This property is read-only and defaults to false. Plugins that implement their own dragging tools can read it to match the user's current dragger behavior.

Field	Value
type	boolean
tags	["ReadOnly","NotReplicated"]
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Data
serialization	{"can_load":false,"can_save":false}

StudioService.DrawConstraintsOnTop

Deprecated. This property is deprecated; constraints can no longer be drawn "on top" of other objects.

This property is deprecated and no longer has any effect: constraints can no longer be drawn "on top" of other objects in the 3D viewport.

Field	Value
type	boolean
tags	["ReadOnly","NotReplicated","Deprecated"]
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Data
serialization	{"can_load":false,"can_save":false}

StudioService.GridSize

GridSize determines the distance in studs by which Studio's drag and move tools move objects each tick. This is set in the user's toolbar's Model tab.

Field	Value
type	float
tags	["ReadOnly","NotReplicated"]
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Data
serialization	{"can_load":false,"can_save":false}

StudioService.RotateIncrement

RotateIncrement determines the angle in degrees by which Studio's rotation tool will rotate selected objects each tick. This is set in the user's toolbar's Model tab.

Field	Value
type	float
tags	["ReadOnly","NotReplicated"]
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Data
serialization	{"can_load":false,"can_save":false}

StudioService.Secrets

Secrets stores the local secrets configured for the current experience. This property is not accessible to creators; secrets are consumed at runtime through HttpService:GetSecret().

Field	Value
type	string
security	{"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"}
thread safety	ReadSafe
category	Data
serialization	{"can_load":true,"can_save":true}

StudioService.ShowConstraintDetails

Reflects whether Studio draws constraint details in the 3D viewport, mirroring the Constraint Details toggle in the toolbar's Model tab. When enabled, constraints such as WeldConstraints and NoCollisionConstraints are drawn and become selectable in the viewport. This property is read-only and defaults to false.

Field	Value
type	boolean
tags	["ReadOnly","NotReplicated"]
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Data
serialization	{"can_load":false,"can_save":false}

StudioService.ShowWeldDetails

Reflects whether Studio draws weld details in the 3D viewport. When enabled, WeldConstraints between parts are visualized. This property is read-only and defaults to false.

Field	Value
type	boolean
tags	["ReadOnly","NotReplicated"]
security	{"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"}
thread safety	ReadSafe
category	Data
serialization	{"can_load":false,"can_save":false}

StudioService.StudioLocaleId

The StudioLocaleId property contains the locale currently in-use by Studio, e.g. en_US. It is useful when localizing plugins.

Below is a trivial example of localization based on the value returned by this function.

Field	Value
type	string
tags	["ReadOnly","NotReplicated"]
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	State
serialization	{"can_load":false,"can_save":false}

Code samples: View on Creator Hub (StudioService-StudioLocaleId).

StudioService.UseLocalSpace

UseLocalSpace determines whether the Studio movement/rotation tools will manipulate a part's CFrame using the local space of an object or global space. By default, this setting is toggled with CtrlL or ⌘L. Plugins can read from this property if they implement their own object movement tools.

Field	Value
type	boolean
tags	["NotReplicated"]
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Data
serialization	{"can_load":true,"can_save":false}

Methods

Name	Type / Returns	Description
StudioService:GetClassIcon	Dictionary	Provides a dictionary that allows the display of a class' Explorer window icon.
StudioService:GetUserId	int64	Returns the Studio user's userId if they're logged in, otherwise returns 0.
StudioService:PromptImportFile	Instance	Prompts the current Studio user to select one file to add as a `File`.
StudioService:PromptImportFileAsync	Instance	Prompts the current Studio user to select one file to add as a `File`.
StudioService:PromptImportFiles	Instances	Prompts the current Studio user to select files to add as `Files`.
StudioService:PromptImportFilesAsync	Instances	Prompts the current Studio user to select files to add as `Files`.

Inherited from Instance

Name	Type / Returns	Description
Instance:AddTag	()	Applies a tag to the instance.
Instance:children	Instances	Returns an array of the object's children.
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`.
Instance:clone	Instance
Instance:Destroy	()	Sets the `Instance.Parent` property to `nil`, locks the `Instance.Parent` property, disconnects all connections, and calls `Destroy()` on all children.
Instance:destroy	()
Instance:FindFirstAncestor	Instance?	Returns the first ancestor of the `Instance` whose `Instance.Name` is equal to the given name.
Instance:FindFirstAncestorOfClass	Instance?	Returns the first ancestor of the `Instance` whose `Object.ClassName` is equal to the given className.
Instance:FindFirstAncestorWhichIsA	Instance?	Returns the first ancestor of the `Instance` for whom `Object:IsA()` returns true for the given className.
Instance:FindFirstChild	Instance?	Returns the first child of the `Instance` found with the given name.
Instance:findFirstChild	Instance
Instance:FindFirstChildOfClass	Instance?	Returns the first child of the `Instance` whose `ClassName` is equal to the given class name.
Instance:FindFirstChildWhichIsA	Instance?	Returns the first child of the `Instance` for whom `Object:IsA()` returns true for the given className.
Instance:FindFirstDescendant	Instance?	Returns the first descendant found with the given `Instance.Name`.
Instance:GetActor	Actor?	Returns the `Actor` associated with the Instance, if any.
Instance:GetAttribute	Variant	Returns the value which has been assigned to the given attribute name.
Instance:GetAttributeChangedSignal	RBXScriptSignal	Returns an event that fires when the given attribute changes.
Instance:GetAttributes	Dictionary	Returns a dictionary of the instance's attributes.
Instance:GetChildren	Instances	Returns an array containing all of the instance's children.
Instance:getChildren	Instances
Instance:GetDebugId	string	Returns a coded string of the debug ID used internally by Roblox.
Instance:GetDescendants	Instances	Returns an array containing all of the descendants of the instance.
Instance:GetFullName	string	Returns a string describing the instance's ancestry.
Instance:GetStyled	Variant	Returns 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	RBXScriptSignal	Returns an event that fires when the given style property changes on the instance.
Instance:GetTags	Array	Gets an array of all tags applied to the instance.
Instance:HasTag	boolean	Check whether the instance has a given tag.
Instance:IsAncestorOf	boolean	Returns true if an `Instance` is an ancestor of the given descendant.
Instance:IsDescendantOf	boolean	Returns `true` if an `Instance` is a descendant of the given ancestor.
Instance:isDescendantOf	boolean
Instance:IsPropertyModified	boolean	Returns `true` if the value stored in the specified property is not equal to the code-instantiated default.
Instance:QueryDescendants	Instances	Returns an array containing all descendants of the instance that match the `selector` string.
Instance:Remove	()	Sets the object's `Parent` to `nil`, and does the same for all its descendants.
Instance:remove	()
Instance:RemoveTag	()	Removes a tag from the instance.
Instance:ResetPropertyToDefault	()	Resets a property to its default value.
Instance:SetAttribute	()	Sets the attribute with the given name to the given value.
Instance:WaitForChild	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.

Inherited from Object

Name	Type / Returns	Description
Object:GetPropertyChangedSignal	RBXScriptSignal	Get an event that fires when a given property of the object changes.
Object:IsA	boolean	Returns true if an object's class matches or inherits from a given class.
Object:isA	boolean

StudioService:GetClassIcon

GetClassIcon provides a dictionary that allows the display of a class' Explorer window icon, e.g. calling this function with "Part" returns property values that display the part icon from the Explorer window.

Below is a literal table representation of the value returned when this function is called with "Part".

{
	Image = "rbxasset://textures/ClassImages.png",
	ImageRectOffset = Vector2.new(16, 0),
	ImageRectSize = Vector2.new(16, 16)
}

The utility function below may prove useful when displaying class icons:

local StudioService = game:GetService("StudioService")
local imageLabel = script.Parent
local function displayClassIcon(image, className)
	for k, v in StudioService:GetClassIcon(className) do
		image[k] = v -- Set property
	end
end
displayClassIcon(imageLabel, "Part")

Parameters

Name	Type	Default	Description
className	string		The name of the Roblox class to retrieve the Explorer window icon for.

Returns

Type	Description
Dictionary	A dictionary containing `Image`, `ImageRectOffset`, and `ImageRectSize` fields that can be applied to an `ImageLabel` to display the class icon.

Field	Value
security	PluginSecurity
thread safety	Unsafe

StudioService:GetUserId

Returns the Studio user's userId if they're logged in, otherwise returns 0.

Returns

Type	Description
int64	The UserId of the logged-in Studio user, or 0 if the user is not logged in.

Field	Value
security	PluginSecurity
thread safety	Unsafe

Code samples: View on Creator Hub (studioservice-getuserid).

StudioService:PromptImportFile

Deprecated.

This function prompts the current Studio user to select one file, which will then be loaded as a File.

See also:

StudioService:PromptImportFiles(), the same function but for loading a list of files instead of a single file

Parameters

Name	Type	Default	Description
fileTypeFilter	Array	{}	A list of file types that the user is allowed to select. File types are formatted without a period. For example, {"jpg", "png"} would allow only a JPG or PNG file to be selected. If no filter is provided, the filter is `nil` and allows the user to select any file type.

Returns

Type	Description
Instance	The imported `File`. Returns `nil` if no files were selected, or if the selected file was too large (FileSize greater than 100 megabytes).

Field	Value
tags	["Yields","Deprecated"]
security	PluginSecurity
thread safety	Unsafe

StudioService:PromptImportFileAsync

This function prompts the current Studio user to select one file, which will then be loaded as a File.

See also:

StudioService:PromptImportFilesAsync(), the same function but for loading a list of files instead of a single file

Parameters

Name	Type	Default	Description
fileTypeFilter	Array	{}	A list of file types that the user is allowed to select. File types are formatted without a period. For example, {"jpg", "png"} would allow only a JPG or PNG file to be selected. If no filter is provided, the filter is `nil` and allows the user to select any file type.

Returns

Type	Description
Instance	The imported `File`. Returns `nil` if no files were selected, or if the selected file was too large (FileSize greater than 100 megabytes).

Field	Value
tags	["Yields"]
security	PluginSecurity
thread safety	Unsafe

StudioService:PromptImportFiles

Deprecated.

This function prompts the current Studio user to select one or more files, which will then be loaded as Files.

Throws an error if the fileTypeFilter was an empty list.

See also:

StudioService:PromptImportFilesAsync(), the same function but for loading a list of files instead of a single file

Parameters

Name	Type	Default	Description
fileTypeFilter	Array	{}	A list of file types that the user is allowed to select. File types are formatted without a period. For example, {"jpg", "png"} would allow only JPG and PNG files to be selected. If no filter is provided, the filter is `nil` and allows the user to select any file type.

Returns

Type	Description
Instances	The imported `Files`. Returns an empty list if no files were selected. Returns `nil` if the user selected one or more files that were too large (FileSize greater than 100 megabytes).

Field	Value
tags	["Yields","Deprecated"]
security	PluginSecurity
thread safety	Unsafe

StudioService:PromptImportFilesAsync

This function prompts the current Studio user to select one or more files, which will then be loaded as Files.

Throws an error if the fileTypeFilter was an empty list.

See also:

StudioService:PromptImportFileAsync(), the same function but for loading a single file instead of a list of files

Parameters

Name	Type	Default	Description
fileTypeFilter	Array	{}	A list of file types that the user is allowed to select. File types are formatted without a period. For example, {"jpg", "png"} would allow only JPG and PNG files to be selected. If no filter is provided, the filter is `nil` and allows the user to select any file type.

Returns

Type	Description
Instances	The imported `Files`. Returns an empty list if no files were selected. Returns `nil` if the user selected one or more files that were too large (FileSize greater than 100 megabytes).

Field	Value
tags	["Yields"]
security	PluginSecurity
thread safety	Unsafe

Events

Inherited from Instance

Name	Type / Returns	Description
Instance.AncestryChanged		Fires when the `Instance.Parent` property of this object or one of its ancestors is changed.
Instance.AttributeChanged		Fires whenever an attribute is changed on the `Instance`.
Instance.ChildAdded		Fires after an object is parented to this `Instance`.
Instance.childAdded
Instance.ChildRemoved		Fires after a child is removed from this `Instance`.
Instance.DescendantAdded		Fires after a descendant is added to the `Instance`.
Instance.DescendantRemoving		Fires immediately before a descendant of the `Instance` is removed.
Instance.Destroying		Fires immediately before (or is deferred until after) the instance is destroyed via `Instance:Destroy()`.
Instance.StyledPropertiesChanged		Fires whenever any style property is changed on the instance, including when a property is set to `nil`.

Inherited from Object

Name	Type / Returns	Description
Object.Changed		Fires immediately after a property of the object changes, with some limitations.