Engine

StudioService

Show Deprecated
not creatable
service
not replicated

StudioService provides access to configuration of Roblox Studio, allows importing files from the user's file system, and other miscellaneous information. It is intended to be used by Plugins in order to provide a consistent user experience.

Summary

Properties

Methods

Properties

ActiveScript

read only
not replicated
read parallel

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.


local startTime = os.time()
local activeScript
local function onActiveScriptChanged(newActiveScript)
if newActiveScript ~= activeScript then
local deltaTime = os.time() - startTime
print(("You edited %s for %d:%2.d"):format(activeScript.Name, math.floor(deltaTime / 60), deltaTime % 60))
end
startTime = os.time()
activeScript = newActiveScript
end
game:GetService("StudioService"):GetPropertyChangedSignal("ActiveScript"):Connect(onActiveScriptChanged)

DraggerSolveConstraints

read only
not replicated
read parallel

GridSize

read only
not replicated
read parallel

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 Model tab under the Snap to Grid section.

Transform snapping tools indicated in Model tab

RotateIncrement

read only
not replicated
read parallel

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 Model tab under the Snap to Grid section.

Transform snapping tools indicated in Model tab

ShowConstraintDetails

read only
not replicated
read parallel

StudioLocaleId

read only
not replicated
read parallel

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.


local locale = game:GetService("StudioService").StudioLocaleId
if locale == "en_US" then
print("Howdy, ya'll")
elseif locale == "en_GB" then
print("'Ello, gov'na")
elseif locale:sub(1, 2) == "en" then
print("Hello")
elseif locale == "fr_FR" then
print("Bonjour")
end

UseLocalSpace

not replicated
read parallel

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.

The images below show how movement/rotation tools change when working with parts. When UseLocalSpace is false, the movement tools align with the global axes, and when true the movement tools align with the part's local axes.

falsetrue
Part draggers in World orientation modePart draggers in Local orientation mode

Methods

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

className: string

Returns

GetUserId

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


Returns

Code Samples

StudioService:GetUserId

-- Can only be used in a plugin
local StudioService = game:GetService("StudioService")
local Players = game:GetService("Players")
local loggedInUserId = StudioService:GetUserId()
local loggedInUserName = Players:GetNameFromUserIdAsync(loggedInUserId)
print("Hello,", loggedInUserName)

GizmoRaycast

Parameters

origin: Vector3
direction: Vector3
raycastParams: RaycastParams
Default Value: "RaycastParams{IgnoreWater=false, BruteForceAllSlow=false, RespectCanCollide=false, CollisionGroup=Default, FilterDescendantsInstances={}}"

Returns

PromptImportFile

yields

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

See also:

Parameters

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.

Default Value: "{}"

Returns

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

PromptImportFiles

yields

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:

Parameters

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.

Default Value: "{}"

Returns

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

Events