Skip to main content

PlayerAssetMarketTracker

Tracks a single asset type for pending purchase prompts.

Functions​

new​

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

ObserveAssetPurchased​

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

Observes an asset purchased

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

HasPurchasedThisSession​

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

Returns true if item has been purchased this session

IsPromptOpen​

</>
PlayerAssetMarketTracker:IsPromptOpen() → 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

SetReceiptProcessingExpected​

</>
PlayerAssetMarketTracker:SetReceiptProcessingExpected(receiptProcessingExpected: boolean) → ()

Sets if this tracker is handling purchase receipts as a more authenticated mechanism

GetReceiptProcessingExpected​

</>
PlayerAssetMarketTracker:GetReceiptProcessingExpected() → boolean

Gets if this tracker is handling purchase receipts as a more authenticated mechanism

HandleProcessReceipt​

</>
PlayerAssetMarketTracker:HandleProcessReceipt(
player: Player,
receiptInfo: ReceiptInfo
) → ()

Handles the receipt processing

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "",
            "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": 27,
                "path": "src/gameproductservice/src/Shared/Trackers/PlayerAssetMarketTracker.lua"
            }
        },
        {
            "name": "ObserveAssetPurchased",
            "desc": "Observes an asset purchased",
            "params": [
                {
                    "name": "idOrKey",
                    "desc": "",
                    "lua_type": "string | number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<()>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 86,
                "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": "idOrKey",
                    "desc": "",
                    "lua_type": "number | string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<boolean>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 128,
                "path": "src/gameproductservice/src/Shared/Trackers/PlayerAssetMarketTracker.lua"
            }
        },
        {
            "name": "SetOwnershipTracker",
            "desc": "Sets the ownership tracker for this asset tracker",
            "params": [
                {
                    "name": "ownershipTracker",
                    "desc": "",
                    "lua_type": "PlayerAssetOwnershipTracker"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 201,
                "path": "src/gameproductservice/src/Shared/Trackers/PlayerAssetMarketTracker.lua"
            }
        },
        {
            "name": "HasPurchasedThisSession",
            "desc": "Returns true if item has been purchased this session",
            "params": [
                {
                    "name": "idOrKey",
                    "desc": "",
                    "lua_type": "string | number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 213,
                "path": "src/gameproductservice/src/Shared/Trackers/PlayerAssetMarketTracker.lua"
            }
        },
        {
            "name": "IsPromptOpen",
            "desc": "Returns true if a prompt is open for the asset",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 234,
                "path": "src/gameproductservice/src/Shared/Trackers/PlayerAssetMarketTracker.lua"
            }
        },
        {
            "name": "HandlePurchaseEvent",
            "desc": "Handles a purchasing event resolving any promises as needed",
            "params": [
                {
                    "name": "id",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "isPurchased",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 244,
                "path": "src/gameproductservice/src/Shared/Trackers/PlayerAssetMarketTracker.lua"
            }
        },
        {
            "name": "SetReceiptProcessingExpected",
            "desc": "Sets if this tracker is handling purchase receipts as a more authenticated mechanism",
            "params": [
                {
                    "name": "receiptProcessingExpected",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 290,
                "path": "src/gameproductservice/src/Shared/Trackers/PlayerAssetMarketTracker.lua"
            }
        },
        {
            "name": "GetReceiptProcessingExpected",
            "desc": "Gets if this tracker is handling purchase receipts as a more authenticated mechanism",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 301,
                "path": "src/gameproductservice/src/Shared/Trackers/PlayerAssetMarketTracker.lua"
            }
        },
        {
            "name": "HandleProcessReceipt",
            "desc": "Handles the receipt processing",
            "params": [
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                },
                {
                    "name": "receiptInfo",
                    "desc": "",
                    "lua_type": "ReceiptInfo"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 311,
                "path": "src/gameproductservice/src/Shared/Trackers/PlayerAssetMarketTracker.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "PlayerAssetMarketTracker",
    "desc": "Tracks a single asset type for pending purchase prompts.",
    "source": {
        "line": 6,
        "path": "src/gameproductservice/src/Shared/Trackers/PlayerAssetMarketTracker.lua"
    }
}