MMORPG

Call the following methods if your game is a massively multiplayer online role-playing game (MMORPG), such as Lineage 2M where a player assumes a role of a character and explores an open world.

Enter and exit from map

  • Call PlayStage when a character enters or exits from a certain map.

    Entering a map
    Method Parameter Type Required Notes

    PlayStage

    player_uuid

    string

    Required

    character_uuids

    string

    Required

    stage_type

    Required

    stageType.PvE

    stage_slug

    string

    Required

    Denev Village

    stage_category_slug

    string

    Optional

    safe zone

    stage_level

    string

    Optional

    null

    stage_score

    int

    Optional

    null

    stage_status

    Optional

    stageStatus.Start

    stage_playtime

    int

    Optional

    null
    Exiting from the map
    Method Parameter Type Required Notes

    PlayStage

    player_uuid

    string

    Required

    character_uuids

    string

    Required

    stage_type

    Required

    stageType.PvE

    stage_slug

    string

    Required

    Denev Village

    stage_category_slug

    string

    Optional

    safe zone

    stage_level

    string

    Optional

    null

    stage_score

    int

    Optional

    null

    stage_status

    Optional

    stageStatus.Win

    stage_playtime

    int

    Optional

    30

  • Call UseCurrency or UseConsumable besides PlayStage when a currency or an item is paid to enter or exit a certain map.

    • If a character exits from a map and enters a new map, PlayStage needs to be called twices: first call about the exit of previous map and the second one about the entrance of new map.

    • Put stageStatus.Win in stage_status within the PlayStage method for exiting the previous map.
    Method Parameter Type Required Notes

    UseCurrency

    player_uuid

    string

    Required

    character_uuid

    string

    Required

    currency_slug

    string

    Required

    deal

    currency_quantity

    float

    Required

    10000

    currency_total_quantity

    float

    Optional

    999999

    where_to_entity

    Optional

    entity.PlayStage

    where_to_category_slug

    string

    Optional

    public zone

    where_to_slug

    string

    Optional

    golden field
    Exiting form the previous map
    Method Parameter Type Required Notes

    PlayStage

    player_uuid

    string

    Required

    character_uuids

    string

    Required

    stage_type

    Required

    stageType.PvE

    stage_slug

    string

    Required

    Denev Village

    stage_category_slug

    string

    Optional

    safe zone

    stage_level

    string

    Optional

    null

    stage_score

    int

    Optional

    null

    stage_status

    Optional

    stageStatus.Win

    stage_playtime

    int

    Optional

    30
    Entering a new map
    Method Parameter Type Required Notes

    PlayStage

    player_uuid

    string

    Required

    character_uuids

    string

    Required

    stage_type

    Required

    stageType.PvP

    stage_slug

    string

    Required

    golden field

    stage_category_slug

    string

    Optional

    public zone

    stage_level

    string

    Optional

    23

    stage_score

    int

    Optional

    null

    stage_status

    Optional

    stageStatus.Start

    stage_playtime

    int

    Optional

    null

Get item

Call Get{ Object } when an object such as currency or equipment is earned during play.

  • Call GetCurrency if a currency is earned during play.

    Method Parameter Type Required Notes

    GetCurrency

    player_uuid

    string

    Required

    character_uuid

    string

    Required

    currency_slug

    string

    Required

    deal

    currency_quantity

    float

    Required

    100

    currency_total_quantity

    float

    Optional

    99999

    from_entity

    Optional

    entity.PlayStage

    from_category_slug

    string

    Optional

    public zone

    from_slug

    string

    Optional

    golden field

  • Call GetMaterial if a material item is earned during play.

    Method Parameter Type Required Notes

    GetMaterial

    player_uuid

    string

    Required

    character_uuid

    string

    Required

    item_slug

    string

    Required

    steel

    item_quantity

    float

    Required

    1

    from_entity

    Optional

    entity.PlayStage

    from_category_slug

    string

    Optional

    public zone

    from_slug

    string

    Optional

    golden field

  • Call GetEquipment if an equipment item is earned during play.

    Method Parameter Type Required Notes

    GetEquipment

    player_uuid

    string

    Required

    character_uuid

    string

    Required

    item_slug

    string

    Required

    Lizards Bow

    item_quantity

    float

    Required

    1

    from_entity

    Optional

    entity.PlayStage

    from_category_slug

    string

    Optional

    public zone

    from_slug

    string

    Optional

    golden field

  • Call GetConsumable if a consumable item such as potion is earned during play.

    Method Parameter Type Required Notes

    GetConsumable

    player_uuid

    string

    Required

    character_uuid

    string

    Required

    item_slug

    string

    Required

    ancient scroll of power

    item_quantity

    float

    Required

    1

    from_entity

    Optional

    entity.PlayStage

    from_category_slug

    string

    Optional

    public zone

    from_slug

    string

    Optional

    golden field

Change character stat

Call ChangeStat if a character’s statistics are changed during play.

Method Parameter Type Required Notes

ChangeStat

player_uuid

string

Required

Notes

character_uuid

string

Required

stat_slug

string

Required

strength

stat_to

int

Required

19

stat_from

int

Optional

18

stat_category_slug

string

Optional

basic stat

Level up character

Call LevelUpCharacter if a character levels up during play.

Method Parameter Type Required Notes

LevelUpCharacter

player_uuid

string

Required

character_uuid

string

Required

level_to

int

Required

14

level_from

int

Optional

