Skip to main content

PlayerMarketeer

Functions​

new​

</>
PlayerMarketeer.new(
player: Player,
configPicker: GameConfigPicker
) → PlayerMarketeer

Constructs a new PlayerMarketeer in charge of handling market connections

IsOwnable​

</>
PlayerMarketeer:IsOwnable(assetType: GameConfigAssetType) → PlayerAssetMarketTracker

Returns true if the asset type can be owned

IsPromptOpen​

</>
PlayerMarketeer:IsPromptOpen() → boolean

Returns true if any prompt is open

PromisePlayerPromptClosed​

</>
PlayerMarketeer:PromisePlayerPromptClosed() → Promise

Promises that no prompt is open

GetAssetTrackerOrError​

</>
PlayerMarketeer:GetAssetTrackerOrError(assetType: GameConfigAssetType) → PlayerAssetMarketTracker

Gets the current asset tracker

GetOwnershipTrackerOrError​

</>
PlayerMarketeer:GetOwnershipTrackerOrError(assetType: GameConfigAssetType) → PlayerAssetMarketTracker

Gets the current asset tracker

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructs a new PlayerMarketeer in charge of handling market connections",
            "params": [
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                },
                {
                    "name": "configPicker",
                    "desc": "",
                    "lua_type": "GameConfigPicker"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "PlayerMarketeer"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 31,
                "path": "src/gameproductservice/src/Shared/Trackers/PlayerMarketeer.lua"
            }
        },
        {
            "name": "IsOwnable",
            "desc": "Returns true if the asset type can be owned",
            "params": [
                {
                    "name": "assetType",
                    "desc": "",
                    "lua_type": "GameConfigAssetType"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "PlayerAssetMarketTracker"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 86,
                "path": "src/gameproductservice/src/Shared/Trackers/PlayerMarketeer.lua"
            }
        },
        {
            "name": "IsPromptOpen",
            "desc": "Returns true if any prompt is open",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 97,
                "path": "src/gameproductservice/src/Shared/Trackers/PlayerMarketeer.lua"
            }
        },
        {
            "name": "PromisePlayerPromptClosed",
            "desc": "Promises that no prompt is open",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 112,
                "path": "src/gameproductservice/src/Shared/Trackers/PlayerMarketeer.lua"
            }
        },
        {
            "name": "GetAssetTrackerOrError",
            "desc": "Gets the current asset tracker",
            "params": [
                {
                    "name": "assetType",
                    "desc": "",
                    "lua_type": "GameConfigAssetType"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "PlayerAssetMarketTracker"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 153,
                "path": "src/gameproductservice/src/Shared/Trackers/PlayerMarketeer.lua"
            }
        },
        {
            "name": "GetOwnershipTrackerOrError",
            "desc": "Gets the current asset tracker",
            "params": [
                {
                    "name": "assetType",
                    "desc": "",
                    "lua_type": "GameConfigAssetType"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "PlayerAssetMarketTracker"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 169,
                "path": "src/gameproductservice/src/Shared/Trackers/PlayerMarketeer.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "PlayerMarketeer",
    "desc": "See [PlayerProductManager] and [PlayerProductManagerClient]",
    "source": {
        "line": 6,
        "path": "src/gameproductservice/src/Shared/Trackers/PlayerMarketeer.lua"
    }
}