Skip to main content

GameConfigPicker

Provides an interface to query game configurations from assets in the world.

Functions​

new​

</>
GameConfigPicker.new(
serviceBag: ServiceBag,
gameConfigBinder: Binder<GameConfig>,
gameConfigAssetBinder: Binder<GameConfigAsset>
) → GameConfigPicker

Constructs a new game config picker. Should be gotten by GameConfigService.

ObserveActiveAssetOfTypeBrio​

</>
GameConfigPicker.ObserveActiveAssetOfTypeBrio(
assetType: string
) → Observable<Brio<GameConfigAssetBase>>

Observes active assets of a given type. Great for badge views or other things.

ObserveActiveAssetOfAssetTypeAndKeyBrio​

</>
GameConfigPicker.ObserveActiveAssetOfAssetTypeAndKeyBrio(
assetType: string,
assetKey: string
) → Observable<Brio<GameConfigAssetBase>>

Observes all active assets of a type and key.

maid:GiveTask(picker:ObserveActiveAssetOfAssetTypeAndKeyBrio(GameConfigAssetType.BADGE, "myBadge")
	:Pipe({
		RxStateStackUtils.topOfStack();
	}):Subscribe(function(activeBadge)
		print(activeBadge:GetId())
	end))

ObserveActiveAssetOfAssetTypeAndIdBrio​

</>
GameConfigPicker.ObserveActiveAssetOfAssetTypeAndIdBrio(
assetType: string,
assetId: number
) → Observable<Brio<GameConfigAssetBase>>

Observes all active assets of a type and an id.

ObserveActiveAssetOfAssetIdBrio​

</>
GameConfigPicker.ObserveActiveAssetOfAssetIdBrio(
assetId: number
) → Observable<Brio<GameConfigAssetBase>>

Observes all active assets of an id

ObserveActiveAssetOfKeyBrio​

</>
GameConfigPicker.ObserveActiveAssetOfKeyBrio(
assetKey: string
) → Observable<Brio<GameConfigAssetBase>>

Observes all active assets of a key

ObserveActiveConfigsBrio​

</>
GameConfigPicker.ObserveActiveConfigsBrio(self: GameConfigPicker) → Observable<Brio<GameConfigAssetBase>>

Observes all active active assets

GetActiveConfigs​

</>
GameConfigPicker.GetActiveConfigs(self: GameConfigPicker) → {GameConfigAssetBase}

Gets all active configs that exist

FindFirstActiveAssetOfId​

</>
GameConfigPicker.FindFirstActiveAssetOfId(
assetType: string,
assetId: number
) → GameConfigAssetBase?

Find the first asset of a given id

PromisePriceInRobux​

</>
GameConfigPicker.PromisePriceInRobux(
assetType: string,
assetIdOrKey: string | number
) → Promise<number>

Find the first asset of a given key

FindFirstActiveAssetOfKey​

</>
GameConfigPicker.FindFirstActiveAssetOfKey(
assetType: GameConfigAssetTypes.GameConfigAssetType,
assetKey: string
) → GameConfigAssetBase?

Find the active asset of a given type and key.

When several active assets share the type and key, the one with the highest GameConfigAssetBase.GetPriority wins; equal priorities keep the first iterated (so a lone hand-authored asset resolves exactly as before, and a higher-priority asset registered in code -- e.g. from the deploy manifest -- overrides it). Returns nil when no active asset matches.

GetAllActiveAssetsOfType​

</>
GameConfigPicker.GetAllActiveAssetsOfType(
assetType: GameConfigAssetTypes.GameConfigAssetType
) → {GameConfigAssetBase}

Gets all assets of a given type

ToAssetId​

</>
GameConfigPicker.ToAssetId(
assetType: GameConfigAssetType,
assetIdOrKey: number | string
) → number?

Converts an asset type and key to an id

ObserveToAssetIdBrio​

</>
GameConfigPicker.ObserveToAssetIdBrio(
assetType: GameConfigAssetType,
assetIdOrKey: number | string
) → Observable<Brio<number>>