Character KIA

  • Call PlayStage if a character is killed in action (KIA) during play.

    Put stageStatus.Lose in the stage_status parameter.
    Method Parameter Type Required Notes

    PlayStage

    player_uuid

    string

    Required

    character_uuids

    string

    Required

    stage_type

    Required

    stageType.PvP

    stage_slug

    string

    Required

    golden field

    stage_category_slug

    string

    Optional

    public zone

    stage_level

    string

    Optional

    23

    stage_score

    int

    Optional

    null

    stage_status

    Optional

    stageStatus.Lose

    stage_playtime

    int

    Optional

    null

  • If there exists a penalty (for example, losing items) for KIA, call Dismiss{ Object } as well.

    In the following example, DismissEquipment is used because an equipment is lost as a penalty for being KIA.

    Method Parameter Type Required Notes

    DismissEquipment

    player_uuid

    string

    Required

    character_uuid

    string

    Required

    item_slug

    string

    Required

    +6 long sword

    item_quantity

    string

    Required

    1

Equip equipment, skill, or pet

Equip pet

Call the following methods below when a player equips and uses 'pet' to support his battle:

  • Call EquipPet when a character is equipped with a pet.

    Method Parameter Type Required Notes

    EquipPet

    player_uuid

    string

    Required

    Notes

    character_uuid

    string

    Required

    item_slug

    string

    Required

    tiny unicorn

    equip_status

    Required

    equipStatus.Equip

    item_level

    int

    Optional

    7

    character_level

    int

    Optional

    14

  • Call PlayStageWith when a character enters a map with a pet equipped.

    Method Parameter Type Required Notes

    PlayStageWithPet

    player_uuid

    string

    Required

    character_uuids

    string

    Required

    item_slug

    string

    Required

    tiny unicorn

    stage_slug

    string

    Required

    golden field

    stage_type

    Optional

    stageType.PvP

    stage_category_slug

    string

    Optional

    public zone

Equip equipment

Call the following methods when a player equips equipments to his character and conducts a battle with the equipments.

  • Call EquipEquipment and PlayStageWithEquipment as shown in following example if a player add equipments to an empty slot and play with them.

    1. Call EquipEquipment when equipments are equipped.

      Equipped in an empty slot

      Method

      Parameter

      Type

      Required

      Notes

      Item A

      Item B

      EquipEquipment

      player_uuid

      string

      Required

      character_uuid

      string

      Required

      item_slug

      string

      Required

      +6 long sword

      +1 thin armor

      equip_status

      Required

      equipStatus.Equip

      item_level

      int

      Optional

      6

      1

      character_level

      int

      Optional

      14

    2. Call PlayStageWithEquipment when a character enters a map with the equipments.

      Method

      Parameter

      Type

      Required

      Notes

      Item A

      Item B

      PlayStageWithEquipment

      player_uuid

      string

      Required

      character_uuid

      string

      Required

      item_slug

      string

      Required

      +6 long sword

      +1 thin armor

      stage_slug

      string

      Optional

      golden field

      stage_type

      Optional

      stageType.PvP

      stage_category_slug

      string

      Optional

      public zone

  • Call EquipEquipment and PlayStageWithEquipment as shown in the following example if a character switches between equipments.

    1. Call EquipEquipment when the existing equipment is removed from the slot.

      Existing equipment dismissed
      Method Parameter Type Required Notes

      EquipEquipment

      player_uuid

      string

      Required

      character_uuid

      string

      Required

      item_slug

      string

      Required

      +6 long sword

      equip_status

      Required

      equipStatus.Unequip

      item_level

      int

      Optional

      6

      character_level

      int

      Optional

      14

    2. Call EquipEquipment again when a new equipment is equipped.

      New equipment equipped
      Method Parameter Type Required Notes

      EquipEquipment

      player_uuid

      string

      Required

      character_uuid

      string

      Required

      item_slug

      string

      Required

      +10 long sword

      equip_status

      Required

      equipStatus.Equip

      item_level

      int

      Optional

      10

      character_level

      int

      Optional

      14

    3. Call PlayStageWithEquipment when a character enters a map with the new equipment equipped.

      Playing with new equipment
      Method Parameter Type Required Notes

      PlayStageWithEquipment

      player_uuid

      string

      Required

      character_uuid

      string

      Required

      item_slug

      string

      Required

      +10 long sword

      stage_slug

      string

      Optional

      golden field

      stage_type

      Optional

      stageType.PvP

      stage_category_slug

      string

      Optional

      public zone

Equip skill

Call EquipSkill and PlayStageWithSkill when a character is equipped with a certain skill to play.

  • Call EquipSkill when a character equips or unequips a new skill.

    Method Parameter Type Required Notes

    EquipSkill

    player_uuid

    string

    Required

    character_uuid

    string

    Required

    skill_slug

    string

    Required

    strength

    skill_category_slug

    string

    Optional

    passive

    equip_status

    Required

    equipStatus.Equip

    skill_level

    int

    Optional

    3

    character_level

    int

    Optional

    14

  • When a player enters a map with the new skill, call PlayStageWithSkill.

    Method Parameter Type Required Notes

    PlayStageWithSkill

    player_uuid

    string

    Required

    character_uuid

    string

    Required

    skill_slug

    string

    Required

    strength

    skill_category_slug

    string

    Optional

    passive

    stage_slug

    string

    Required

    golden field

    stage_type

    Optional

    stageType.PvP

    stage_category_slug

    string

    Optional

    public zone