Idle game
Call the following methods if your game is an idle game whose core strategy is to leave the game playing itself with least or no player interaction.
Start and end stage
Not all stages are recorded since they are too frequent in idle games where stages can be played automatically. Instead, stages are divided into larger blocks by designated hurdles such as boss stages or every consecutive 10 stages.
Call PlayStage to collect the start and end of each stage block.
The following example shows how to apply the PlayStage method in order to record the start and end of each stage block divided by a hurdle when a hurdle is set in every 10 stages.
| Method | Parameter | Type | Required | Notes |
|---|---|---|---|---|
player_uuid |
string |
Required |
||
character_uuids |
string |
Required |
|
|
stage_type |
Required |
|
||
stage_slug |
string |
Required |
|
|
stage_category_slug |
string |
Optional |
|
|
stage_level |
string |
Optional |
|
|
stage_score |
int |
Optional |
null |
|
stage_status |
Optional |
|
||
stage_playtime |
int |
Optional |
null |
| Method | Parameter | Type | Required | Notes |
|---|---|---|---|---|
player_uuid |
string |
Required |
||
character_uuids |
string |
Required |
|
|
stage_type |
Required |
|
||
stage_slug |
string |
Required |
|
|
stage_category_slug |
string |
Optional |
|
|
stage_level |
string |
Optional |
|
|
stage_score |
int |
Optional |
null |
|
stage_status |
Optional |
|
||
stage_playtime |
int |
Optional |
null |
| Method | Parameter | Type | Required | Notes |
|---|---|---|---|---|
player_uuid |
string |
Required |
||
character_uuids |
string |
Required |
|
|
stage_type |
Required |
|
||
stage_slug |
string |
Required |
|
|
stage_category_slug |
string |
Optional |
|
|
stage_level |
string |
Optional |
|
|
stage_score |
int |
Optional |
null |
|
stage_status |
Optional |
|
||
stage_playtime |
int |
Optional |
null |
Get and use currency
Unlike Hard Currency (currency earned through cash payment), Soft Currency (currency earned by playing game) earnings are not recorded because they are too frequent in idle games.
While the GetCurrency method is used to record earnings of Hard Currency only, the UseCurrency method is used to record the consumption of both Soft Currency and Hard Currency.
-
Call
UseCurrencyandGetInfrastructureif a user acquires an infrastructure object that affects the style and pace of the entire game.When opening a new infrastructure with gold Method Parameter Type Required Notes player_uuid
string
Required
character_uuid
string
Required
TentuPlayKeyword._DUMMY_CHARACTER_ID_currency_slug
string
Required
goldcurrency_quantity
float
Required
2500currency_total_quantity
float
Optional
285700where_to_entity
Optional
entity.GetInfraStructurewhere_to_category_slug
string
Optional
customer tablewhere_to_slug
string
Optional
customer table number 2When opening a new infrastructure with cash Method Parameter Type Required Notes player_uuid
string
Required
character_uuid
string
Required
TentuPlayKeyword._DUMMY_CHARACTER_ID_currency_slug
string
Required
cashcurrency_quantity
float
Required
20currency_total_quantity
float
Optional
26where_to_entity
Optional
entity.GetInfraStructurewhere_to_category_slug
string
Optional
customer tablewhere_to_slug
string
Optional
customer table number 2Acquiring a new infrastructure Method Parameter Type Required Notes player_uuid
string
Required
character_uuid
string
Required
TentuPlayKeyword._DUMMY_CHARACTER_ID_item_slug
string
Required
customer table number 2item_quantity
float
Required
1from_entity
Optional
entity.UseCurrencyfrom_category_slug
string
Optional
customer tablefrom_slug
string
Optional
customer table number 2 -
Call
GetBonusandGet{ Object }when a certain object is earned as a bonus.-
If a user has to take an action such as clicking or touching the screen to earn the bonus, put
FALSEin theis_automatedparameter of theGetBonusmethod. -
If the bonus earning process is automatic, input
TRUE.
Method Parameter Type Required Notes player_uuid
string
Required
character_uuid
string
Required
TentuPlayKeyword._DUMMY_CHARACTER_ID_bonus_slug
string
Required
skill pointbonus_category_slug
string
Required
customer tableis_automated
boolean
Optional
FALSEMethod Parameter Type Required Notes player_uuid
string
Required
character_uuid
string
Required
TentuPlayKeyword._DUMMY_CHARACTER_ID_currency_slug
string
Required
cashcurrency_quantity
float
Required
5currency_total_quantity
float
Optional
46from_entity
Optional
entity.GetBonusfrom_category_slug
string
Optional
customer tablefrom_slug
string
Optional
upgrade to level 10 -
-
Call
UseCurrencyandLevelUpInfrastructurewhen a currency is paid to upgrade a certain object.Method Parameter Type Required Notes player_uuid
string
Required
character_uuid
string
Required
TentuPlayKeyword._DUMMY_CHARACTER_ID_currency_slug
string
Required
goldcurrency_quantity
float
Required
128930currency_total_quantity
float
Optional
342300where_to_entity
Optional
entity.LevelUpInfrastructrewhere_to_category_slug
string
Optional
customer tablewhere_to_slug
string
Optional
customer table number 1Method Parameter Type Required Notes player_uuid
string
Required
character_uuid
string
Required
TentuPlayKeyword._DUMMY_CHARACTER_ID_item_slug
string
Required
customer table number 1item_level_to
int
Required
10item_level_from
int
Optional
1