Upgrade

Call the following methods if your game contains upgrading contents for character or equipment.

Upgrade character

Upgrade character statistics

Call ChangeStat when a character’s ability statistics change due to level up or character upgrade.

Method

Parameter

Type

Required

Notes

Stat A

Stat B

Stat C

ChangeStat

player_uuid

string

Required

character_uuid

string

Required

stat_slug

string

Required

HP

attack speed

attack speed

stat_to

int

Required

12950

5478

1900

stat_from

int

Optional

12752

5394

1870

stat_category_slug

string

Optional

Level up character

Call LevelUpCharacter and Use{ Object } methods when an object is used to level up a character.

The following example assumes that UseConsumable method is called because a consumable item is used to level up.

Method Parameter Type Required Notes

UseConsumable

player_uuid

string

Required

character_uuid

string

Required

item_slug

string

Required

Great potion of experience

item_quantity

float

Required

1

where_to_entity

Optional

entity.LevelUpCharacter

where_to_category_slug

string

Optional

level

where_to_slug

string

Optional

level
Method Parameter Type Required Notes

LevelUpCharacter

player_uuid

string

Required

character_uuid

string

Required

level_to

int

Required

2

level_from

int

Optional

1

Upgrade character

Call the following methods when a character is upgraded.

  • Call UseCurrency when a currency is needed to upgrade character.

    Method Parameter Type Required Notes

    UseCurrency

    player_uuid

    string

    Required

    character_uuid

    string

    Required

    currency_slug

    string

    Required

    gold

    currency_quantity

    float

    Required

    10800

    currency_total_quantity

    float

    Optional

    99999

    where_to_entity

    Optional

    entity.ChangeCustomAbility

    where_to_category_slug

    string

    Optional

    next level

    where_to_slug

    string

    Optional

    next level

  • Call UseMaterial when a material is used to upgrade character.

    Method Parameter Type Required Notes

    UseMaterial

    player_uuid

    string

    Required

    character_uuid

    string

    Required

    item_slug

    string

    Required

    Kylie’s anima

    item_quantity

    float

    Required

    30

    where_to_entity

    Optional

    entity.ChangeCustomAbility

    where_to_category_slug

    string

    Optional

    next level

    where_to_slug

    string

    Optional

    next level

  • Call ChangeCustomAbility when a character is upgraded.

    Method Parameter Type Required Notes

    ChangeCustomAbility

    player_uuid

    string

    Required

    character_uuid

    string

    Required

    custom_ability_slug

    string

    Required

    next level

    custom_ability_to

    int

    Required

    1

    custom_ability_category_slug

    string

    Optional

    next level

    custom_ability_from

    int

    Optional

    0

Change character job class

Call ChangeCharacterArchetype when a character’s job class or original form changes.

Method Parameter Type Required Notes

CharacterArchetype

player_uuid

string

Required

character_uuid

string

Required

characterarchetype_to_slug

string

Required

sword man

characterarchetype_from_slug

float

Optional

knight

Upgrade skill

Call the following methods when a currency is paid to level up skills.

  • Call UseCurrency when a currency is paid to level up skills.

    Method Parameter Type Required Notes

    UseCurrency

    player_uuid

    string

    Required

    character_uuid

    string

    Required

    currency_slug

    string

    Required

    gold

    currency_quantity

    float

    Required

    10000

    currency_total_quantity

    float

    Optional

    99999

    where_to_entity

    Optional

    entity.LevelUpSkill

    where_to_category_slug

    string

    Optional

    movement skill

    where_to_slug

    string

    Optional

    movement skill

  • Call LevelUpSkill when a skill levels up.

    Method Parameter Type Required Notes

    LevelUpSkill

    player_uuid

    string

    Required

    character_uuid

    string

    Required

    skill_slug

    string

    Required

    movement skill

    skill_level_to

    int

    Required

    2

    skill_category_slug

    string

    Optional

    movement skill

    skill_level_from

    int

    Optional

    1

Upgrade equipment

Call the following methods when either currency or material is used to upgrade equipment.

  • Call UseCurrency when a currency is paid to upgrade equipment.

    Method Parameter Type Required Notes

    UseCurrency

    player_uuid

    string

    Required

    character_uuid

    string

    Required

    currency_slug

    string

    Required

    gold

    currency_quantity

    float

    Required

    10800

    currency_total_quantity

    float

    Optional

    99999

    where_to_entity

    Optional

    entity.ChangeCustomAbility

    where_to_category_slug

    string

    Optional

    upgrade

    where_to_slug

    string

    Optional

    sword of ancient goddess

  • Call UseMaterial when a material is used to upgrade an equipment.

    Even if the object used to upgrade an equipment is an equipment, you still have to call UseMaterial because the object is used as a material, not an equipment.

    Method

    Parameter

    Type

    Required

    Notes

    Material A

    Material B

    Material C

    UseMaterial

    player_uuid

    string

    Required

    character_uuid

    string

    Required

    item_slug

    string

    Required

    2 star water sword

    2 star knights sword

    2 star knowledge of water

    item_quantity

    float

    Required

    1

    1

    1

    where_to_entity

    Optional

    entity.ChangeCustomAbility

    where_to_category_slug

    string

    Optional

    upgrade

    where_to_slug

    string

    Optional

    3 star ultimate water sword

  • Call LevelUpEquipment to record the result of equipment upgrade.

    Method Parameter Type Required Notes

    LevelUpEquipment

    player_uuid

    string

    Required

    character_uuid

    string

    Required

    item_slug

    string

    Required

    3 star ultimate water sword

    item_level_to

    int

    Required

    13

    item_level_from

    int

    Optional

    12