AssetService

A non-replicated service that handles asset-related queries to the Roblox web API.

Memory category: Instances
Own members: 39
Inherited members: 75
Subclasses: 0
Siblings: 608

Properties24

Inherited fromObject2

Property categoryData

Object.ClassName: string
A read-only string representing the class this Object belongs to.
- Read only
Object.className: string
Deprecated: This deprecated property is a variant of Object.ClassName which should be used instead.
- Deprecated
- Read only
Use ClassName instead.

Inherited fromInstance21

Property categoryBehavior

Instance.Archivable: boolean
Determines if an Instance and its descendants can be cloned using Instance:Clone(), and can be saved/published.
Instance.archivable: boolean
Deprecated: This deprecated property is a variant of Instance.Archivable which should be used instead.
- Deprecated
- Hidden
- Not replicated
- Load only
Use Archivable instead.

Property categoryData

Instance.Attributes: string
- Hidden
- Not scriptable
- Read only
- Roblox engine security
Instance.AttributesReplicate: string
- Hidden
- Not scriptable
- Roblox engine security
Instance.AttributesSerialize: string
- Hidden
- Not replicated
- Not scriptable
- Roblox engine security
Instance.HistoryId: UniqueId
- Hidden
- Not replicated
- Not scriptable
- Roblox engine security
Instance.Name: string
A non-unique identifier of the Instance.
Instance.Parent: Instance
Determines the hierarchical parent of the Instance.
- Not replicated
- Load only
Instance.PredictionMode: Enum.PredictionMode
Reflects the client-side prediction mode applied to the instance under server-authoritative physics.
- Not scriptable
- Read only
Instance.PropertyStatusStudio: Enum.PropertyStatus
- Hidden
- Not scriptable
- Read only
- Roblox engine security
Instance.RobloxLocked: boolean
A deprecated property that used to protect CoreGui objects.
- Hidden
- Plugin security
Instance.SerializedOverrides: string
- Hidden
- Not replicated
- Not scriptable
- Roblox engine security
Instance.SourceAssetId: number
- Hidden
- Roblox script security
Instance.Tags: SharedString
- Hidden
- Not scriptable
- Roblox engine security
Instance.UniqueId: UniqueId
A unique identifier for the instance.
- Not replicated
- Read: Roblox script security
- Write: Roblox engine security
Instance.numExpectedDirectChildren: number
- Hidden
- Not scriptable
Instance.DataCost: number
- Deprecated
- Hidden
- Read only
- Local user security

Property categoryPermissions

Instance.Capabilities: SecurityCapabilities
The set of capabilities allowed to be used for scripts inside this container.
- Capabilities: CapabilityControl
Instance.DefinesCapabilities: boolean
- Hidden
- Not scriptable
- Roblox engine security
Instance.IsInSandbox: boolean
Indicates whether the instance is inside a sandboxed container.
- Not scriptable
- Read only
Instance.Sandboxed: boolean
When enabled, the instance can only access abilities in its Capabilities list.
- Not replicated
- Capabilities: CapabilityControl

Defined byAssetService1

Property categoryBehavior

AssetService.AllowInsertFreeAssets: boolean
Controls whether AssetService:LoadAssetAsync() can load assets that are not owned by the experience creator.
- Roblox script security

Methods76

Inherited fromObject3

Object:GetPropertyChangedSignal(property: string): RBXScriptSignal
Get an event that fires when a given property of the object changes.
Parameters
Parameter Description
property: string
The property to connect to.
Returns
Type Description
RBXScriptSignal
A signal that fires whenever the property changes.
Object:IsA(className: string): boolean
Returns true if an object's class matches or inherits from a given class.
- Custom Lua state
- Thread safe
Parameters
Parameter Description
className: string
The class against which the Object's class will be checked. Case-sensitive.
Returns
Type Description
boolean
Describes whether the Object's class matched or is a subclass of the given class.
Object:isA(className: string): boolean
Deprecated: This deprecated function is a variant of Object:IsA() which should be used instead.
- Deprecated
- Custom Lua state
Parameters
Parameter
className: string
Returns
Type
boolean
Use IsA instead.

Parameters
Parameter	Description
`property: string`	The property to connect to.

Returns
Type	Description
`RBXScriptSignal`	A signal that fires whenever the property changes.

Parameters
Parameter	Description
`className: string`	The class against which the Object's class will be checked. Case-sensitive.

Returns
Type	Description
`boolean`	Describes whether the Object's class matched or is a subclass of the given class.

Parameters
Parameter
`className: string`

Returns
Type
`boolean`

Inherited fromInstance39

