Skip to main content

PlayerAssetMarketTracker

Tracks a single asset type for pending purchase prompts.

Functions​

new​

</>
PlayerAssetMarketTracker.new(
convertIds: function,
observeIdsBrio: function
) → PlayerAssetMarketTracker

Constructs a new market tracker. Generally you should not need to use this directly.

ObservePromptOpenCount​

</>
PlayerAssetMarketTracker.ObservePromptOpenCount(self: PlayerAssetMarketTracker) → Observable<number>

Observes the number of prompts open

ObserveAssetPurchased​

</>
PlayerAssetMarketTracker.ObserveAssetPurchased(
idOrKey: string | number
) → Observable<()>

Observes an asset purchased

GetOwnershipTracker​

</>
PlayerAssetMarketTracker.GetOwnershipTracker(self: PlayerAssetMarketTracker) → GetOwnershipTracker

Gets the ownership tracker assigned to this tracker

PromisePromptPurchase​

</>
PlayerAssetMarketTracker.PromisePromptPurchase(
idOrKey: number | string
) → Promise<boolean>

Prompts the player to purchase a the asset and returns a tracking promise which will resolve with the purchase state

SetOwnershipTracker​

</>
PlayerAssetMarketTracker.SetOwnershipTracker(
ownershipTracker: PlayerAssetOwnershipTracker
) → ()

Sets the ownership tracker for this asset tracker

GetAssetType​

</>
PlayerAssetMarketTracker.GetAssetType(self: PlayerAssetMarketTracker) → GameConfigAssetTypes

Gets the current asset type

HasPurchasedThisSession​

</>
PlayerAssetMarketTracker.HasPurchasedThisSession(
idOrKey: string | number
) → boolean

Returns true if item has been purchased this session

IsPromptOpen​

</>
PlayerAssetMarketTracker.IsPromptOpen(self: PlayerAssetMarketTracker) → boolean

Returns true if a prompt is open for the asset

HandlePurchaseEvent​

</>
PlayerAssetMarketTracker.HandlePurchaseEvent(
id: number,
isPurchased: boolean
) → ()

Handles a purchasing event resolving any promises as needed

HandlePromptClosedEvent​

</>
PlayerAssetMarketTracker.HandlePromptClosedEvent(
id: number
) → ()

Handles the prompt closed

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructs a new market tracker. Generally you should not need to use\nthis directly.",
            "params": [
                {
                    "name": "assetType",
                    "desc": "",
                    "lua_type": "GameConfigAssetTypes"
                },
                {
                    "name": "convertIds",
                    "desc": "",
                    "lua_type": "function"
                },
                {
                    "name": "observeIdsBrio",
                    "desc": "",
                    "lua_type": "function"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "PlayerAssetMarketTracker"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 56,
                "path": "src/gameproductservice/src/Shared/Trackers/PlayerAssetMarketTracker.lua"
            }
        },
        {
            "name": "ObservePromptOpenCount",
            "desc": "Observes the number of prompts open",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "PlayerAssetMarketTracker"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<number>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 118,
                "path": "src/gameproductservice/src/Shared/Trackers/PlayerAssetMarketTracker.lua"
            }
        },
        {
            "name": "ObserveAssetPurchased",
            "desc": "Observes an asset purchased",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "PlayerAssetMarketTracker"
                },
                {
                    "name": "idOrKey",
                    "desc": "",
                    "lua_type": "string | number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<()>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 128,
                "path": "src/gameproductservice/src/Shared/Trackers/PlayerAssetMarketTracker.lua"
            }
        },
        {
            "name": "GetOwnershipTracker",
            "desc": "Gets the ownership tracker assigned to this tracker",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "PlayerAssetMarketTracker\n"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "GetOwnershipTracker"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 171,
                "path": "src/gameproductservice/src/Shared/Trackers/PlayerAssetMarketTracker.lua"
            }
        },
        {
            "name": "PromisePromptPurchase",
            "desc": "Prompts the player to purchase a the asset and returns a tracking promise which\nwill resolve with the purchase state",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "PlayerAssetMarketTracker"
                },
                {
                    "name": "idOrKey",
                    "desc": "",
                    "lua_type": "number | string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<boolean>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 184,
                "path": "src/gameproductservice/src/Shared/Trackers/PlayerAssetMarketTracker.lua"
            }
        },
        {
            "name": "SetOwnershipTracker",
            "desc": "Sets the ownership tracker for this asset tracker",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "PlayerAssetMarketTracker"
                },
                {
                    "name": "ownershipTracker",
                    "desc": "",
                    "lua_type": "PlayerAssetOwnershipTracker"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 279,
                "path": "src/gameproductservice/src/Shared/Trackers/PlayerAssetMarketTracker.lua"
            }
        },
        {
            "name": "GetAssetType",
            "desc": "Gets the current asset type",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "PlayerAssetMarketTracker"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "GameConfigAssetTypes"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 293,
                "path": "src/gameproductservice/src/Shared/Trackers/PlayerAssetMarketTracker.lua"
            }
        },
        {
            "name": "HasPurchasedThisSession",
            "desc": "Returns true if item has been purchased this session",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "PlayerAssetMarketTracker"
                },
                {
                    "name": "idOrKey",
                    "desc": "",
                    "lua_type": "string | number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 303,
                "path": "src/gameproductservice/src/Shared/Trackers/PlayerAssetMarketTracker.lua"
            }
        },
        {
            "name": "IsPromptOpen",
            "desc": "Returns true if a prompt is open for the asset",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "PlayerAssetMarketTracker"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 327,
                "path": "src/gameproductservice/src/Shared/Trackers/PlayerAssetMarketTracker.lua"
            }
        },
        {
            "name": "HandlePurchaseEvent",
            "desc": "Handles a purchasing event resolving any promises as needed",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "PlayerAssetMarketTracker"
                },
                {
                    "name": "id",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "isPurchased",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 337,
                "path": "src/gameproductservice/src/Shared/Trackers/PlayerAssetMarketTracker.lua"
            }
        },
        {
            "name": "HandlePromptClosedEvent",
            "desc": "Handles the prompt closed",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "PlayerAssetMarketTracker"
                },
                {
                    "name": "id",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 359,
                "path": "src/gameproductservice/src/Shared/Trackers/PlayerAssetMarketTracker.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "PlayerAssetMarketTracker",
    "desc": "Tracks a single asset type for pending purchase prompts.",
    "source": {
        "line": 7,
        "path": "src/gameproductservice/src/Shared/Trackers/PlayerAssetMarketTracker.lua"
    }
}