Card-Collecting RPG

Call the methods below if your game is a role-playing game based on collecting characters or cards to use in a battle, such as Summoners War and Marvel Future Fight.

When user plays a stage

Start Stage

• Call UseCurrency method if currency is paid to begin a stage.
  

  For UseCurrency method, input entity.PlayStage at where_to_entity, label for stage type at where_to_category_slug, stage name at where_to_slug.

  UseCurrency

  player_uuid	{ player_uuid }
  character_uuid	TentuPlayKeyword.DUMMY_CHARACTER_ID
  currency_slug	{ stamina }
  currency_quantity	8
  currency_total_quantity	99999
  where_to_entity	entity.PlayStage
  where_to_category_slug	{ adventure }
  where_to_slug	{ 1-1-1 }

  
  

• Call PlayStage method when a stage begins.
  

  Input stageStatus.Start at stage_status for PlayStage method.
  Input all characters needed to play a stage in a list format at character_uuids for PlayStage method.
  A Character that identifies the user such as Dummy Character must always be included in the list at character_uuid for PlayStage method.

  PlayStage

  player_uuid	{ player_uuid }
  character_uuid	[TentuPlayKeyword.DUMMY_CHARACTER_ID, Nike uuid, Zeus uuid, Peach uuid, Baek uuid, Kiwi uuid]
  stage_type	stageType.PvE
  stage_slug	{ 1-1-1 }
  stage_category	{ adventure }
  stage_level	1
  stage_score	null
  stage_status	stageStatus.Start
  stage_playtime	null

  
  

• Call PlayStageWithEquipment to record the equipment that each character is equipped with during stage play.

  PlayStageWithEquipment

  player_uuid	{ Baek uuid }	{ Baek uuid }
  item_slug *	{ Level 1 Armor }	{ Level 2 Long Sword }
  stage_slug	{ 1-1-1 }	{ 1-1-1 }
  stage_type	stageType.PvE	stageType.PvE
  stage_category_slug	{ adventure }	{ adventure }

  
  

End Stage

• Call PlayStage method when the stage ends.
  
  
  Input Win, Lose, or Quit at stage_status for PlayStage method, depending on the result of the stage.
  
  

  PlayStage

  player_uuid	{ player_uuid }
  character_uuid	[TentuPlayKeyword.DUMMY_CHARACTER_ID, Nike uuid, Zeus uuid, Peach uuid, Baek uuid, Kiwi uuid]
  stage_type*	stageType.PvE
  stage_slug	{ 1-1-1 }
  stage_category	{ adventure }
  stage_level	1
  stage_score	3
  stage_status	stageStatus.Win
  stage_playtime	30

  
  

Character Level Up

• Call LevelUpCharacter method if a certain character levels up during or after stage play.
  

  LevelUpCharacter

  player_uuid	{ player_uuid }
  character_uuid	{ Kylie uuid }
  level_to*	2
  level_from	1

  
  

Get Item

Call Get{ Object type } to record each Object acquired through stage play.

• Call GetCurrency method to record currency earned from playing stage.
  

  GetCurrency

  player_uuid	{ player_uuid }
  character_uuid	TentuPlayKeyword.DUMMY_CHARACTER_ID
  currency_slug	{ gold }
  currency_quantity	4947
  currency_total_quantity	999999
  from_entity	entity.PlayStage
  from_category_slug	{ adventure }
  from_slug	{ 1-1-1 }

  
  

• Call GetConsumable method to record Consumable earned from playing stage.

  GetConsumable

  player_uuid	{ player_uuid }
  character_uuid	TentuPlayKeyword.DUMMY_CHARACTER_ID
  item_slug	{ large potion of experience }
  item_quantity	29
  from_entity	entity.PlayStage
  from_category_slug	{ adventure }
  from_slug	{ 1-1-1 }

  
  

• Call GetEquipment method to record Equipment earned from playing stage.

  GetEquipment

  player_uuid	{ player_uuid }	{ player_uuid }
  character_uuid	TentuPlayKeyword.DUMMY_CHARACTER_ID	TentuPlayKeyword.DUMMY_CHARACTER_ID
  item_slug	{ 1 star dagger }	{ 1 star soldiers sword }
  item_quantity	1	1
  from_entity	entity.PlayStage	entity.PlayStage
  from_category_slug	{ adventure }	{ adventure }
  from_slug	{ 1-1-1 }	{ 1-1-1 }

  
  

