PcoWSkbVqDnWTu_dm2ix
The Developer Hub is now deprecated and information on this page may no longer be accurate. To see our new and improved documentation, please click here. You can read more about the future of documentation here.
Collapse Sidebar
  1. API Reference
  2. StudioService

StudioService

Show deprecated
Hide content
  1. apireference
  2. studioservice

StudioService

Show deprecated

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 StudioService/GridSize|GridSize, StudioService/RotateIncrement|RotateIncrement and StudioService/UseLocalSpace|UseLocalSpace useful.
  • Plugins that require the user to import files should use StudioService/PromptImportFile|PromptImportFile or StudioService/PromptImportFiles|PromptImportFiles in order to receive File objects.
  • Plugins that display icons of Instance classes can use StudioService/GetClassIcon|GetClassIcon.
  • Plugins that care about which script is currently being edited (if any) can read this from StudioService/ActiveScript|ActiveScript.

Properties

Instance

ActiveScript

[ReadOnly] [NotReplicated]

Reflects the LuaSourceContainer currently being edited (if any)
bool

AlignDraggedObjects

[Hidden] [ReadOnly] [NotReplicated]
bool

DraggerSolveConstraints

[ReadOnly] [NotReplicated]
bool

DrawConstraintsOnTop

[ReadOnly] [NotReplicated]
float

GridSize

[ReadOnly] [NotReplicated]

Determines the distance in studs by which studio’s drag and move tools move objects each tick
Instance

HoverInstance

[Hidden] [NotReplicated]
string

InstalledPluginData

[Hidden] [ReadOnly] [NotReplicated]
bool

PivotSnapToGeometry

[Hidden] [ReadOnly] [NotReplicated]
float

RotateIncrement

[ReadOnly] [NotReplicated]

Determines the degrees by which studio’s rotation tool will rotate selected objects each tick
bool

ShowActiveInstanceHighlight

[Hidden] [NotReplicated]
bool

ShowConstraintDetails

[ReadOnly] [NotReplicated]
string

StudioLocaleId

[ReadOnly] [NotReplicated]

The locale currently in-use by Studio, e.g. en_US.
bool

UseLocalSpace

[NotReplicated]

Determines whether studio tools will use local space of an object or global space.

Inherited from Instance: Show Hide

bool

Archivable

Determines if an Instance can be cloned using /Instance/Clone or saved to file.
string

ClassName

[ReadOnly] [NotReplicated]

A read-only string representing the class this Instance belongs to
int

DataCost

[Hidden] [ReadOnly] [NotReplicated] [Deprecated]

The cost of saving the instance using data persistence.
string

Name

A non-unique identifier of the Instance
Instance

Parent

[NotReplicated]

Determines the hierarchical parent of the Instance
bool

RobloxLocked

[Hidden]

A deprecated property that used to protect CoreGui objects
int64

SourceAssetId

[Hidden] [NotReplicated]
bool

archivable

[Hidden] [NotReplicated] [Deprecated]
string

className

[ReadOnly] [NotReplicated] [Deprecated]

Functions

void

AnimationIdSelected ( int64 id )

void

ConvertToPackageUpload ( string uploadUrl )

void

CopyToClipboard ( string stringToCopy )

void

DEPRECATED_SetDocumentDisplayName ( string newName )

void

DEPRECATED_SetTurnOnTeamCreateOnPublish ( bool turnOn )

void

EmitPlacePublishedSignal ( )

string

GetBadgeConfigureUrl ( int64 badgeId )

string

GetBadgeUploadUrl ( )

Dictionary

GetClassIcon ( string className )

Provides a dictionary that allows the display of a class’ Explorer window icon
bool

GetPlaceIsPersistedToCloud ( )

Dictionary

GetResourceByCategory ( string category )

string

GetStartupAssetId ( )

string

GetStartupPluginId ( )

string

GetTermsOfUseUrl ( )

int64

GetUserId ( )

Returns the studio user’s userId if they’re logged in, otherwise returns 0.
bool

GetUserIsInTeamCreateToggleRamp ( )

RaycastResult

GizmoRaycast ( Vector3 origin , Vector3 direction , RaycastParams raycastParams )

bool

HasInternalPermission ( )

bool

IsPluginInstalled ( int64 assetId )

bool

IsPluginUpToDate ( int64 assetId , int64 currentAssetVersion )

void

OpenInBrowser_DONOTUSE ( string url )

Instance

PromptImportFile ( Array fileTypeFilter )

[Yields]

Prompts the current Studio user to select one file to add as a File
Objects

PromptImportFiles ( Array fileTypeFilter )

[Yields]

Prompts the current Studio user to select files to add as File|Files
void

PublishAs ( int64 universeId , int64 placeId , int64 groupId )

void

RefreshDocumentDisplayName ( )

void

RequestClose ( StudioCloseMode closeMode )

string

SerializeInstances ( Objects instances )

void

SetPluginEnabled ( int64 assetId , bool state )

void

SetUniverseDisplayName ( string newName )

void

ShowPlaceVersionHistoryDialog ( int64 placeId )

void

ShowPublishToRoblox ( )

void

ShowSaveOrPublishPlaceToRoblox ( bool showGameSelect , bool isPublish , StudioCloseMode closeMode )

void

TryInstallPlugin ( int64 assetId , int64 assetVersionId )

[Yields]
void

UninstallPlugin ( int64 assetId )

void

UpdatePluginManagement ( )

Inherited from Instance: Show Hide

void

ClearAllChildren ( )

This function destroys all of an Instance’s children.
Instance