Instance:AddTag(tag: string)
Applies a tag to the instance.
Parameters
Parameter Description
tag: string
The tag to apply to the instance.
Instance:ClearAllChildren()
This method destroys all of an instance's children.
Instance:Clone(): Instance
Create a copy of an instance and all its descendants, ignoring instances that are not Archivable.
- Capabilities: CreateInstances
- Simulation access
Returns
Type Description
Instance
A copy of the instance, or nil if the instance is not Archivable.
Instance:Destroy()
Sets the Instance.Parent property to nil, locks the Instance.Parent property, disconnects all connections, and calls Destroy() on all children.
Instance:FindFirstAncestor(name: string): Instance
Returns the first ancestor of the Instance whose Instance.Name is equal to the given name.
- Thread safe
Parameters
Parameter Description
name: string
The Instance.Name to be looked for.
Returns
Type Description
Instance
The Instance found.
Instance:FindFirstAncestorOfClass(className: string): Instance
Returns the first ancestor of the Instance whose Object.ClassName is equal to the given className.
- Thread safe
Parameters
Parameter Description
className: string
The Object.ClassName to be looked for.
Returns
Type Description
Instance
The Instance found.
Instance:FindFirstAncestorWhichIsA(className: string): Instance
Returns the first ancestor of the Instance for whom Object:IsA() returns true for the given className.
- Thread safe
Parameters
Parameter Description
className: string
The Object.ClassName to be looked for.
Returns
Type Description
Instance
The Instance found.
Instance:FindFirstChild(name: string, recursive: boolean? = false): Instance
Returns the first child of the Instance found with the given name.
- Thread safe
- Simulation access
Parameters
Parameter Description
name: string
The Instance.Name to be searched for.
recursive: boolean? = false
Whether or not the search should be conducted recursively.
Returns
Type Description
Instance
The Instance found.
Instance:FindFirstChildOfClass(className: string): Instance
Returns the first child of the Instance whose ClassName is equal to the given class name.
- Thread safe
Parameters
Parameter Description
className: string
The Object.ClassName to be looked for.
Returns
Type Description
Instance
The Instance found.
Instance:FindFirstChildWhichIsA(className: string,recursive: boolean? = false,): Instance
Returns the first child of the Instance for whom Object:IsA() returns true for the given className.
- Thread safe
- Simulation access
Parameters
Parameter Description
className: string
The Object.ClassName to be searched for.
recursive: boolean? = false
Whether or not the search should be conducted recursively.
Returns
Type Description
Instance
The Instance found.
Instance:FindFirstDescendant(name: string): Instance
Returns the first descendant found with the given Instance.Name.
- Thread safe
Parameters
Parameter Description
name: string
The Instance.Name to search for.
Returns
Type Description
Instance
The Instance found.
Instance:GetActor(): Actor
Returns the Actor associated with the Instance, if any.
- Thread safe
Returns
Type Description
Actor
The Actor found.
Instance:GetAttribute(attribute: string): any
Returns the value which has been assigned to the given attribute name.
- Thread safe
- Simulation access
Parameters
Parameter Description
attribute: string
The name of the attribute being retrieved.
Returns
Type Description
any
The value which has been assigned to the given attribute name. If no attribute has been assigned, nil is returned.
Instance:GetAttributeChangedSignal(attribute: string): RBXScriptSignal
Returns an event that fires when the given attribute changes.
Parameters
Parameter Description
attribute: string
The name of the specified attribute for which the change signal is being returned.
Returns
Type Description
RBXScriptSignal
An event that fires when the given attribute changes.
Instance:GetAttributes(): { [string]: any }
Returns a dictionary of the instance's attributes.
- Custom Lua state
- Thread safe
- Simulation access
Returns
Type Description
{ [string]: any }
A dictionary of string → variant pairs for each attribute where the string is the name of the attribute and the variant is a non-nil value.
Instance:GetChildren(): { Instance }
Returns an array containing all of the instance's children.
- Thread safe
- Simulation access
Returns
Type Description
{ Instance }
An array containing the instance's children.
Instance:GetDebugId(scopeLength: number? = 4): string
Returns a coded string of the debug ID used internally by Roblox.
- Not browsable
- Plugin security
Parameters
Parameter Description
scopeLength: number? = 4
The scope length.
Returns
Type Description
string
The Debug ID string.
Instance:GetDescendants(): { Instance }
Returns an array containing all of the descendants of the instance.
- Custom Lua state
- Thread safe
- Simulation access
Returns
Type Description
{ Instance }
An array containing the instance's descendants.
Instance:GetFullName(): string
Returns a string describing the instance's ancestry.
- Thread safe
- Simulation access
Returns
Type Description
string
The full name of the Instance.
Instance:GetStyled(name: string, selector: string?): any
Returns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified.
Parameters
Parameter Description
name: string
Name of the property to query.
selector: string?
Optional selector for the pseudo instance you are targeting on the instance.
Returns
Type Description
any
The styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified.
Instance:GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
Returns an event that fires when the given style property changes on the instance.
Parameters
Parameter Description
property: string
Name of the style property for which to listen for changes.
Returns
Type Description
RBXScriptSignal
Event that fires when the given style property changes.
Instance:GetTags(): { any }
Gets an array of all tags applied to the instance.
- Thread safe
- Simulation access
Returns
Type Description
{ any }
An array of strings, each representing a tag applied to the instance.
Instance:HasTag(tag: string): boolean
Check whether the instance has a given tag.
- Thread safe
- Simulation access
Parameters
Parameter Description
tag: string
The tag to check for on the instance.
Returns
Type Description
boolean
true if the instance has the given tag, false otherwise.
Instance:IsAncestorOf(descendant: Instance): boolean
Returns true if an Instance is an ancestor of the given descendant.
- Thread safe
- Simulation access
Parameters
Parameter Description
descendant: Instance
The descendant Instance.
Returns
Type Description
boolean
True if the Instance is an ancestor of the given descendant.
Instance:IsDescendantOf(ancestor: Instance): boolean
Returns true if an Instance is a descendant of the given ancestor.
- Thread safe
- Simulation access
Parameters
Parameter Description
ancestor: Instance
The ancestor Instance.
Returns
Type Description
boolean
True if the Instance is a descendant of the given ancestor.
Instance:IsPropertyModified(property: string): boolean
Returns true if the value stored in the specified property is not equal to the code-instantiated default.
- Simulation access
Parameters
Parameter Description
property: string
Name of the property to query.
Returns
Type Description
boolean
Boolean indicating whether the property is modified from its code‑instantiated default.
Instance:QueryDescendants(selector: string): { Instance }
Returns an array containing all descendants of the instance that match the selector string.
- Custom Lua state
- Simulation access
Parameters
Parameter Description
selector: string
Selector string used to filter elements.
Returns
Type Description
{ Instance }
An array of instances (empty if nothing matched the selector).
Instance:RemoveTag(tag: string)
Removes a tag from the instance.
Parameters
Parameter Description
tag: string
The tag to remove from the instance.
Instance:ResetPropertyToDefault(property: string)
Resets a property to its default value.
Parameters
Parameter Description
property: string
Name of the property to reset.
Instance:SetAttribute(attribute: string, value: any)
Sets the attribute with the given name to the given value.
- Simulation access
Parameters
Parameter Description
attribute: string
The name of the attribute being set.
value: any
The value to set the specified attribute to.
Instance:WaitForChild(childName: string, timeOut: number): Instance
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.
- Can yield
- Custom Lua state
Parameters
Parameter Description
childName: string
The Instance.Name to be looked for.
timeOut: number
An optional time out parameter.
Returns
Type Description
Instance
The Instance found.
Instance:Remove()
Deprecated: This item is deprecated in favor of Instance:Destroy() and Instance:ClearAllChildren(). If you must remove an object from the game, and wish to use the object later, set its Parent property to nil instead of using this method.
Sets the object's Parent to nil, and does the same for all its descendants.
- Deprecated
Instance:children(): { Instance }
Deprecated: This item has been superseded by Instance:GetChildren() which should be used in all new work.
Returns an array of the object's children.
- Deprecated
Returns
Type Description
{ Instance }
Array of child objects/instances.
Use GetChildren instead.
Instance:clone(): Instance
Deprecated: This deprecated function is a variant of Instance:Clone() which should be used instead.
- Deprecated
- Capabilities: CreateInstances
- Simulation access
Returns
Type
Instance
Use Clone instead.
Instance:destroy()
Deprecated: This deprecated function is a variant of Instance:Destroy() which should be used instead.
- Deprecated
Use Destroy instead.
Instance:findFirstChild(name: string, recursive: boolean? = false): Instance
Deprecated: This deprecated function is a variant of Instance:FindFirstChild() which should be used instead.
- Deprecated
- Simulation access
Parameters
Parameter
name: string
recursive: boolean? = false
Returns
Type
Instance
Use FindFirstChild instead.
Instance:getChildren(): { Instance }
Deprecated: This deprecated function is a variant of Instance:GetChildren() which should be used instead.
- Deprecated
Returns
Type
{ Instance }
Use GetChildren instead.
Instance:isDescendantOf(ancestor: Instance): boolean
Deprecated: This deprecated function is a variant of Instance:IsDescendantOf() which should be used instead.
- Deprecated
- Simulation access
Parameters
Parameter
ancestor: Instance
Returns
Type
boolean
Use IsDescendantOf instead.
Instance:remove()
Deprecated: This deprecated function is a variant of Instance:Remove() which has also been deprecated. Neither function should be used in new work.
- Deprecated
Use Remove instead.

