TPStashEvent.GetCurrency

public int GetCurrency(
    string player_uuid,
    string character_uuid,
    string currency_slug,
    float currency_quantity,
    [float? currency_total_quantity = null],
    [entity from_entity = entity.None],
    [string from_category_slug = null],
    [string from_slug = null]
);

Description

GetCurrency collects the data of the character’s acquisition of in-game currency. It needs to be called when an event of currency acquisition occurs in the middle of the game. It can be used for the analysis of personas about currency acquisition.

It returns 1 for success and -1 for failure. If -1 is returned, you can see the following message in the Unity editor console in TentuPlay debug mode:

TPError||ERROR inserting table_name: exception_error_message

Parameters

Name Description Required

player_uuid

Player’s unique ID (not a character’s ID) such as Steam user ID and Google Play user ID

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 acquired

Required

currency_total_quantity

The total number or amount of currency after currency acquisition

This parameter is not required but highly recommended because it helps create more accurate currency reserve status.

Optional

from_entity

The action that causes the player to gain the currency.

Entities 
public enum entity {
    None,
    Etc,
    Join,
    LoginApp,
    LoginAsCharacter,
    InAppPurchase,
    ShopPurchase,
    Trade,
    WatchAd,
    PlayQuest,
    GetBonus,
    ChangeCharacterArchetype,
    ChangeStat,
    ChangeCustomAbility,
    PlayStage,
    GetCharacter,
    GetCurrency,
    GetInfrastructure,
    GetPet,
    GetToken,
    GetConsumable,
    GetMaterial,
    GetEquipment,
    GetCostume,
    GetRandomBox,
    UseCurrency,
    EquipInfrastructure,
    EquipPet,
    UseToken,
    UseConsumable,
    UseMaterial,
    EquipEquipment,
    EquipCostume,
    OpenRandomBox,
    EquipSkill,
    DismissCharacter,
    DismissInfrastructure,
    DismissPet,
    DismissToken,
    DismissConsumable,
    DismissMaterial,
    DismissEquipment,
    DismissCostume,
    DismissRandomBox,
    LevelUpCharacter,
    LevelUpInfrastructure,
    LevelUpPet,
    LevelUpConsumable,
    LevelUpMaterial,
    LevelUpEquipment,
    LevelUpCostume,
    LevelUpSkill,
    Deposit,
    Withdraw,
    FinishedTutorial,
}

Optional

from_category_slug

The category of place, source, or situation from which the player gets the currency

Optional

from_slug

The name of place, source, or situation from which the player gets the currency

Optional