PcoWSkbVqDnWTu_dm2ix
Collapse Sidebar

InsertService

Show deprecated

InsertService

Show deprecated

InsertService is used to insert assets from the Roblox website, typically the InsertService/LoadAsset|LoadAsset function.

To load an asset, the asset must be accessible by the creator of the game loading it, which can be either a user or group. Due to these restrictions, InsertService is useful for loading sensitive data, typically API or secret keys to be used with HttpService. Should a game be uploaded by a different creator, the sensitive data would not be accessible. See the InsertService/LoadAsset|LoadAsset function for more details on this security check.

See Also

  • AssetService, which can provide information about assets you might want to load using InsertService

Properties

bool

AllowClientInsertModels

[NotScriptable]
bool

AllowInsertFreeModels

[NotReplicated] [NotBrowsable] [Deprecated]

Indicates whether ‘‘Free Models’’ can be inserted into the game

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

[ReadOnly] [NotReplicated] [Deprecated]

The cost of saving the instance using data persistence.

string

Name

A non-unique identifier of the Instance

Instance

Parent

Determines the hierarchical parent of the Instance

bool

RobloxLocked

[Deprecated]

A deprecated property that used to protect CoreGui objects

bool

archivable

[Hidden] [NotReplicated] [Deprecated]
string

className

[ReadOnly] [NotReplicated] [Deprecated]

Functions

void

ApproveAssetId ( int64 assetId )

[Deprecated]
void

ApproveAssetVersionId ( int64 assetVersionId )

[Deprecated]
Instance

CreateMeshPartAsync ( Content meshId , CollisionFidelity collisionFidelity , RenderFidelity renderFidelity )

[Yields]
Array

GetBaseCategories ( )

[Yields] [Deprecated]
Array

GetBaseSets ( )

[Yields]

Returns an array of dictionaries, containing information about various Roblox approved sets.

Array

GetCollection ( int64 categoryId )

[Yields]

Returns the most recently uploaded models in the specified category.

Array

GetFreeDecals ( string searchText , int pageNum )

[Yields]

Retrieves a list of Free Decals from the Catalog

Array

GetFreeModels ( string searchText , int pageNum )

[Yields]

Retrieves a list of Free Models from the Catalog

int64

GetLatestAssetVersionAsync ( int64 assetId )

[Yields]

Returns the latest AssetVersionId of an asset for assets created by the place creator.

Can be used in combination with LoadAssetVersion to load the latest version of a model, even if it gets updated while the game is running.

Array

GetUserCategories ( int64 userId )

[Yields] [Deprecated]
Array

GetUserSets ( int64 userId )

[Yields]

Returns an array of dictionaries, containing information about sets owned by the user.

void

Insert ( Instance instance )

[Deprecated]

Inserts Instance into Workspace

Instance

LoadAsset ( int64 assetId )

[Yields]

Returns a Model containing the asset

Instance

LoadAssetVersion ( int64 assetVersionId )

[Yields]

Returns a model inserted into InsertService containing the asset with the given assetVersionId.

Instance

loadAsset ( int64 assetId )

[Yields] [Deprecated]

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.

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

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 )

[DetectingPropertyChanges]

Fired immediately after a property of an object changes.

RBXScriptSignal

ChildAdded ( Instance child )

Fires when an object is parented to this Instance.

RBXScriptSignal

ChildRemoved ( Instance child )

Fires when a child is removed from this Instance.

RBXScriptSignal

DescendantAdded ( Instance descendant )

Fires when a descendant is added to the Instance

RBXScriptSignal

DescendantRemoving ( Instance descendant )

Fires immediately before a descendant of the Instance is removed.

RBXScriptSignal

childAdded ( Instance child )

[Deprecated]