Show raw api
{
"functions": [
{
"name": "new",
"desc": "Constructs a new game config.",
"params": [
{
"name": "folder",
"desc": "",
"lua_type": "Instance"
}
],
"returns": [
{
"desc": "",
"lua_type": "GameConfigBase"
}
],
"function_type": "static",
"source": {
"line": 28,
"path": "src/gameconfig/src/Shared/Config/Config/GameConfigBase.lua"
}
},
{
"name": "GetFolder",
"desc": "Gets the current folder",
"params": [],
"returns": [
{
"desc": "",
"lua_type": "Instance"
}
],
"function_type": "method",
"source": {
"line": 70,
"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": "assetType",
"desc": "",
"lua_type": "string"
}
],
"returns": [
{
"desc": "",
"lua_type": "{ GameConfigAssetBase }"
}
],
"function_type": "method",
"source": {
"line": 78,
"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": "assetType",
"desc": "",
"lua_type": "string"
},
{
"name": "assetKey",
"desc": "",
"lua_type": "string"
}
],
"returns": [
{
"desc": "",
"lua_type": "{ GameConfigAssetBase }"
}
],
"function_type": "method",
"source": {
"line": 90,
"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": "assetType",
"desc": "",
"lua_type": "string"
},
{
"name": "assetId",
"desc": "",
"lua_type": "number"
}
],
"returns": [
{
"desc": "",
"lua_type": "{ GameConfigAssetBase }"
}
],
"function_type": "method",
"source": {
"line": 103,
"path": "src/gameconfig/src/Shared/Config/Config/GameConfigBase.lua"
}
},
{
"name": "ObserveAssetByTypeAndKeyBrio",
"desc": "Returns an observable matching these types and the key",
"params": [
{
"name": "assetType",
"desc": "",
"lua_type": "string"
},
{
"name": "assetKey",
"desc": "",
"lua_type": "string"
}
],
"returns": [
{
"desc": "",
"lua_type": "Observable<Brio<GameConfigAssetBase>>"
}
],
"function_type": "method",
"source": {
"line": 116,
"path": "src/gameconfig/src/Shared/Config/Config/GameConfigBase.lua"
}
},
{
"name": "ObserveAssetByTypeAndIdBrio",
"desc": "Returns an observable matching these types and the id",
"params": [
{
"name": "assetType",
"desc": "",
"lua_type": "string"
},
{
"name": "assetId",
"desc": "",
"lua_type": "number"
}
],
"returns": [
{
"desc": "",
"lua_type": "Observable<Brio<GameConfigAssetBase>>"
}
],
"function_type": "method",
"source": {
"line": 129,
"path": "src/gameconfig/src/Shared/Config/Config/GameConfigBase.lua"
}
},
{
"name": "ObserveAssetByIdBrio",
"desc": "Observes all matching assets of this id",
"params": [
{
"name": "assetId",
"desc": "",
"lua_type": "number"
}
],
"returns": [
{
"desc": "",
"lua_type": "Observable<Brio<GameConfigAssetBase>>"
}
],
"function_type": "method",
"source": {
"line": 141,
"path": "src/gameconfig/src/Shared/Config/Config/GameConfigBase.lua"
}
},
{
"name": "ObserveAssetByKeyBrio",
"desc": "Observes all matching assets of this key",
"params": [
{
"name": "assetKey",
"desc": "",
"lua_type": "string"
}
],
"returns": [
{
"desc": "",
"lua_type": "Observable<Brio<GameConfigAssetBase>>"
}
],
"function_type": "method",
"source": {
"line": 152,
"path": "src/gameconfig/src/Shared/Config/Config/GameConfigBase.lua"
}
},
{
"name": "ObserveAssetByTypeBrio",
"desc": "Observes all matching assets of this type",
"params": [
{
"name": "assetType",
"desc": "",
"lua_type": "string"
}
],
"returns": [
{
"desc": "",
"lua_type": "Observable<Brio<GameConfigAssetBase>>"
}
],
"function_type": "method",
"source": {
"line": 163,
"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": [],
"returns": [],
"function_type": "method",
"source": {
"line": 172,
"path": "src/gameconfig/src/Shared/Config/Config/GameConfigBase.lua"
}
},
{
"name": "ObserveGameId",
"desc": "Returns the game id for this profile.",
"params": [],
"returns": [
{
"desc": "",
"lua_type": "Observable<number>"
}
],
"function_type": "method",
"source": {
"line": 211,
"path": "src/gameconfig/src/Shared/Config/Config/GameConfigBase.lua"
}
},
{
"name": "GetGameId",
"desc": "Returns the game id",
"params": [],
"returns": [
{
"desc": "",
"lua_type": "number"
}
],
"function_type": "method",
"source": {
"line": 219,
"path": "src/gameconfig/src/Shared/Config/Config/GameConfigBase.lua"
}
},
{
"name": "GetConfigName",
"desc": "Returns this configuration's name",
"params": [],
"returns": [
{
"desc": "",
"lua_type": "string"
}
],
"function_type": "method",
"source": {
"line": 227,
"path": "src/gameconfig/src/Shared/Config/Config/GameConfigBase.lua"
}
},
{
"name": "ObserveConfigName",
"desc": "Observes this configs name",
"params": [],
"returns": [
{
"desc": "",
"lua_type": "Observable<string>"
}
],
"function_type": "method",
"source": {
"line": 235,
"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"
}
}