Skip to main content

GameConfigBase

Functions​

new​

</>
GameConfigBase.new(folder: Folder) → GameConfigBase

Constructs a new game config.

GetFolder​

</>
GameConfigBase.GetFolder(self: GameConfigBase) → Instance

Gets the current folder

GetAssetsOfType​

</>
GameConfigBase.GetAssetsOfType(
assetType: GameConfigAssetType
) → {GameConfigAssetBase}

Returns an array of all the assets of that type underneath this config

GetAssetsOfTypeAndKey​

</>
GameConfigBase.GetAssetsOfTypeAndKey(
assetType: GameConfigAssetType,
assetKey: string
) → {GameConfigAssetBase}

Returns an array of all the assets of that type underneath this config

GetAssetsOfTypeAndId​

</>
GameConfigBase.GetAssetsOfTypeAndId(
assetType: GameConfigAssetType,
assetId: number
) → {GameConfigAssetBase}

Returns an array of all the assets of that type underneath this config

ObserveAssetByTypeAndKeyBrio​

</>
GameConfigBase.ObserveAssetByTypeAndKeyBrio(
assetType: GameConfigAssetType,
assetKey: string
) → Observable<Brio<GameConfigAssetBase>>

Returns an observable matching these types and the key

ObserveAssetByTypeAndIdBrio​

</>
GameConfigBase.ObserveAssetByTypeAndIdBrio(
assetType: GameConfigAssetType,
assetId: number
) → Observable<Brio<GameConfigAssetBase>>

Returns an observable matching these types and the id

ObserveAssetByIdBrio​

</>
GameConfigBase.ObserveAssetByIdBrio(
assetId: number
) → Observable<Brio<GameConfigAssetBase>>

Observes all matching assets of this id

ObserveAssetByKeyBrio​

</>
GameConfigBase.ObserveAssetByKeyBrio(
assetKey: string
) → Observable<Brio<GameConfigAssetBase>>

Observes all matching assets of this key

ObserveAssetByTypeBrio​

</>
GameConfigBase.ObserveAssetByTypeBrio(
assetType: GameConfigAssetType
) → Observable<Brio<GameConfigAssetBase>>

Observes all matching assets of this type

InitObservation​

</>
GameConfigBase.InitObservation(self: GameConfigBase) → ()

Initializes the observation. Should be called by the class inheriting this object.

ObserveGameId​

</>
GameConfigBase.ObserveGameId(self: GameConfigBase) → Observable<number>

Returns the game id for this profile.

GetGameId​

</>
GameConfigBase.GetGameId(self: GameConfigBase) → number

Returns the game id

GetConfigName​

</>
GameConfigBase.GetConfigName(self: GameConfigBase) → string

Returns this configuration's name

ObserveConfigName​

</>
GameConfigBase.ObserveConfigName(self: GameConfigBase) → Observable<string>