Parameters
Parameter	Description
`tag: string`	The tag to apply to the instance.

Returns
Type	Description
`Instance`	A copy of the instance, or `nil` if the instance is not `Archivable`.

Parameters
Parameter	Description
`name: string`	The `Instance.Name` to be looked for.

Returns
Type	Description
`Instance`	The `Instance` found.

Parameters
Parameter	Description
`className: string`	The `Object.ClassName` to be looked for.

Returns
Type	Description
`Instance`	The `Instance` found.

Parameters
Parameter	Description
`className: string`	The `Object.ClassName` to be looked for.

Returns
Type	Description
`Instance`	The `Instance` found.

Parameters
Parameter	Description
`name: string`	The `Instance.Name` to be searched for.
`recursive: boolean? = false`	Whether or not the search should be conducted recursively.

Returns
Type	Description
`Instance`	The `Instance` found.

Parameters
Parameter	Description
`className: string`	The `Object.ClassName` to be looked for.

Returns
Type	Description
`Instance`	The `Instance` found.

Parameters
Parameter	Description
`className: string`	The `Object.ClassName` to be searched for.
`recursive: boolean? = false`	Whether or not the search should be conducted recursively.

Returns
Type	Description
`Instance`	The `Instance` found.

Parameters
Parameter	Description
`name: string`	The `Instance.Name` to search for.

