Skip to main content

GameConfigAssetBase

Functions

new

GameConfigAssetBase.new(
objFolder,
serviceBagServiceBag
) → GameConfigAssetBase

Constructs a new GameConfigAssetBase. Should be done via binder. This is a base class.

ObserveTranslatedName

GameConfigAssetBase:ObserveTranslatedName() → Observable<string>

Observes the translated name

ObserveTranslatedDescription

GameConfigAssetBase:ObserveTranslatedDescription() → Observable<string>

Observes the translated description

SetNameTranslationKey

GameConfigAssetBase:SetNameTranslationKey(nameTranslationKeystring?) → ()

Sets the name translation key

SetDescriptionTranslationKey

GameConfigAssetBase:SetDescriptionTranslationKey(descriptionTranslationKeystring?) → ()

Sets the description translation key

GetAssetId

GameConfigAssetBase:GetAssetId() → number

Gets the asset id

ObserveAssetId

GameConfigAssetBase:ObserveAssetId() → Observable<number>

Observes the assetId

GetAssetType

GameConfigAssetBase:GetAssetType() → string?

Gets the asset type

ObserveAssetType

GameConfigAssetBase:ObserveAssetType() → Observable<string?>

Observes the asset type

ObserveAssetKey

GameConfigAssetBase:ObserveAssetKey() → Observable<string>

Observes the asset key

GetAssetKey

GameConfigAssetBase:GetAssetKey() → string

Gets the asset key

ObserveState

GameConfigAssetBase:ObserveState() → any

Observes the asset state

PromiseCloudPriceInRobux

GameConfigAssetBase:PromiseCloudPriceInRobux(cancelTokenCancelToken) → Promise<number?>

Promises the cloud price in Robux

PromiseCloudName

GameConfigAssetBase:PromiseCloudName(cancelTokenCancelToken) → Promise<string?>

Promises the cloud price in Robux

PromiseColor

GameConfigAssetBase:PromiseColor(_cancelTokenCancelToken) → Promise<Color3>

Promises the color of the game asset (for dialog and other systems)

PromiseNameTranslationKey

GameConfigAssetBase:PromiseNameTranslationKey(cancelTokenCancelToken) → Promise<string?>

Promises the name translation key

ObserveNameTranslationKey

GameConfigAssetBase:ObserveNameTranslationKey() → Observable<string?>

Observes the name translation key.

ObserveDescriptionTranslationKey

GameConfigAssetBase:ObserveDescriptionTranslationKey() → Observable<string?>

Observes the description translation key.

ObserveCloudName

GameConfigAssetBase:ObserveCloudName() → Observable<string?>

Observes the cloud name. See GameConfigAssetBase.ObserveNameTranslationKey for translation keys.

ObserveCloudDescription

GameConfigAssetBase:ObserveCloudDescription() → Observable<string?>

Observes the cloud name. See GameConfigAssetBase.ObserveDescriptionTranslationKey for translation keys.

ObserveCloudPriceInRobux

GameConfigAssetBase:ObserveCloudPriceInRobux() → Observable<number?>

Observes the cost in Robux.

ObserveCloudIconImageAssetId