Observes a converted asset type and key to an id

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructs a new game config picker. Should be gotten by [GameConfigService].",
            "params": [
                {
                    "name": "serviceBag",
                    "desc": "",
                    "lua_type": "ServiceBag"
                },
                {
                    "name": "gameConfigBinder",
                    "desc": "",
                    "lua_type": "Binder<GameConfig>"
                },
                {
                    "name": "gameConfigAssetBinder",
                    "desc": "",
                    "lua_type": "Binder<GameConfigAsset>"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "GameConfigPicker"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 47,
                "path": "src/gameconfig/src/Shared/Config/Picker/GameConfigPicker.lua"
            }
        },
        {
            "name": "ObserveActiveAssetOfTypeBrio",
            "desc": "Observes active assets of a given type. Great for badge views or other things.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "GameConfigPicker"
                },
                {
                    "name": "assetType",
                    "desc": "",
                    "lua_type": "string\n"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<Brio<GameConfigAssetBase>>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 79,
                "path": "src/gameconfig/src/Shared/Config/Picker/GameConfigPicker.lua"
            }
        },
        {
            "name": "ObserveActiveAssetOfAssetTypeAndKeyBrio",
            "desc": "Observes all active assets of a type and key.\n\n```lua\nmaid:GiveTask(picker:ObserveActiveAssetOfAssetTypeAndKeyBrio(GameConfigAssetType.BADGE, \"myBadge\")\n\t:Pipe({\n\t\tRxStateStackUtils.topOfStack();\n\t}):Subscribe(function(activeBadge)\n\t\tprint(activeBadge:GetId())\n\tend))\n```",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "GameConfigPicker"
                },
                {
                    "name": "assetType",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "assetKey",
                    "desc": "",
                    "lua_type": "string\n"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<Brio<GameConfigAssetBase>>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 108,
                "path": "src/gameconfig/src/Shared/Config/Picker/GameConfigPicker.lua"
            }
        },
        {
            "name": "ObserveActiveAssetOfAssetTypeAndIdBrio",
            "desc": "Observes all active assets of a type and an id.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "GameConfigPicker"
                },
                {
                    "name": "assetType",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "assetId",
                    "desc": "",
                    "lua_type": "number\n"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<Brio<GameConfigAssetBase>>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 129,
                "path": "src/gameconfig/src/Shared/Config/Picker/GameConfigPicker.lua"
            }
        },
        {
            "name": "ObserveActiveAssetOfAssetIdBrio",
            "desc": "Observes all active assets of an id",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "GameConfigPicker"
                },
                {
                    "name": "assetId",
                    "desc": "",
                    "lua_type": "number\n"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<Brio<GameConfigAssetBase>>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 149,
                "path": "src/gameconfig/src/Shared/Config/Picker/GameConfigPicker.lua"
            }
        },
        {
            "name": "ObserveActiveAssetOfKeyBrio",
            "desc": "Observes all active assets of a key",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "GameConfigPicker"
                },
                {
                    "name": "assetKey",
                    "desc": "",
                    "lua_type": "string\n"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<Brio<GameConfigAssetBase>>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 168,
                "path": "src/gameconfig/src/Shared/Config/Picker/GameConfigPicker.lua"
            }
        },
        {
            "name": "ObserveActiveConfigsBrio",
            "desc": "Observes all active active assets",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "GameConfigPicker\n"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<Brio<GameConfigAssetBase>>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 186,
                "path": "src/gameconfig/src/Shared/Config/Picker/GameConfigPicker.lua"
            }
        },
        {
            "name": "GetActiveConfigs",
            "desc": "Gets all active configs that exist",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "GameConfigPicker"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{ GameConfigAssetBase }"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 197,
                "path": "src/gameconfig/src/Shared/Config/Picker/GameConfigPicker.lua"
            }
        },
        {
            "name": "FindFirstActiveAssetOfId",
            "desc": "Find the first asset of a given id",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "GameConfigPicker"
                },
                {
                    "name": "assetType",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "assetId",
                    "desc": "",
                    "lua_type": "number\n"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "GameConfigAssetBase?"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 208,
                "path": "src/gameconfig/src/Shared/Config/Picker/GameConfigPicker.lua"
            }
        },
        {
            "name": "PromisePriceInRobux",
            "desc": "Find the first asset of a given key",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "GameConfigPicker"
                },
                {
                    "name": "assetType",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "assetIdOrKey",
                    "desc": "",
                    "lua_type": "string | number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<number>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 232,
                "path": "src/gameconfig/src/Shared/Config/Picker/GameConfigPicker.lua"
            }
        },
        {
            "name": "FindFirstActiveAssetOfKey",
            "desc": "Find the active asset of a given type and key.\n\nWhen several active assets share the type and key, the one with the highest\n[GameConfigAssetBase.GetPriority] wins; equal priorities keep the first\niterated (so a lone hand-authored asset resolves exactly as before, and a\nhigher-priority asset registered in code -- e.g. from the deploy manifest --\noverrides it). Returns nil when no active asset matches.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "GameConfigPicker"
                },
                {
                    "name": "assetType",
                    "desc": "",
                    "lua_type": "GameConfigAssetTypes.GameConfigAssetType"
                },
                {
                    "name": "assetKey",
                    "desc": "",
                    "lua_type": "string\n"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "GameConfigAssetBase?"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 281,
                "path": "src/gameconfig/src/Shared/Config/Picker/GameConfigPicker.lua"
            }
        },
        {
            "name": "GetAllActiveAssetsOfType",
            "desc": "Gets all assets of a given type",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "GameConfigPicker"
                },
                {
                    "name": "assetType",
                    "desc": "",
                    "lua_type": "GameConfigAssetTypes.GameConfigAssetType\n"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{ GameConfigAssetBase }"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 311,
                "path": "src/gameconfig/src/Shared/Config/Picker/GameConfigPicker.lua"
            }
        },
        {
            "name": "ToAssetId",
            "desc": "Converts an asset type and key to an id",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "GameConfigPicker"
                },
                {
                    "name": "assetType",
                    "desc": "",
                    "lua_type": "GameConfigAssetType"
                },
                {
                    "name": "assetIdOrKey",
                    "desc": "",
                    "lua_type": "number | string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "number?"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 346,
                "path": "src/gameconfig/src/Shared/Config/Picker/GameConfigPicker.lua"
            }
        },
        {
            "name": "ObserveToAssetIdBrio",
            "desc": "Observes a converted asset type and key to an id",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "GameConfigPicker"
                },
                {
                    "name": "assetType",
                    "desc": "",
                    "lua_type": "GameConfigAssetType"
                },
                {
                    "name": "assetIdOrKey",
                    "desc": "",
                    "lua_type": "number | string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<Brio<number>>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 373,
                "path": "src/gameconfig/src/Shared/Config/Picker/GameConfigPicker.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "GameConfigPicker",
    "desc": "Provides an interface to query game configurations from assets in the world.",
    "source": {
        "line": 6,
        "path": "src/gameconfig/src/Shared/Config/Picker/GameConfigPicker.lua"
    }
}