Returns
Type	Description
`Instance`	The `Instance` found.

Returns
Type	Description
`Actor`	The `Actor` found.

Parameters
Parameter	Description
`attribute: string`	The name of the attribute being retrieved.

Returns
Type	Description
`any`	The value which has been assigned to the given attribute name. If no attribute has been assigned, `nil` is returned.

Parameters
Parameter	Description
`attribute: string`	The name of the specified attribute for which the change signal is being returned.

Returns
Type	Description
`RBXScriptSignal`	An event that fires when the given attribute changes.

Returns
Type	Description
`{ [string]: any }`	A dictionary of string → variant pairs for each attribute where the string is the name of the attribute and the variant is a non-nil value.

Returns
Type	Description
`{ Instance }`	An array containing the instance's children.

Parameters
Parameter	Description
`scopeLength: number? = 4`	The scope length.

Returns
Type	Description
`string`	The Debug ID string.

Returns
Type	Description
`{ Instance }`	An array containing the instance's descendants.

Returns
Type	Description
`string`	The full name of the `Instance`.

Parameters
Parameter	Description
`name: string`	Name of the property to query.
`selector: string?`	Optional selector for the pseudo instance you are targeting on the instance.

Returns
Type	Description
`any`	The styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified.

Parameters
Parameter	Description
`property: string`	Name of the style property for which to listen for changes.

Returns
Type	Description
`RBXScriptSignal`	Event that fires when the given style property changes.

Returns
Type	Description
`{ any }`	An array of strings, each representing a tag applied to the instance.

Parameters
Parameter	Description
`tag: string`	The tag to check for on the instance.

Returns
Type	Description
`boolean`	`true` if the instance has the given tag, `false` otherwise.

Parameters
Parameter	Description
`descendant: Instance`	The descendant `Instance`.

Returns
Type	Description
`boolean`	True if the `Instance` is an ancestor of the given descendant.

Parameters
Parameter	Description
`ancestor: Instance`	The ancestor `Instance`.

Returns
Type	Description
`boolean`	True if the `Instance` is a descendant of the given ancestor.

Parameters
Parameter	Description
`property: string`	Name of the property to query.

Returns
Type	Description
`boolean`	Boolean indicating whether the property is modified from its code‑instantiated default.

Parameters
Parameter	Description
`selector: string`	Selector string used to filter elements.

Returns
Type	Description
`{ Instance }`	An array of instances (empty if nothing matched the selector).

Parameters
Parameter	Description
`tag: string`	The tag to remove from the instance.

Parameters
Parameter	Description
`property: string`	Name of the property to reset.

Defined byAssetService34

AssetService:CachePartOperationsAsync(partOperations: { any })
- Yields
- Roblox script security
Parameters
Parameter
partOperations: { any }
AssetService:CanEditAssetAsync(content: Content): boolean
- Yields
- Roblox script security
Parameters
Parameter
content: Content
Returns
Type
boolean

AssetService:ComposeDecalAsync(decal: Decal, layers: { any })

Modifies an existing Decal to contain a composite PBR textures created by layering the provided textures in the order they are provided in the layers array. Textures layer based on the alpha value of the color map.

Parameters
Parameter	Description
`decal: Decal`	A `Decal` instance that will be modified to contain a representation of the layers. Any existing maps on this instance will be cleared.
`layers: { any }`	An array of dictionary tables that maps PBR names to `Content` IDs.

AssetService:CreateAssetAsync(object: Object,assetType: Enum.AssetType,requestParameters: { [string]: any }? = nil,): ...any

Uploads a new asset to Roblox from the given object.

