TPStashEvent.GetConsumable

public int GetConsumable(
    string player_uuid,
    string character_uuid,
    string item_slug,
    float item_quantity,
    [entity from_entity = entity.None],
    [string from_category_slug = null],
    [string from_slug = null]
);

Description

GetConsumable collects the data of the character’s acquisition of a consumable item.

The types of items
  • Equipment: Weapons, armors, accessories, and other gears

  • Consumable: Potion, bandage, and other consumable items

  • Cosmetic: Costumes that do not affect the player or character’s ability and other essential attributes

  • Token: Alternative currency with limited use such as "token for pvp shop" including an entrance ticket

  • Material: Raw materials for gear upgrades, character ranking up, and so on

  • Infrastructure: Fixed assets that affect the whole game indirectly

  • Pet: Pet that a character carries

  • RandomBox: A random box that can be opened whose content varies depending on the probability

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

item_slug

Unique identifier of the item (for example, "weapon_sword_dagger" and "shield_kite_rare")

Required

item_quantity

The number or amount of consumable item acquired

Required

from_entity

The action that causes the player to gain the consumable item

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 consumable item

Optional

from_slug

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

Optional