StudioService¶
Not yet Class NotCreatable NotReplicated Service
Provides access to configuration of Roblox Studio and allows importing files from the user's file system.
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 · 50 modern Roblox members not implemented yet
Description¶
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.
- 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.
Inheritance¶
Object → Instance → StudioService
Properties¶
| Member | Signature | Summary |
|---|---|---|
ActiveScript |
ActiveScript: Instance |
Reflects the LuaSourceContainer currently being edited (if any). |
AlignDraggedObjects |
AlignDraggedObjects: bool |
— |
DraggerSolveConstraints |
DraggerSolveConstraints: bool |
Reflects whether Studio's draggers solve constraints while moving objects. |
DrawConstraintsOnTop |
DrawConstraintsOnTop: bool |
Deprecated property that previously controlled whether constraints were drawn on top of other objects in the viewport. |
GridSize |
GridSize: float |
Determines the distance in studs by which Studio's drag and move tools move objects each tick. |
HoverInstance |
HoverInstance: Instance |
— |
InstalledPluginData |
InstalledPluginData: string |
— |
PivotSnapToGeometry |
PivotSnapToGeometry: bool |
— |
RotateIncrement |
RotateIncrement: float |
Determines the degrees by which Studio's rotation tool will rotate selected objects each tick. |
Secrets |
Secrets: string |
A JSON string storing the local secrets for the current experience, used by Studio to support HttpService:GetSecret(). |
ShowConstraintDetails |
ShowConstraintDetails: bool |
Reflects whether constraint details are drawn in the 3D viewport. |
ShowWeldDetails |
ShowWeldDetails: bool |
Reflects whether weld details are drawn in the 3D viewport. |
StudioLocaleId |
StudioLocaleId: string |
The locale currently in-use by Studio, e.g. en_US. |
UseLocalSpace |
UseLocalSpace: bool |
Determines whether Studio tools will use local space of an object or global space. |
Methods¶
| Member | Signature | Summary |
|---|---|---|
AnimationIdSelected |
StudioService:AnimationIdSelected(id: int64): null |
— |
CopyToClipboard |
StudioService:CopyToClipboard(stringToCopy: string): null |
— |
GetBadgeConfigureUrl |
StudioService:GetBadgeConfigureUrl(badgeId: int64): string |
— |
GetBadgeUploadUrl |
StudioService:GetBadgeUploadUrl(): string |
— |
GetClassIcon |
StudioService:GetClassIcon(className: string): Dictionary |
Provides a dictionary that allows the display of a class' Explorer window icon. |
GetPlaceIsPersistedToCloud |
StudioService:GetPlaceIsPersistedToCloud(): bool |
— |
GetResourceByCategory |
StudioService:GetResourceByCategory(category: string): Dictionary |
— |
GetStartupAssetId |
StudioService:GetStartupAssetId(): string |
— |
GetStartupPluginId |
StudioService:GetStartupPluginId(): string |
— |
GetTermsOfUseUrl |
StudioService:GetTermsOfUseUrl(): string |
— |
GetUserId |
StudioService:GetUserId(): int64 |
Returns the Studio user's userId if they're logged in, otherwise returns 0. |
GizmoRaycast |
StudioService:GizmoRaycast(origin: Vector3, direction: Vector3, raycastParams: RaycastParams = RaycastParams{IgnoreWater=false, BruteForceAllSlow=false, RespectCanCollide=false, CollisionGroup=Default, FilterDescendantsInstances={}}): RaycastResult? |
— |
HasInternalPermission |
StudioService:HasInternalPermission(): bool |
— |
IsPluginInstalled |
StudioService:IsPluginInstalled(assetId: int64): bool |
— |
IsPluginUpToDate |
StudioService:IsPluginUpToDate(assetId: int64, currentAssetVersion: int64): bool |
— |
OpenInBrowser_DONOTUSE |
StudioService:OpenInBrowser_DONOTUSE(url: string): null |
— |
PromptImportFile |
StudioService:PromptImportFile(fileTypeFilter: Array = {}): Instance |
Prompts the current Studio user to select one file to add as a File. |
PromptImportFileAsync |
StudioService:PromptImportFileAsync(fileTypeFilter: Array = {}): Instance |
Prompts the current Studio user to select one file to add as a File. |
PromptImportFiles |
StudioService:PromptImportFiles(fileTypeFilter: Array = {}): Instances |
Prompts the current Studio user to select files to add as Files. |
PromptImportFilesAsync |
StudioService:PromptImportFilesAsync(fileTypeFilter: Array = {}): Instances |
Prompts the current Studio user to select files to add as Files. |
SetPluginEnabled |
StudioService:SetPluginEnabled(assetId: int64, state: bool): null |
— |
ShowPublishToRoblox |
StudioService:ShowPublishToRoblox(): null |
— |
TryInstallPlugin |
StudioService:TryInstallPlugin(assetId: int64, assetVersionId: int64): null |
— |
UninstallPlugin |
StudioService:UninstallPlugin(assetId: int64): null |
— |
UpdatePluginManagement |
StudioService:UpdatePluginManagement(): null |
— |
Events¶
| Member | Signature | Summary |
|---|---|---|
OnImportFromRoblox |
OnImportFromRoblox(assetType: string) |
— |
OnOpenGameSettings |
OnOpenGameSettings(pageIdentifier: string) |
— |
OnOpenManagePackagePlugin |
OnOpenManagePackagePlugin(userId: int64, assetId: int64) |
— |
OnPluginInstalledFromToolbox |
OnPluginInstalledFromToolbox() |
— |
OnPluginInstalledFromWeb |
OnPluginInstalledFromWeb(pluginId: string) |
— |
OnPublishAsPlugin |
OnPublishAsPlugin(instances: Instances) |
— |
OnSaveToRoblox |
OnSaveToRoblox(instances: Instances) |
— |
PromptTransformPluginCheckEnable |
PromptTransformPluginCheckEnable() |
— |
SaveLocallyAsComplete |
SaveLocallyAsComplete(success: bool) |
— |
Roblox reference: StudioService
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.