Parameters
Parameter	Description
`object: Object`	The object to be created as an asset.
`assetType: Enum.AssetType`	Currently supported types are: `AssetType.Model` – with `object` as any valid `Instance` root. `AssetType.Plugin` – with `object` as any valid `Instance` root. `AssetType.Mesh` – with `object` as any valid `EditableMesh` root. `AssetType.Image` – with `object` as any valid `EditableImage` root.
`requestParameters: { [string]: any }? = nil`	Options table containing asset metadata: `Name` – Name of the asset as a string. Defaults to `[object.Name]`. `Description` – Description of the asset as a string. Defaults to `"Created with AssetService:CreateAssetAsync"`. `CreatorId` – ID of the asset creator as a number. Defaults to the logged in Roblox Studio user for Plugin context. Required for Open Cloud Luau Execution context. `CreatorType` – `AssetCreatorType` indicating the type of asset creator. Defaults to `AssetCreatorType.User` in Plugin context. Required for Open Cloud Luau Execution context. `IsPackage` – Boolean value, only applicable to the `AssetType.Model` type. Defaults to `true`.

Returns
Type	Description
`...any`	The `CreateAssetResult` and asset ID pair if successful.

AssetService:CreateAssetVersionAsync(object: Object,assetType: Enum.AssetType,assetId: number,requestParameters: { [string]: any }? = nil,): ...any

Uploads a new version for an existing asset from the given object.

Parameters
Parameter	Description
`object: Object`	The object to be created as an asset.
`assetType: Enum.AssetType`	Currently supported types are: `AssetType.Model` – with `object` as any valid `Instance` root. `AssetType.Plugin` – with `object` as any valid `Instance` root. `AssetType.Mesh` – with `object` as any valid `EditableMesh` root. `AssetType.Image` – with `object` as any valid `EditableImage` root.
`assetId: number`	The ID of the asset for the new version.
`requestParameters: { [string]: any }? = nil`	Options table containing asset metadata: `Name` – A `string`. Name of the asset. Default: object.Name. `Description` – A `string`. Description of the asset. Default: "Created with AssetService:CreateAssetAsync". `CreatorId` – A `number`. ID of the asset creator. Default: The logged in Roblox Studio user for Plugin context. Required for Open Cloud Luau Execution context. `CreatorType` – A `AssetCreatorType`. Type of asset creator. Default: `AssetCreatorType.User` in Plugin context. Required for Open Cloud Luau Execution context. `IsPackage` – A `bool`. Only applicable to the `AssetType.Model` type. Default: true.

Returns
Type	Description
`...any`	The `CreateAssetResult` and asset version number pair if successful.

AssetService:CreateDataModelContentAsync(content: Content,options: { [string]: any }?,): ...any

Creates ephemeral, DataModel-scoped content from the provided content input.

Parameters
Parameter	Description
`content: Content`	Reference to the input content. Currently, this only supports `Content` wrapping a `EditableMesh` or `EditableImage`.
`options: { [string]: any }?`	Optional dictionary containing configuration controls for the created `DataModel` content. Currently no controls are surfaced and this parameter exists for future functionality.

Returns
Type	Description
`...any`	A tuple containing an `CreateContentResult` indicating the success or failure of the request, and the resulting `DataModel`-scoped `OpaqueContent`.

AssetService:CreateDecalAsync(content: { [string]: any }): Decal

Creates a new Decal object using the provided EditableImage content maps.

Parameters
Parameter	Description
`content: { [string]: any }`	Dictionary containing one or more of the following key-value pairs. Each value must be a `Content` object containing a `EditableImage`: `TextureContent` — The decal's color texture. `NormalMapContent` — The decal's normal map. `MetalnessMapContent` — The decal's metalness map. `RoughnessMapContent` — The decal's roughness map.

Returns
Type	Description
`Decal`	A new `Decal` instance with the given maps from the `content` parameter.

AssetService:CreateEditableImage(editableImageOptions: { [string]: any }?): EditableImage
Creates a new EditableImage.
- Capabilities: DynamicGeneration
Parameters
Parameter Description
editableImageOptions: { [string]: any }?
Options table containing controls for the method:
Size – A Vector2 that specifies the image's desired width and height.
Returns
Type Description
EditableImage
The new EditableImage, or nil if the device-specific editable memory budget is exhausted.

AssetService:CreateEditableImageAsync(content: Content,editableImageOptions: { [string]: any }?,): EditableImage

Creates a new EditableImage object populated with the given image.

Parameters
Parameter	Description
`content: Content`	Reference to asset content stored externally or as an object within the place, wrapping a single value of one of the supported `ContentSourceType` values.
`editableImageOptions: { [string]: any }?`	Table containing options for the created `EditableImage`. Currently no options are available since resizing via `Size` is not supported.

Returns
Type	Description
`EditableImage`	A new `EditableImage` containing the provided image.