Observes this configs name

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructs a new game config.",
            "params": [
                {
                    "name": "folder",
                    "desc": "",
                    "lua_type": "Folder"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "GameConfigBase"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 54,
                "path": "src/gameconfig/src/Shared/Config/Config/GameConfigBase.lua"
            }
        },
        {
            "name": "GetFolder",
            "desc": "Gets the current folder",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "GameConfigBase"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 99,
                "path": "src/gameconfig/src/Shared/Config/Config/GameConfigBase.lua"
            }
        },
        {
            "name": "GetAssetsOfType",
            "desc": "Returns an array of all the assets of that type underneath this config",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "GameConfigBase"
                },
                {
                    "name": "assetType",
                    "desc": "",
                    "lua_type": "GameConfigAssetType"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{ GameConfigAssetBase }"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 107,
                "path": "src/gameconfig/src/Shared/Config/Config/GameConfigBase.lua"
            }
        },
        {
            "name": "GetAssetsOfTypeAndKey",
            "desc": "Returns an array of all the assets of that type underneath this config",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "GameConfigBase"
                },
                {
                    "name": "assetType",
                    "desc": "",
                    "lua_type": "GameConfigAssetType"
                },
                {
                    "name": "assetKey",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{ GameConfigAssetBase }"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 119,
                "path": "src/gameconfig/src/Shared/Config/Config/GameConfigBase.lua"
            }
        },
        {
            "name": "GetAssetsOfTypeAndId",
            "desc": "Returns an array of all the assets of that type underneath this config",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "GameConfigBase"
                },
                {
                    "name": "assetType",
                    "desc": "",
                    "lua_type": "GameConfigAssetType"
                },
                {
                    "name": "assetId",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{ GameConfigAssetBase }"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 132,
                "path": "src/gameconfig/src/Shared/Config/Config/GameConfigBase.lua"
            }
        },
        {
            "name": "ObserveAssetByTypeAndKeyBrio",
            "desc": "Returns an observable matching these types and the key",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "GameConfigBase"
                },
                {
                    "name": "assetType",
                    "desc": "",
                    "lua_type": "GameConfigAssetType"
                },
                {
                    "name": "assetKey",
                    "desc": "",
                    "lua_type": "string\n"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<Brio<GameConfigAssetBase>>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 145,
                "path": "src/gameconfig/src/Shared/Config/Config/GameConfigBase.lua"
            }
        },
        {
            "name": "ObserveAssetByTypeAndIdBrio",
            "desc": "Returns an observable matching these types and the id",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "GameConfigBase"
                },
                {
                    "name": "assetType",
                    "desc": "",
                    "lua_type": "GameConfigAssetType"
                },
                {
                    "name": "assetId",
                    "desc": "",
                    "lua_type": "number\n"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<Brio<GameConfigAssetBase>>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 162,
                "path": "src/gameconfig/src/Shared/Config/Config/GameConfigBase.lua"
            }
        },
        {
            "name": "ObserveAssetByIdBrio",
            "desc": "Observes all matching assets of this id",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "GameConfigBase"
                },
                {
                    "name": "assetId",
                    "desc": "",
                    "lua_type": "number\n"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<Brio<GameConfigAssetBase>>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 178,
                "path": "src/gameconfig/src/Shared/Config/Config/GameConfigBase.lua"
            }
        },
        {
            "name": "ObserveAssetByKeyBrio",
            "desc": "Observes all matching assets of this key",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "GameConfigBase"
                },
                {
                    "name": "assetKey",
                    "desc": "",
                    "lua_type": "string\n"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<Brio<GameConfigAssetBase>>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 192,
                "path": "src/gameconfig/src/Shared/Config/Config/GameConfigBase.lua"
            }
        },
        {
            "name": "ObserveAssetByTypeBrio",
            "desc": "Observes all matching assets of this type",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "GameConfigBase"
                },
                {
                    "name": "assetType",
                    "desc": "",
                    "lua_type": "GameConfigAssetType\n"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<Brio<GameConfigAssetBase>>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 206,
                "path": "src/gameconfig/src/Shared/Config/Config/GameConfigBase.lua"
            }
        },
        {
            "name": "InitObservation",
            "desc": "Initializes the observation. Should be called by the class inheriting this object.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "GameConfigBase"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 218,
                "path": "src/gameconfig/src/Shared/Config/Config/GameConfigBase.lua"
            }
        },
        {
            "name": "ObserveGameId",
            "desc": "Returns the game id for this profile.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "GameConfigBase"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<number>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 260,
                "path": "src/gameconfig/src/Shared/Config/Config/GameConfigBase.lua"
            }
        },
        {
            "name": "GetGameId",
            "desc": "Returns the game id",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "GameConfigBase"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 268,
                "path": "src/gameconfig/src/Shared/Config/Config/GameConfigBase.lua"
            }
        },
        {
            "name": "GetConfigName",
            "desc": "Returns this configuration's name",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "GameConfigBase"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 276,
                "path": "src/gameconfig/src/Shared/Config/Config/GameConfigBase.lua"
            }
        },
        {
            "name": "ObserveConfigName",
            "desc": "Observes this configs name",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "GameConfigBase"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<string>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 284,
                "path": "src/gameconfig/src/Shared/Config/Config/GameConfigBase.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "GameConfigBase",
    "desc": "",
    "source": {
        "line": 4,
        "path": "src/gameconfig/src/Shared/Config/Config/GameConfigBase.lua"
    }
}