AssetService¶
A non-replicated service that handles asset-related queries to the Roblox web API.
Description¶
AssetService is a non-replicated service that handles asset-related queries to the Roblox web API.
Inheritance¶
Object → Instance → AssetService
Nova inheritance: Instance → AssetService
Methods¶
CreatePlaceAsync Supported Function Clones a place through the given templatePlaceID.
Clones a place through the given templatePlaceID.
Clones a place through the given templatePlaceID and returns the
PlaceId of the new place, which you can use with
TeleportService. The clone place displays within the inventory of
the place's creator with the given name and description.
Note that the template place must have template copying enabled through place settings. You cannot use this method to clone places that you don't own.
Frequent use of this API is not recommended, particularly if the created places contain scripts, as updating the code in a large volume of places quickly becomes infeasible. For user-generated worlds, consider serializing user creations and saving them in DataStores instead.
Roblox reference signature
CreatePlaceInPlayerInventoryAsync Supported Function Deprecated Creates a place in a player's inventory. Requires the Nova platform backend.
AssetService:CreatePlaceInPlayerInventoryAsync(Instance player, string placeName, int templatePlaceID, string description =): int
Creates a place in a player's inventory. Requires the Nova platform backend.
Modern Roblox removed this method in release 471. Nova retains the 2016 implementation and calls the platform's place-creation endpoint; whether it succeeds depends on the Nova.Web deployment supporting that flow.
Roblox reference signature
GetAssetVersions Supported Function Given a placeID, this function will return a table with the version info of the place. An optional arg of page number can be used to page through all…
Given a placeID, this function will return a table with the version info of the place. An optional arg of page number can be used to page through all revisions (a single page may hold about 50 revisions).
GetCreatorAssetID Supported Function Deprecated Returns the UserId of the account who created the creationID asset.
Returns the UserId of the account who created the creationID asset.
The GetCreatorAssetID function returns the Player.UserId of the account who created the creationID asset.
This member is broken and doesn't function correctly. Avoid using it.
GetGamePlacesAsync Supported Function Returns a StandardPages object which contains the name and PlaceId of places within the current experience.
Returns a StandardPages object which contains the name and PlaceId of places within the current experience.
GetPlacePermissions Supported Function Given a placeID, this function will return a table with the permissions of the place. Useful for determining what kind of permissions a particular us…
Given a placeID, this function will return a table with the permissions of the place. Useful for determining what kind of permissions a particular user may have for a place.
RevertAsset Supported Function Reverts a given place id to the version number provided. Returns true if successful on reverting, false otherwise.
Reverts a given place id to the version number provided. Returns true if successful on reverting, false otherwise.
SavePlaceAsync Supported Function Saves the state of the current place.
Saves the state of the current place.
Saves the current state of the place. Keep in mind the following guidelines and restrictions:
- This method only works for places that are created with AssetService.CreatePlaceAsync() or that have the API enabled through the place's settings.
- This method overwrites the previous state of the place. To revert a save, publish an older version of the place.
- There are cases when saves can occur simultaneously in Studio and in multiple experience servers. The order of the saves happen in the order they are called.
- An active Team Create session in Studio blocks all saves from occurring.
SetAssetRevertUrl Supported Function
No description available.
LocalUserSecuritySetAssetVersionsUrl Supported Function
No description available.
LocalUserSecuritySetPlaceAccessUrl Supported Function
No description available.
LocalUserSecuritySetPlacePermissions Supported Function Sets the permissions for a placeID to the place accessType. An optional table (inviteList) can be included that will set the accessType for only the…
AssetService:SetPlacePermissions(int placeId, AccessType accessType = Everyone, Array inviteList = {}): bool
Sets the permissions for a placeID to the place accessType. An optional table (inviteList) can be included that will set the accessType for only the player names provided. The table should be set up as an array of usernames (strings).
Inherited members¶
Inherited from Instance: 8 properties, 36 methods, 7 events. They are documented on the base class page.
31 modern Roblox member(s) are not implemented yet — expand to inspect
Members declared by Roblox's AssetService class (or by a missing base class) that Nova does not expose. Use this list to scope a migration; the compatibility guide has the recommended workaround.
Properties¶
| Member | Signature | Status | Notes | Flags |
|---|---|---|---|---|
AllowInsertFreeAssets |
AllowInsertFreeAssets: bool |
Not yet | Controls whether AssetService.LoadAssetAsync() can load assets that are not owned by the experience creator. | RobloxScriptSecurity |
Methods¶
| Member | Signature | Status | Notes | Flags |
|---|---|---|---|---|
CachePartOperationsAsync |
AssetService:CachePartOperationsAsync(partOperations: Array): null |
Not yet | — | Yields, RobloxScriptSecurity |
CanEditAssetAsync |
AssetService:CanEditAssetAsync(content: Content): bool |
Not yet | — | Yields, RobloxScriptSecurity |
ComposeDecalAsync |
AssetService:ComposeDecalAsync(decal: Decal, layers: Array): null |
Not yet | 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… |
Yields |
CreateAssetAsync |
AssetService:CreateAssetAsync(object: Object, assetType: AssetType, requestParameters: Dictionary = nil): Tuple |
Not yet | Uploads a new asset to Roblox from the given object. | Yields |
CreateAssetVersionAsync |
AssetService:CreateAssetVersionAsync(object: Object, assetType: AssetType, assetId: int64, requestParameters: Dictionary = nil): Tuple |
Not yet | Uploads a new version for an existing asset from the given object. | Yields |
CreateDataModelContentAsync |
AssetService:CreateDataModelContentAsync(content: Content, options: Dictionary?): Tuple |
Not yet | Creates ephemeral, DataModel-scoped content from the provided content input. | Yields |
CreateDecalAsync |
AssetService:CreateDecalAsync(content: Dictionary): Decal |
Not yet | Creates a new Decal object using the provided EditableImage content maps. | Yields |
CreateEditableImage |
AssetService:CreateEditableImage(editableImageOptions: Dictionary?): EditableImage |
Not yet | Creates a new EditableImage. | — |
CreateEditableImageAsync |
AssetService:CreateEditableImageAsync(content: Content, editableImageOptions: Dictionary?): EditableImage |
Not yet | Creates a new EditableImage object populated with the given image. | Yields |
CreateEditableImageFromDownloadAsync |
AssetService:CreateEditableImageFromDownloadAsync(url: string): EditableImage |
Not yet | — | Yields, RobloxScriptSecurity |
CreateEditableMesh |
AssetService:CreateEditableMesh(editableMeshOptions: Dictionary?): EditableMesh |
Not yet | Creates a new, empty EditableMesh. | — |
CreateEditableMeshAsync |
AssetService:CreateEditableMeshAsync(content: Content, editableMeshOptions: Dictionary?): EditableMesh |
Not yet | Returns a new EditableMesh object created from an existing mesh content ID. | Yields |
CreateMeshPartAsync |
AssetService:CreateMeshPartAsync(meshContent: Content, options: Dictionary = nil): MeshPart |
Not yet | Creates a new MeshPart with a specified mesh ID and an optional table of fidelity values. | Yields |
CreateSurfaceAppearanceAsync |
AssetService:CreateSurfaceAppearanceAsync(content: Dictionary): SurfaceAppearance |
Not yet | Creates a new SurfaceAppearance object using the provided content maps. | Yields |
CreateTextureAsync |
AssetService:CreateTextureAsync(content: Dictionary): Texture |
Not yet | — | Yields |
DeserializeInstance |
AssetService:DeserializeInstance(serializedInstance: string): Instance |
Not yet | — | RobloxScriptSecurity |
GetAssetIdsForPackage |
AssetService:GetAssetIdsForPackage(packageAssetId: int64): Array |
Not yet | Returns an array of asset IDs that are contained in a specified package. | Yields, PreferredDescriptorName, ThreadSafety, PreferredDes… |
GetAssetIdsForPackageAsync |
AssetService:GetAssetIdsForPackageAsync(packageAssetId: int64): Array |
Not yet | Returns an array of asset IDs that are contained in a specified package. | Yields |
GetAudioMetadataAsync |
AssetService:GetAudioMetadataAsync(idList: Array): Array |
Not yet | Provides relevant metadata about a specific audio source. | Yields |
GetBundleDetailsAsync |
AssetService:GetBundleDetailsAsync(bundleId: int64): Dictionary |
Not yet | Returns details of the contents of specified bundle. | Yields |
GetOpaqueContentMetadataMap |
AssetService:GetOpaqueContentMetadataMap(opaqueContent: Content): Dictionary |
Not yet | — | RobloxScriptSecurity |
LoadAssetAsync |
AssetService:LoadAssetAsync(assetId: int64): Instance |
Not yet | Loads a Model instance given its asset ID. This is the modern replacement for InsertService.LoadAsset() and supports loading th… | Yields |
PromptCreatePlatformContentAsync |
AssetService:PromptCreatePlatformContentAsync(player: Player, object: Object, assetType: AssetType): Tuple |
Not yet | Allows in-experience asset creation for users by prompting a publish dialog. | Yields |
PromptImportAnimationClipFromVideoAsync |
AssetService:PromptImportAnimationClipFromVideoAsync(player: Player, progressCallback: Function): Tuple |
Not yet | Prompts the specified player to select and upload a video, which is then converted into an AnimationClip. | Yields |
SearchAudio |
AssetService:SearchAudio(searchParameters: AudioSearchParams): AudioPages |
Not yet | Finds audio assets matching a variety of search criteria. | Yields, PreferredDescriptorName, ThreadSafety, PreferredDes… |
SearchAudioAsync |
AssetService:SearchAudioAsync(searchParameters: AudioSearchParams): AudioPages |
Not yet | Finds audio assets matching a variety of search criteria. | Yields |
Events¶
| Member | Signature | Status | Notes | Flags |
|---|---|---|---|---|
AudioMetadataFailedResponse |
AudioMetadataFailedResponse(requestid: int64) |
Not yet | — | RobloxScriptSecurity |
AudioMetadataRequest |
AudioMetadataRequest(requestid: int64, request: Array) |
Not yet | — | RobloxScriptSecurity |
AudioMetadataResponse |
AudioMetadataResponse(requestid: int64, response: Array) |
Not yet | — | RobloxScriptSecurity |
OpenPublishResultModal |
OpenPublishResultModal(resultType: PromptCreatePlatformContentResult) |
Not yet | — | RobloxScriptSecurity |
Roblox reference: AssetService
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.