AssetService:CreateEditableImageFromDownloadAsync(url: string): EditableImage
- Yields
- Roblox script security
Parameters
Parameter
url: string
Returns
Type
EditableImage

AssetService:CreateEditableMesh(editableMeshOptions: { [string]: any }?): EditableMesh

Creates a new, empty EditableMesh.

Parameters
Parameter	Description
`editableMeshOptions: { [string]: any }?`	Table containing options for the created `EditableMesh`. Currently no options are available since `FixedSize` will always be `false` for empty editable meshes.

Returns
Type	Description
`EditableMesh`	The new `EditableMesh`, or `nil` if the device-specific editable memory budget is exhausted.

AssetService:CreateEditableMeshAsync(content: Content,editableMeshOptions: { [string]: any }?,): EditableMesh

Returns a new EditableMesh object created from an existing mesh content ID.

Parameters
Parameter	Description
`content: Content`	Reference to asset content stored externally or as an object within the place, wrapping a single value of one of the supported `ContentSourceType` values.
`editableMeshOptions: { [string]: any }?`	Options table containing controls for the method: `FixedSize` – A `bool`. Default value is `true`, and the returned `EditableMesh` will not allow you to add or remove vertices, only modify their values. Set to `false` if the ability to change the mesh topology is required, at the expense of using more memory.

Returns
Type	Description
`EditableMesh`	The new `EditableMesh` object.

AssetService:CreateMeshPartAsync(meshContent: Content,options: { [string]: any }? = nil,): MeshPart

Creates a new MeshPart with a specified mesh ID and an optional table of fidelity values.

Parameters
Parameter	Description
`meshContent: Content`	Reference to asset content stored externally or as an object within the place, wrapping a single value of one of the supported `ContentSourceType` values.
`options: { [string]: any }? = nil`	Options table containing one or more controls for the method: `CollisionFidelity` – The value of `CollisionFidelity` in the resulting part. Defaults to `CollisionFidelity.Default` if the option is absent or the `options` table is `nil`. `RenderFidelity` – The value of `RenderFidelity` in the resulting part. Defaults to `RenderFidelity.Automatic` if the option is absent or the `options` table is `nil`. `FluidFidelity` – The value of `FluidFidelity` in the resulting part. Defaults to `FluidFidelity.Automatic` if the option is absent or the `options` table is `nil`.

Returns
Type	Description
`MeshPart`	The new `MeshPart` with the specified mesh and fidelity settings applied.

AssetService:CreatePlaceAsync(placeName: string,templatePlaceID: number,description: string? = "",): number
Clones a place through the given templatePlaceID.
- Yields
- Capabilities: AssetCreateUpdate
Parameters
Parameter Description
placeName: string
Name of the new place.
templatePlaceID: number
PlaceId of the place to clone.
description: string? = ""
Description of the new place.
Returns
Type Description
number
PlaceId of the new place.

AssetService:CreatePlaceInPlayerInventoryAsync(player: Instance,placeName: string,templatePlaceID: number,description: string? = "",): number

Clones a place through the given templatePlaceID and puts it into the inventory of the given player.

Parameters
Parameter	Description
`player: Instance`	The `Player` whose inventory receives the cloned place.
`placeName: string`	Name for the new place.
`templatePlaceID: number`	`PlaceId` of the place to clone.
`description: string? = ""`	Description for the new place.

Returns
Type	Description
`number`	`PlaceId` of the new place.

AssetService:CreateSurfaceAppearanceAsync(content: { [string]: any }): SurfaceAppearance

Creates a new SurfaceAppearance object using the provided content maps.

Parameters
Parameter	Description
`content: { [string]: any }`	Dictionary containing the following key-value pairs: `ColorMap` — A `Content` object that contains the color map. Default is `nil`. `MetalnessMap` — A `Content` object that contains the metalness map. If more than one channel is present, only the red channel is used. Default is `nil`. `NormalMap` — A `Content` object that contains the normal map. Default is `nil`. `RoughnessMap` — A `Content` object that contains the roughness map. If more than one channel is present, only the red channel is used. Default is `nil`. `EmissiveMask` — A `Content` object that contains the emissive mask. If more than one channel is present, only the red channel is used. Default is `nil`.

Returns
Type	Description
`SurfaceAppearance`	A new `SurfaceAppearance` instance with the given maps from the `content` parameter.

AssetService:CreateTextContentAsync(text: string): Content
- Yields
- Roblox script security
Parameters
Parameter
text: string
Returns
Type
Content
AssetService:CreateTextureAsync(content: { [string]: any }): Texture
- Yields
- Capabilities: Basic
Parameters
Parameter
content: { [string]: any }
Returns
Type
Texture
AssetService:DeserializeInstance(serializedInstance: string): Instance
- Roblox script security
Parameters
Parameter
serializedInstance: string
Returns
Type
Instance
AssetService:FetchAssetWithFormat(url: string,assetFormat: string,options: { [string]: any }?,): { Instance }
- Yields
- Roblox script security
Parameters
Parameter
url: string
assetFormat: string
options: { [string]: any }?
Returns
Type
{ Instance }
AssetService:GetAssetIdsForPackageAsync(packageAssetId: number): { any }
Returns an array of asset IDs that are contained in a specified package.
- Yields
- Capabilities: AssetRead
Parameters
Parameter Description
packageAssetId: number
The asset ID of the package to query.
Returns
Type Description
{ any }
Asset IDs that are contained in a specified package.

