Skip to main content

GameConfigAssetUtils

Functions​

create​

</>
GameConfigAssetUtils.create(
assetType: GameConfigAssetType,
assetKey: string,
assetId: number,
priority: number?
) → Instance

Creates a new game configuration

priority is only stamped when given; an asset without it reads back as GameConfigAssetConstants.DEFAULT_PRIORITY. Pass a higher value to win over hand-authored assets that share this type and key (see GameConfigPicker.FindFirstActiveAssetOfKey).

promiseCloudDataForAssetType​

</>
GameConfigAssetUtils.promiseCloudDataForAssetType(
serviceBag: ServiceBag,
assetType: GameConfigAssetType,
assetId: number
) → Promise<any>

Promises cloud data for a given asset type

Show raw api
{
    "functions": [
        {
            "name": "create",
            "desc": "Creates a new game configuration\n\n`priority` is only stamped when given; an asset without it reads back as\n[GameConfigAssetConstants.DEFAULT_PRIORITY]. Pass a higher value to win over\nhand-authored assets that share this type and key (see\n[GameConfigPicker.FindFirstActiveAssetOfKey]).",
            "params": [
                {
                    "name": "binder",
                    "desc": "",
                    "lua_type": "Binder<GameConfigAssetBase>"
                },
                {
                    "name": "assetType",
                    "desc": "",
                    "lua_type": "GameConfigAssetType"
                },
                {
                    "name": "assetKey",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "assetId",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "priority",
                    "desc": "",
                    "lua_type": "number?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 34,
                "path": "src/gameconfig/src/Shared/Config/Asset/GameConfigAssetUtils.lua"
            }
        },
        {
            "name": "promiseCloudDataForAssetType",
            "desc": "Promises cloud data for a given asset type",
            "params": [
                {
                    "name": "serviceBag",
                    "desc": "",
                    "lua_type": "ServiceBag"
                },
                {
                    "name": "assetType",
                    "desc": "",
                    "lua_type": "GameConfigAssetType"
                },
                {
                    "name": "assetId",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<any>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 63,
                "path": "src/gameconfig/src/Shared/Config/Asset/GameConfigAssetUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "GameConfigAssetUtils",
    "desc": "",
    "source": {
        "line": 5,
        "path": "src/gameconfig/src/Shared/Config/Asset/GameConfigAssetUtils.lua"
    }
}