StudioService

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.

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.

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.

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.

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.

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().

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.

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.

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.

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.

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")

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

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

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

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

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