AssetService:GetAudioMetadataAsync(idList: { any }): { any }

Provides relevant metadata about a specific audio source.

Parameters
Parameter	Description
`idList: { any }`	Array of asset or content IDs for which to retrieve metadata. Max batch size is 30.

Returns
Type	Description
`{ any }`	Array of dictionary tables in the same order as the request, where each dictionary contains the following metadata for its asset/content: `AssetId` (string) `Title` (string) `Artist` (string) `Duration` (number) in seconds `AudioType` (`AudioSubType`) Note that if an error occurs on fetching metadata for any of the requested assets, for example the asset ID doesn't exist, its dictionary table is still included in the returned array but it only contains the `AssetId` field for reference purposes. Additionally, if the `AudioType` cannot be determined for a given asset (perhaps because it's private audio), the resulting dictionary will not contain an `AudioType` entry.

AssetService:GetBundleDetailsAsync(bundleId: number): { [string]: any }

Returns details of the contents of specified bundle.

Parameters
Parameter	Description
`bundleId: number`	The ID of the specified bundle.

Returns
Type	Description
`{ [string]: any }`	Dictionary with the following key-value pairs containing details about the specified bundle: `Id` — Bundle ID (same as passed `bundleId` argument) `Name` — Bundle name `Description` — Bundle description `BundleType` — String representing the `BundleType`, for example `"BodyParts"` or `"DynamicHead"` `Items` — Array of items in the bundle, each with details represented through the following keys: `Id` — Item ID `Name` — Item name `Type` — Item type such as `"Asset"` `AssetType` — String representing the `AvatarAssetType` `SupportsHeadShapes` — Whether the asset supports head shape swapping. Only present if `AssetType` is `"DynamicHead"`.

AssetService:GetGamePlacesAsync(): Instance
Returns a StandardPages object which contains the name and PlaceId of places within the current experience.
- Yields
- Capabilities: AssetRead
Returns
Type Description
Instance
A StandardPages object whose pages contain the name and PlaceId of each place in the current experience.
AssetService:GetOpaqueContentMetadataMap(opaqueContent: Content): { [string]: any }
- Roblox script security
Parameters
Parameter
opaqueContent: Content
Returns
Type
{ [string]: any }
AssetService:LoadAssetAsync(assetId: number): Instance
Loads a Model instance given its asset ID. This is the modern replacement for InsertService:LoadAsset() and supports loading third-party assets.
- Yields
- Capabilities: LoadUnownedAsset
Parameters
Parameter Description
assetId: number
The asset ID number of the asset being loaded.
Returns
Type Description
Instance
A Model instance containing the loaded asset.

AssetService:PromptCreatePlatformContentAsync(player: Player,object: Object,assetType: Enum.AssetType,): ...any

Allows in-experience asset creation for users by prompting a publish dialog.

Parameters
Parameter	Description
`player: Player`	The user who submits an asset creation.
`object: Object`	The asset to be created. Currently can't contain scripts or nest non-public assets.
`assetType: Enum.AssetType`	The asset type. Currently can only be `AssetType.Model`.

Returns
Type	Description
`...any`	The `PromptCreatePlatformContentResult` and asset ID pair if successful.

AssetService:PromptImportAnimationClipFromVideoAsync(player: Player,progressCallback: (...any) -> ...any,): ...any

Prompts the specified player to select and upload a video, which is then converted into an AnimationClip.

Parameters
Parameter	Description
`player: Player`	The player who is prompted, on their own client, to select and upload a video. The player's consent is required before the video is uploaded.
`progressCallback: (...any) -> ...any`	A function that receives status updates (an `AnimationClipFromVideoStatus` value) while the video is uploaded and processed.

Returns
Type	Description
`...any`	A tuple containing an `AnimationClipFromVideoStatus` describing the outcome and, on success, the resulting `AnimationClip` (`nil` otherwise).

AssetService:ReadTextContentAsync(content: Content): string
- Yields
- Roblox script security
Parameters
Parameter
content: Content
Returns
Type
string

AssetService:SavePlaceAsync(requestParameters: { [string]: any }?)

Saves the state of the current place.

