TPStashEvent.DepositCurrency

TPStashEvent.DepositCurrency(
    userId,
    character_uuid,
    currency_slug,
    currency_quantity,
    storage_type,
    storage_slug,
    storage_category_slug
)

Description

DepositCurrency collects the events that occur when a character puts a currency in its storage.

Parameters

Name Description Required

UserId

Player’s unique user ID (not a character’s ID) that is given by Roblox: Player.UserId

Required

character_uuid

Player’s character’s unique lD

If there is no character in the game or If you want to use it for the player, not a character, set character_uuid to TentuPlayKeyword._DUMMY_CHARACTER_ID_.

Required

currency_slug

Unique identifier of currency such as "gold", "diamond", and "crystal"

Required

currency_quantity

The number or amount of currency deposited

Required

storage_type

Type of the player’s storage (for example, "personal_storage" and "guild_storage")

TPStashEvent.StorageType.Unknown
TPStashEvent.StorageType.Personal
TPStashEvent.StorageType.Guild

Optional

storage_slug

Unique identifier of player’s personal storage

Optional

storage_category_slug

Unique identifier of the category that the player’s personal storage belongs to

Optional