GameConfigAssetBase:ObserveCloudIconImageAssetId() → Observable<number?>
Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructs a new GameConfigAssetBase. Should be done via binder. This is a base class.",
            "params": [
                {
                    "name": "obj",
                    "desc": "",
                    "lua_type": "Folder"
                },
                {
                    "name": "serviceBag",
                    "desc": "",
                    "lua_type": "ServiceBag"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "GameConfigAssetBase"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 44,
                "path": "src/gameconfig/src/Shared/Config/Asset/GameConfigAssetBase.lua"
            }
        },
        {
            "name": "ObserveTranslatedName",
            "desc": "Observes the translated name",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<string>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 60,
                "path": "src/gameconfig/src/Shared/Config/Asset/GameConfigAssetBase.lua"
            }
        },
        {
            "name": "ObserveTranslatedDescription",
            "desc": "Observes the translated description",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<string>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 72,
                "path": "src/gameconfig/src/Shared/Config/Asset/GameConfigAssetBase.lua"
            }
        },
        {
            "name": "SetNameTranslationKey",
            "desc": "Sets the name translation key",
            "params": [
                {
                    "name": "nameTranslationKey",
                    "desc": "",
                    "lua_type": "string?"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 84,
                "path": "src/gameconfig/src/Shared/Config/Asset/GameConfigAssetBase.lua"
            }
        },
        {
            "name": "SetDescriptionTranslationKey",
            "desc": "Sets the description translation key",
            "params": [
                {
                    "name": "descriptionTranslationKey",
                    "desc": "",
                    "lua_type": "string?"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 94,
                "path": "src/gameconfig/src/Shared/Config/Asset/GameConfigAssetBase.lua"
            }
        },
        {
            "name": "GetAssetId",
            "desc": "Gets the asset id",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 107,
                "path": "src/gameconfig/src/Shared/Config/Asset/GameConfigAssetBase.lua"
            }
        },
        {
            "name": "ObserveAssetId",
            "desc": "Observes the assetId",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<number>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 115,
                "path": "src/gameconfig/src/Shared/Config/Asset/GameConfigAssetBase.lua"
            }
        },
        {
            "name": "GetAssetType",
            "desc": "Gets the asset type",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "string?"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 123,
                "path": "src/gameconfig/src/Shared/Config/Asset/GameConfigAssetBase.lua"
            }
        },
        {
            "name": "ObserveAssetType",
            "desc": "Observes the asset type",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<string?>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 131,
                "path": "src/gameconfig/src/Shared/Config/Asset/GameConfigAssetBase.lua"
            }
        },
        {
            "name": "ObserveAssetKey",
            "desc": "Observes the asset key",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<string>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 139,
                "path": "src/gameconfig/src/Shared/Config/Asset/GameConfigAssetBase.lua"
            }
        },
        {
            "name": "GetAssetKey",
            "desc": "Gets the asset key",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 147,
                "path": "src/gameconfig/src/Shared/Config/Asset/GameConfigAssetBase.lua"
            }
        },
        {
            "name": "ObserveState",
            "desc": "Observes the asset state",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 161,
                "path": "src/gameconfig/src/Shared/Config/Asset/GameConfigAssetBase.lua"
            }
        },
        {
            "name": "PromiseCloudPriceInRobux",
            "desc": "Promises the cloud price in Robux",
            "params": [
                {
                    "name": "cancelToken",
                    "desc": "",
                    "lua_type": "CancelToken"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<number?>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 174,
                "path": "src/gameconfig/src/Shared/Config/Asset/GameConfigAssetBase.lua"
            }
        },
        {
            "name": "PromiseCloudName",
            "desc": "Promises the cloud price in Robux",
            "params": [
                {
                    "name": "cancelToken",
                    "desc": "",
                    "lua_type": "CancelToken"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<string?>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 183,
                "path": "src/gameconfig/src/Shared/Config/Asset/GameConfigAssetBase.lua"
            }
        },
        {
            "name": "PromiseColor",
            "desc": "Promises the color of the game asset (for dialog and other systems)",
            "params": [
                {
                    "name": "_cancelToken",
                    "desc": "",
                    "lua_type": "CancelToken"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<Color3>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 191,
                "path": "src/gameconfig/src/Shared/Config/Asset/GameConfigAssetBase.lua"
            }
        },
        {
            "name": "PromiseNameTranslationKey",
            "desc": "Promises the name translation key",
            "params": [
                {
                    "name": "cancelToken",
                    "desc": "",
                    "lua_type": "CancelToken"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<string?>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 200,
                "path": "src/gameconfig/src/Shared/Config/Asset/GameConfigAssetBase.lua"
            }
        },
        {
            "name": "ObserveNameTranslationKey",
            "desc": "Observes the name translation key.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<string?>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 208,
                "path": "src/gameconfig/src/Shared/Config/Asset/GameConfigAssetBase.lua"
            }
        },
        {
            "name": "ObserveDescriptionTranslationKey",
            "desc": "Observes the description translation key.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<string?>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 216,
                "path": "src/gameconfig/src/Shared/Config/Asset/GameConfigAssetBase.lua"
            }
        },
        {
            "name": "ObserveCloudName",
            "desc": "Observes the cloud name. See [GameConfigAssetBase.ObserveNameTranslationKey] for\ntranslation keys.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<string?>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 225,
                "path": "src/gameconfig/src/Shared/Config/Asset/GameConfigAssetBase.lua"
            }
        },
        {
            "name": "ObserveCloudDescription",
            "desc": "Observes the cloud name. See [GameConfigAssetBase.ObserveDescriptionTranslationKey] for\ntranslation keys.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<string?>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 234,
                "path": "src/gameconfig/src/Shared/Config/Asset/GameConfigAssetBase.lua"
            }
        },
        {
            "name": "ObserveCloudPriceInRobux",
            "desc": "Observes the cost in Robux.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<number?>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 242,
                "path": "src/gameconfig/src/Shared/Config/Asset/GameConfigAssetBase.lua"
            }
        },
        {
            "name": "ObserveCloudIconImageAssetId",
            "desc": "",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<number?>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 249,
                "path": "src/gameconfig/src/Shared/Config/Asset/GameConfigAssetBase.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "GameConfigAssetBase",
    "desc": "",
    "source": {
        "line": 5,
        "path": "src/gameconfig/src/Shared/Config/Asset/GameConfigAssetBase.lua"
    }
}