Clone ( )

Create a copy of an object and all its descendants, ignoring objects that are not Instance/Archivable|Archivable
void

Destroy ( )

Sets the Instance/Parent property to nil, locks the Instance/Parent property, disconnects all connections, and calls Destroy on all children.
Instance

FindFirstAncestor ( string name )

Returns the first ancestor of the Instance whose Instance/Name is equal to the given name.
Instance

FindFirstAncestorOfClass ( string className )

Returns the first ancestor of the Instance whose Instance/ClassName is equal to the given className.
Instance

FindFirstAncestorWhichIsA ( string className )

Returns the first ancestor of the Instance for whom Instance/IsA returns true for the given className.
Instance

FindFirstChild ( string name , bool recursive )

Returns the first child of the Instance found with the given name.
Instance

FindFirstChildOfClass ( string className )

Returns the first child of the Instance whose Instance/ClassName|ClassName is equal to the given className.
Instance

FindFirstChildWhichIsA ( string className , bool recursive )

Returns the first child of the Instance for whom Instance/IsA returns true for the given className.
Instance

FindFirstDescendant ( string name )

Returns the first descendant found with the given Instance/Name.
Actor

GetActor ( )

Returns the Actor associated with the Instance, usually the first Actor ancestor
Variant

GetAttribute ( string attribute )

Returns the attribute which has been assigned to the given name
RBXScriptSignal

GetAttributeChangedSignal ( string attribute )

Returns an event that fires when the given attribute changes
Dictionary

GetAttributes ( )

Returns a dictionary of string → variant pairs for each of the Instance|Instance’s attributes
Objects

GetChildren ( )

Returns an array containing all of the Instance’s children.
string

GetDebugId ( int scopeLength )

[NotBrowsable]

Returns a coded string of the Instances DebugId used internally by Roblox.
Array

GetDescendants ( )

[CustomLuaState]

Returns an array containing all of the descendants of the instance
string

GetFullName ( )

Returns a string describing the Instance’s ancestry.
RBXScriptSignal

GetPropertyChangedSignal ( string property )

Get an event that fires when a given property of an object changes.
bool

IsA ( string className )

[CustomLuaState]

Returns true if an Instance’s class matches or inherits from a given class
bool

IsAncestorOf ( Instance descendant )

Returns true if an Instance is an ancestor of the given descendant.
bool

IsDescendantOf ( Instance ancestor )

Returns true if an Instance is a descendant of the given ancestor.
void

Remove ( )

[Deprecated]

Sets the object’s Parent to nil, and does the same for all its descendants.
void

SetAttribute ( string attribute , Variant value )

Sets the attribute with the given name to the given value
Instance

WaitForChild ( string childName , double timeOut )

[CustomLuaState] [CanYield]

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

children ( )

[Deprecated]

Returns an array of the object’s children.
Instance

clone ( )

[Deprecated]
void

destroy ( )

[Deprecated]
Instance

findFirstChild ( string name , bool recursive )

[Deprecated]
Objects

getChildren ( )

[Deprecated]
bool

isA ( string className )

[Deprecated] [CustomLuaState]
bool

isDescendantOf ( Instance ancestor )

[Deprecated]
void

remove ( )

[Deprecated]

Events

RBXScriptSignal

GameNameUpdated ( string name )

RBXScriptSignal

GamePublishFinished ( bool success , int64 gameId )

RBXScriptSignal

OnConvertToPackageResult ( bool isSuccessful , string errorMessage )

RBXScriptSignal

OnImportFromRoblox ( )

RBXScriptSignal

OnOpenConvertToPackagePlugin ( Objects instances , string name )

RBXScriptSignal

OnOpenGameSettings ( string pageIdentifier )

RBXScriptSignal

OnOpenManagePackagePlugin ( int64 userId , int64 assetId )

RBXScriptSignal

OnPluginInstalledFromToolbox ( )

RBXScriptSignal

OnPluginInstalledFromWeb ( string pluginId )

RBXScriptSignal

OnPublishAsPlugin ( Objects instances )

RBXScriptSignal

OnPublishPlaceToRoblox ( bool isOverwritePublish )

RBXScriptSignal

OnSaveOrPublishPlaceToRoblox ( bool showGameSelect , bool isPublish , StudioCloseMode closeMode )

RBXScriptSignal

OnSaveToRoblox ( Objects instances )

RBXScriptSignal

PromptTransformPluginCheckEnable ( )

RBXScriptSignal

SaveLocallyAsComplete ( bool success )

Inherited from Instance: Show Hide

RBXScriptSignal

AncestryChanged ( Instance child , Instance parent )

Fires when the Instance/Parent property of the object or one of its ancestors is changed.
RBXScriptSignal

AttributeChanged ( string attribute )

Fires whenever an attribute is changed on the Instance
RBXScriptSignal

Changed ( string property )

Fired immediately after a property of an object changes.
RBXScriptSignal

ChildAdded ( Instance child )

Fires after an object is parented to this Instance.
RBXScriptSignal

ChildRemoved ( Instance child )

Fires after a child is removed from this Instance.
RBXScriptSignal

DescendantAdded ( Instance descendant )

Fires after a descendant is added to the Instance
RBXScriptSignal

DescendantRemoving ( Instance descendant )

Fires immediately before a descendant of the Instance is removed.
RBXScriptSignal

Destroying ( )

Fires immediately before the instance is destroyed via Instance/Destroy.
RBXScriptSignal

childAdded ( Instance child )

[Deprecated]
RenderSettings TaskScheduler