Parameters
Parameter	Description
`requestParameters: { [string]: any }?`	Optional dictionary that includes `SaveWithoutPublish`, a boolean indicating whether to save with publish or without publish, and `PlaceId`, the destination place ID to save over. An example usage would be: AssetService:SavePlaceAsync({PlaceId = 1, SaveWithoutPublish = true}). If PlaceId is not provided, the default behavior will save over the current original place which is calling SavePlaceAsync. If SaveWithoutPublish is not provided, the default behavior is SaveWithoutPublish=false.

AssetService:SearchAudioAsync(searchParameters: AudioSearchParams): AudioPages
Finds audio assets matching a variety of search criteria.
- Yields
- Capabilities: AssetRead
Parameters
Parameter Description
searchParameters: AudioSearchParams
A AudioSearchParams object defining the search criteria such as keyword, title, artist, audio type, and duration range.
Returns
Type Description
AudioPages
An AudioPages object containing the paginated results of the audio search.
AssetService:GetAssetIdsForPackage(packageAssetId: number): { any }
Deprecated: Use GetAssetIdsForPackageAsync() instead.
Returns an array of asset IDs that are contained in a specified package.
- Deprecated
- Yields
- Capabilities: AssetRead
Parameters
Parameter Description
packageAssetId: number
The asset ID of the package to query.
Returns
Type Description
{ any }
Asset IDs that are contained in a specified package.
Use GetAssetIdsForPackageAsync instead.
AssetService:GetCreatorAssetID(creationID: number): number
Deprecated: This item is deprecated and no longer functions correctly. Do not use it for new work.
Returns the UserId of the account who created the creationID asset.
- Deprecated
- Yields
- Capabilities: AssetRead
Parameters
Parameter Description
creationID: number
The asset ID to look up for creator information.
Returns
Type Description
number
The Player.UserId of the account that created the asset.
Use GetProductInfo instead.
AssetService:SearchAudio(searchParameters: AudioSearchParams): AudioPages
Deprecated: Use SearchAudioAsync() instead.
Finds audio assets matching a variety of search criteria.
- Deprecated
- Yields
- Capabilities: AssetRead
Parameters
Parameter Description
searchParameters: AudioSearchParams
A AudioSearchParams object defining the search criteria such as keyword, title, artist, audio type, and duration range.
Returns
Type Description
AudioPages
An AudioPages object containing the paginated results of the audio search.
Use SearchAudioAsync instead.

Events14

Inherited fromObject1

Object.Changed: RBXScriptSignal<(property: string)>
Fires immediately after a property of the object changes, with some limitations.
Parameters
Parameter
property: string

Inherited fromInstance9

Instance.AncestryChanged: RBXScriptSignal<(child: Instance, parent: Instance)>
Fires when the Instance.Parent property of this object or one of its ancestors is changed.
Parameters
Parameter
child: Instance
parent: Instance
Instance.AttributeChanged: RBXScriptSignal<(attribute: string)>
Fires whenever an attribute is changed on the Instance.
Parameters
Parameter
attribute: string
Instance.ChildAdded: RBXScriptSignal<(child: Instance)>
Fires after an object is parented to this Instance.
Parameters
Parameter
child: Instance
Instance.ChildRemoved: RBXScriptSignal<(child: Instance)>
Fires after a child is removed from this Instance.
Parameters
Parameter
child: Instance
Instance.DescendantAdded: RBXScriptSignal<(descendant: Instance)>
Fires after a descendant is added to the Instance.
Parameters
Parameter
descendant: Instance
Instance.DescendantRemoving: RBXScriptSignal<(descendant: Instance)>
Fires immediately before a descendant of the Instance is removed.
Parameters
Parameter
descendant: Instance
Instance.Destroying: RBXScriptSignal<()>
Fires immediately before (or is deferred until after) the instance is destroyed via Instance:Destroy().
Instance.StyledPropertiesChanged: RBXScriptSignal<()>
Fires whenever any style property is changed on the instance, including when a property is set to nil.
Instance.childAdded: RBXScriptSignal<(child: Instance)>
Deprecated: This deprecated event is a variant of Instance.ChildAdded which should be used instead.
- Deprecated
Parameters
Parameter
child: Instance
Use ChildAdded instead.

Defined byAssetService4

AssetService.AudioMetadataFailedResponse: RBXScriptSignal<(requestid: number)>
- Roblox script security
Parameters
Parameter
requestid: number
AssetService.AudioMetadataRequest: RBXScriptSignal<(requestid: number,request: { any },)>
- Roblox script security
Parameters
Parameter
requestid: number
request: { any }
AssetService.AudioMetadataResponse: RBXScriptSignal<(requestid: number,response: { any },)>
- Roblox script security
Parameters
Parameter
requestid: number
response: { any }
AssetService.OpenPublishResultModal: RBXScriptSignal<(resultType: Enum.PromptCreatePlatformContentResult)>
- Roblox script security
Parameters
Parameter
resultType: Enum.PromptCreatePlatformContentResult