Get Bonus

• Call GetBonus and relevant Get{ Object type } if additional bonus is earned after playing the stage.
  
  
  Both GetBonus and Get{ Object type } must be called when a user receives a bonus only when a certain requirement such as "Perfect Stage Clear" is met. Please note that input value at from_entity for Get{ Object type } method is entity.GetBonus, not entity.PlayStage.
  The example below calls GetConsumable and GetCurrency method in case when some Currency and Consumable are additionally earned as bonus.

  GetBonus

  player_uuid	{ player_uuid }
  character_uuid	TentuPlayKeyword.DUMMY_CHARACTER_ID
  bonus_slug	{ 1-1-1 perfect stage clear reward }
  bonus_category_slug	{ adventure }
  is_automated	FALSE

  
  

  GetConsumable

  player_uuid	{ player_uuid }
  character_uuid	TentuPlayKeyword.DUMMY_CHARACTER_ID
  item_slug	{ small potion of experience }
  item_quantity	20
  from_entity	entity.GetBonus
  from_category_slug	{ adventure }
  from_slug	{ 1-1-1 perfect clear reward }

  
  

  GetCurrency

  player_uuid	{ player_uuid }
  character_uuid	TentuPlayKeyword.DUMMY_CHARACTER_ID
  bonus_slug	{ 1-1-1 perfect clear reward }
  bonus_category_slug	{ adventure }
  is_automated	FALSE

  
  

When user skips a stage

Call the methods below if the user does not play the stage himself, but instead uses a clear ticket to automatically complete the stage. In this case, you would only be collecting the result data.

Start and End Stage

• Call UseConsumable method if a clear ticket is used.

  UseConsumable

  player_uuid	{ player_uuid }
  character_uuid	TentuPlayKeyword.DUMMY_CHARACTER_ID
  item_slug	{ clear ticket }
  item_quantity	1
  where_to_entity	entity.PlayStage
  where_to_category_slug	{ adventure }
  where_to_slug	{ 1-4-10 }

  
  

• Call UseCurrency method if currency is paid to start stage.

  UseCurrency

  player_uuid	{ player_uuid }
  character_uuid	TentuPlayKeyword.DUMMY_CHARACTER_ID
  currency_slug	{ stamina }
  currency_quantity	8
  currency_total_quantity	99999
  where_to_entity	entity.PlayStage
  where_to_category_slug	{ adventure }
  where_to_slug	{ 1-4-10 }

  
  

• Call PlayStage at the moment the stage ends if a clear ticket is used.

  PlayStage

  player_uuid	{ player_uuid }
  character_uuid	TentuPlayKeyword.DUMMY_CHARACTER_ID
  stage_type	stageType.PvE
  stage_slug	{ 1-4-10 }
  stage_category_slug	{ adventure }
  stage_level	44
  stage_score	null
  stage_status	stageStatus.Win
  stage_playtime	0

  
  

Character Level Up

• Call LevelUpCharacter method if a certain character levels up at the end of stage.
  

  LevelUpCharacter

  player_uuid	{ player_uuid }
  character_uuid	TentuPlayKeyword.DUMMY_CHARACTER_ID
  level_to*	2
  level_from	1

  
  

Get Item

• Call Get{ Object type } to record each Object acquired at the end of stage.
  
  

  GetCurrency

  player_uuid	{ player_uuid }
  character_uuid	TentuPlayKeyword.DUMMY_CHARACTER_ID
  currency_slug	{ gold }
  currency_quantity	4947
  currency_total_quantity	999999
  from_entity	entity.PlayStage
  from_category_slug	{ adventure }
  from_slug	{ 1-4-10 }

  
  

  GetConsumable

  player_uuid	{ player_uuid }
  character_uuid	TentuPlayKeyword.DUMMY_CHARACTER_ID
  item_slug	{ large potion of experience }
  item_quantity	29
  from_entity	entity.PlayStage
  from_category_slug	{ adventure }
  from_slug	{ 1-4-10}

  
  

  GetEquipment

  player_uuid	{ player_uuid }
  character_uuid	TentuPlayKeyword.DUMMY_CHARACTER_ID
  item_slug	{ 1 star dagger }
  item_quantity*	1
  from_entity	entity.PlayStage
  from_category_slug	{ adventure }
  from_slug	{ 1-4-10 }