PcoWSkbVqDnWTu_dm2ix
The Developer Hub is now deprecated and information on this page may no longer be accurate. Instead, you should go to our new and improved documentation. You can also learn more about the future of documentation.
Collapse Sidebar

AssetManagerService

Show deprecated

AssetManagerService

Show deprecated

Properties

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

int64

AddNewPlace ( )

[Yields]
void

CreateAlias ( int assetType , int64 assetId , string aliasName )

[Yields]
void

DeleteAlias ( string aliasName )

[Yields]
int64

GetMeshIdFromAliasName ( string aliasName )

int64

GetMeshIdFromAssetId ( int64 assetId )

int64

GetTextureIdFromAliasName ( string aliasName )

int64

GetTextureIdFromAssetId ( int64 assetId )

bool

HasUnpublishedChangesForLinkedSource ( string aliasName )

void

InsertAudio ( int64 assetId , string assetName )

void

InsertImage ( int64 assetId )

void

InsertLinkedSourceAsLocalScript ( string aliasName )

void

InsertLinkedSourceAsModuleScript ( string aliasName )

void

InsertLinkedSourceAsScript ( string aliasName )

void

InsertMesh ( string aliasName , bool insertWithLocation )

void

InsertMeshesWithLocation ( Array aliasNames )

void

InsertModel ( int64 modelId )

void

InsertPackage ( int64 packageId )

void

OpenLinkedSource ( string aliasName )

void

OpenPlace ( int64 placeId )

void

PublishLinkedSource ( int64 assetId , string aliasName )

[Yields]
void

RefreshLinkedSource ( string aliasName )

void

RemovePlace ( int64 placeId )

[Yields]
void

RenameAlias ( int assetType , int64 assetId , string oldAliasName , string newAliasName )

[Yields]
void

RenameModel ( int64 modelId , string newName )

[Yields]
void

RenamePlace ( int64 placeId , string newName )

[Yields]
void

RevertLinkedSourceToLastPublishedVersion ( string aliasName )

void

ShowPackageDetails ( int64 packageId )

void

UpdateAllPackages ( int64 packageId )

void

ViewPackageOnWebsite ( int64 packageId )

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

AssetImportedSignal ( AssetType assetType , string assetId , int64 assetName )

RBXScriptSignal

ImportSessionFinished ( )

RBXScriptSignal

ImportSessionStarted ( )

RBXScriptSignal

MayBeLinkedSourceModified ( string aliasName )

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]