Skip to main content

GameConfigService

Functions​

Init​

</>
GameConfigService:Init(serviceBag: ServiceBag) → ()

Initializes the configuration service. Should be done via ServiceBag.

Start​

</>
GameConfigService:Start() → ()

Starts the configuration service. Should be done via ServiceBag.

AddBadge​

</>
GameConfigService:AddBadge(
assetKey: string,--

Key name to use for the badge

badgeId: number--

Cloud id

) → ()

Adds a new badge with the key configured to the assetKey

AddProduct​

</>
GameConfigService:AddProduct(
assetKey: string,--

Key name to use for the product

productId: number--

Cloud id

) → ()

Adds a new product with the key configured to the assetKey

AddPass​

</>
GameConfigService:AddPass(
assetKey: string,--

Key name to use for the pass

passId: number--

Cloud id

) → ()

Adds a new pass with the key configured to the assetKey

AddPlace​

</>
GameConfigService:AddPlace(
assetKey: string,--

Key name to use for the place

placeId: number,--

Cloud id

priority: number?--

Selection priority; higher wins on a key clash

) → ()

Adds a new place with the key configured to the assetKey

AddAsset​

</>
GameConfigService:AddAsset(
assetKey: string,--

Key name to use for the asset

assetId: number--

Cloud id

) → ()

Adds a new asset with the key configured to the assetKey

AddSubscription​

</>
GameConfigService:AddSubscription(
assetKey: string,--

Key name to use for the asset

subscriptionId: string--

Cloud id

) → ()

Adds a new asset with the key configured to the assetKey

AddBundle​

</>
GameConfigService:AddBundle(
assetKey: string,--

Key name to use for the bundle

bundleId: number--

Cloud id

) → ()

Adds a new bundle with the key configured to the assetKey

AddTypedAsset​

</>
GameConfigService:AddTypedAsset(
assetType: GameConfigAssetType,
assetKey: string,--

Key name to use for the bundle

assetId: number,--

Cloud id

priority: number?--

Selection priority; higher wins on a key clash

) → ()

Adds a new asset with the specified type

GetConfigPicker​

</>
GameConfigService:GetConfigPicker() → GameConfigPicker

Gets the current config picker

GetPreferredParent​

</>
GameConfigService:GetPreferredParent() → Instance

Returns the preferred parent for the configuration service

Destroy​

</>
GameConfigService:Destroy() → ()

Cleans up the configuration service. Should be done via ServiceBag.

Show raw api
{
    "functions": [
        {
            "name": "Init",
            "desc": "Initializes the configuration service. Should be done via [ServiceBag].",
            "params": [
                {
                    "name": "serviceBag",
                    "desc": "",
                    "lua_type": "ServiceBag"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 38,
                "path": "src/gameconfig/src/Server/GameConfigService.lua"
            }
        },
        {
            "name": "Start",
            "desc": "Starts the configuration service. Should be done via [ServiceBag].",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 70,
                "path": "src/gameconfig/src/Server/GameConfigService.lua"
            }
        },
        {
            "name": "AddBadge",
            "desc": "Adds a new badge with the key configured to the `assetKey`",
            "params": [
                {
                    "name": "assetKey",
                    "desc": "Key name to use for the badge",
                    "lua_type": "string"
                },
                {
                    "name": "badgeId",
                    "desc": "Cloud id",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 80,
                "path": "src/gameconfig/src/Server/GameConfigService.lua"
            }
        },
        {
            "name": "AddProduct",
            "desc": "Adds a new product with the key configured to the `assetKey`",
            "params": [
                {
                    "name": "assetKey",
                    "desc": "Key name to use for the product",
                    "lua_type": "string"
                },
                {
                    "name": "productId",
                    "desc": "Cloud id",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 89,
                "path": "src/gameconfig/src/Server/GameConfigService.lua"
            }
        },
        {
            "name": "AddPass",
            "desc": "Adds a new pass with the key configured to the `assetKey`",
            "params": [
                {
                    "name": "assetKey",
                    "desc": "Key name to use for the pass",
                    "lua_type": "string"
                },
                {
                    "name": "passId",
                    "desc": "Cloud id",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 98,
                "path": "src/gameconfig/src/Server/GameConfigService.lua"
            }
        },
        {
            "name": "AddPlace",
            "desc": "Adds a new place with the key configured to the `assetKey`",
            "params": [
                {
                    "name": "assetKey",
                    "desc": "Key name to use for the place",
                    "lua_type": "string"
                },
                {
                    "name": "placeId",
                    "desc": "Cloud id",
                    "lua_type": "number"
                },
                {
                    "name": "priority",
                    "desc": "Selection priority; higher wins on a key clash",
                    "lua_type": "number?"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 108,
                "path": "src/gameconfig/src/Server/GameConfigService.lua"
            }
        },
        {
            "name": "AddAsset",
            "desc": "Adds a new asset with the key configured to the `assetKey`",
            "params": [
                {
                    "name": "assetKey",
                    "desc": "Key name to use for the asset",
                    "lua_type": "string"
                },
                {
                    "name": "assetId",
                    "desc": "Cloud id",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 117,
                "path": "src/gameconfig/src/Server/GameConfigService.lua"
            }
        },
        {
            "name": "AddSubscription",
            "desc": "Adds a new asset with the key configured to the `assetKey`",
            "params": [
                {
                    "name": "assetKey",
                    "desc": "Key name to use for the asset",
                    "lua_type": "string"
                },
                {
                    "name": "subscriptionId",
                    "desc": "Cloud id",
                    "lua_type": "string"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 126,
                "path": "src/gameconfig/src/Server/GameConfigService.lua"
            }
        },
        {
            "name": "AddBundle",
            "desc": "Adds a new bundle with the key configured to the `assetKey`",
            "params": [
                {
                    "name": "assetKey",
                    "desc": "Key name to use for the bundle",
                    "lua_type": "string"
                },
                {
                    "name": "bundleId",
                    "desc": "Cloud id",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 135,
                "path": "src/gameconfig/src/Server/GameConfigService.lua"
            }
        },
        {
            "name": "AddTypedAsset",
            "desc": "Adds a new asset with the specified type",
            "params": [
                {
                    "name": "assetType",
                    "desc": "",
                    "lua_type": "GameConfigAssetType"
                },
                {
                    "name": "assetKey",
                    "desc": "Key name to use for the bundle",
                    "lua_type": "string"
                },
                {
                    "name": "assetId",
                    "desc": "Cloud id",
                    "lua_type": "number"
                },
                {
                    "name": "priority",
                    "desc": "Selection priority; higher wins on a key clash",
                    "lua_type": "number?"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 147,
                "path": "src/gameconfig/src/Server/GameConfigService.lua"
            }
        },
        {
            "name": "GetConfigPicker",
            "desc": "Gets the current config picker",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "GameConfigPicker"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 171,
                "path": "src/gameconfig/src/Server/GameConfigService.lua"
            }
        },
        {
            "name": "GetPreferredParent",
            "desc": "Returns the preferred parent for the configuration service",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 180,
                "path": "src/gameconfig/src/Server/GameConfigService.lua"
            }
        },
        {
            "name": "Destroy",
            "desc": "Cleans up the configuration service. Should be done via [ServiceBag].",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 201,
                "path": "src/gameconfig/src/Server/GameConfigService.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "GameConfigService",
    "desc": "",
    "source": {
        "line": 5,
        "path": "src/gameconfig/src/Server/GameConfigService.lua"
    }
}