TPStashEvent.UseMaterial

TPStashEvent.UseMaterial(
    userId,
    character_uuid,
    item_slug,
    item_quantity,
    where_to_entity,
    where_to_category_slug,
    where_to_slug
)

Description

UseMaterial collects the data of the character’s using of a material 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

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

item_slug

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

Required

item_quantity

The number or amount of material item used

Required

where_to_entity

The entity type where the character gets to by using the material item

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

Optional

where_to_category_slug

The category of place, situation, or outcome to which the player gets by using the material item

Optional

where_to_slug

The name of place, situation, or outcome to which the player gets by using the material item

Optional