StudioService

顯示已棄用項目

*此內容很快就會推出您所選的語言版本。

無法建立
服務
未複製

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.

概要

屬性

方法

屬性

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.


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

DraggerSolveConstraints

唯讀
未複製
平行讀取

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

Transform snapping tools indicated in Model tab

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

Transform snapping tools indicated in Model tab

Secrets

平行讀取
Roblox 指令碼安全性

ShowConstraintDetails

唯讀
未複製
平行讀取

ShowWeldDetails

唯讀
未複製
平行讀取
Roblox 指令碼安全性

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.


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

未複製
平行讀取

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

外掛程式安全性

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

參數

className: string

返回

GetUserId

外掛程式安全性

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


返回

範例程式碼

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

外掛程式安全性

參數

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

返回

PromptImportFile

暫停
外掛程式安全性

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

See also:

參數

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.

預設值:"{}"

返回

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

PromptImportFiles

Instances
暫停
外掛程式安全性

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:

參數

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.

預設值:"{}"

返回

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

活動