Skip to main content

AssetServiceUtils

Utility methods involving the AssetService

Types​

BundleDetailsItem​

</>
interface BundleDetailsItem {
Id: number--

Item's id

Name: string--

Item name

Type: string--

Item Type eg: "UserOutfit" or "Asset"

}

Details for a specific bundle item

BundleDetails​

</>
interface BundleDetails {
Id: number--

Bundle Id (passed in as an argument)

Name: string--

Bundle name

Description: string--

Bundle description

BundleType: string--

Bundle Type. eg. BodyParts or AvatarAnimation|AvatarAnimations

Items: {BundleDetailsItem}--

An array of ValueTable objects

}

Details for the bundle

Functions​

promiseAssetIdsForPackage​

</>
AssetServiceUtils.promiseAssetIdsForPackage(packageAssetId: number) → Promise<table>

Retrieves the assetIds for a package

promiseGamePlaces​

</>
AssetServiceUtils.promiseGamePlaces() → Pages

Gets the places and their name for the current game.

promiseBundleDetails​

</>
AssetServiceUtils.promiseBundleDetails(bundleId: number) → BundleDetails

Gets the bundle details

Show raw api
{
    "functions": [
        {
            "name": "promiseAssetIdsForPackage",
            "desc": "Retrieves the assetIds for a package",
            "params": [
                {
                    "name": "packageAssetId",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<table>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 20,
                "path": "src/assetserviceutils/src/Shared/AssetServiceUtils.lua"
            }
        },
        {
            "name": "promiseGamePlaces",
            "desc": "Gets the places and their name for the current game.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Pages"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 46,
                "path": "src/assetserviceutils/src/Shared/AssetServiceUtils.lua"
            }
        },
        {
            "name": "promiseBundleDetails",
            "desc": "Gets the bundle details",
            "params": [
                {
                    "name": "bundleId",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "BundleDetails"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 93,
                "path": "src/assetserviceutils/src/Shared/AssetServiceUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [
        {
            "name": "BundleDetailsItem",
            "desc": "Details for a specific bundle item",
            "fields": [
                {
                    "name": "Id",
                    "lua_type": "number",
                    "desc": "Item's id"
                },
                {
                    "name": "Name",
                    "lua_type": "string",
                    "desc": "Item name"
                },
                {
                    "name": "Type",
                    "lua_type": "string",
                    "desc": "Item Type eg: \"UserOutfit\" or \"Asset\""
                }
            ],
            "source": {
                "line": 74,
                "path": "src/assetserviceutils/src/Shared/AssetServiceUtils.lua"
            }
        },
        {
            "name": "BundleDetails",
            "desc": "Details for the bundle",
            "fields": [
                {
                    "name": "Id",
                    "lua_type": "number",
                    "desc": "Bundle Id (passed in as an argument)"
                },
                {
                    "name": "Name",
                    "lua_type": "string",
                    "desc": "Bundle name"
                },
                {
                    "name": "Description",
                    "lua_type": "string",
                    "desc": "Bundle description"
                },
                {
                    "name": "BundleType",
                    "lua_type": "string",
                    "desc": "Bundle Type. eg. BodyParts or `AvatarAnimation|AvatarAnimations`"
                },
                {
                    "name": "Items",
                    "lua_type": "{ BundleDetailsItem }",
                    "desc": "An array of ValueTable objects"
                }
            ],
            "source": {
                "line": 86,
                "path": "src/assetserviceutils/src/Shared/AssetServiceUtils.lua"
            }
        }
    ],
    "name": "AssetServiceUtils",
    "desc": "Utility methods involving the AssetService",
    "source": {
        "line": 5,
        "path": "src/assetserviceutils/src/Shared/AssetServiceUtils.lua"
    }
}