Narrative game

Call the following methods if your game is a narrative game that allows for branching narratives, often in the form of visual novels, with choices made by the player influencing events throught the game.

Get character

Call GetCharacter when a user chooses either a character in the plot or a story path at the branch point.

Choosing a character or a story path
Method Parameter Type Required Notes

GetCharacter

player_uuid

string

Required

character_uuid

string

Required

characterarchetype_slug

string

Required

Justin path

from_entity

Optional

entity.PlayStage

from_category_slug

string

Optional

Justin path

from_slug

string

Optional

Justin path

Start and end stage

Call the following methods when a user decides to start with the chosen character or story plot

  • Call UseCurrency if a currency is needed to start a stage.

    Method Parameter Type Required Notes

    UseCurrency

    player_uuid

    string

    Required

    character_uuid

    string

    Required

    currency_slug

    string

    Required

    TICKET

    currency_quantity

    float

    Required

    1

    currency_total_quantity

    float

    Optional

    3

    where_to_entity

    Optional

    entity.PlayStages

    where_to_category_slug

    string

    Optional

    Justin path

    where_to_slug

    string

    Optional

    1-1

  • Call PlayStage when a stage with the chosen character or story path begins.

    Method Parameter Type Required Notes

    PlayStage

    player_uuid

    string

    Required

    character_uuids

    string

    Required

    TentuPlayKeyword._DUMMY_CHARACTER_ID_, Justin

    stage_type

    Required

    stageType.PvE

    stage_slug

    string

    Required

    1-1

    stage_category_slug

    string

    Optional

    Justin path

    stage_level

    string

    Optional

    1-1

    stage_score

    int

    Optional

    null

    stage_status

    Optional

    stageStatus.Start

    stage_playtime

    int

    Optional

    null

  • Call PlayStage when a stage with the character or story path ends.

    Put a value that represents the result of the stage in stage_status.
    When the user wins or completes the stage
    Method Parameter Type Required Notes

    PlayStage

    player_uuid

    string

    Required

    character_uuids

    string

    Required

    TentuPlayKeyword._DUMMY_CHARACTER_ID_, Justin

    stage_type

    Required

    stageType.PvE

    stage_slug

    string

    Required

    1-1

    stage_category_slug

    string

    Optional

    Justin path

    stage_level

    string

    Optional

    1-1

    stage_score

    int

    Optional

    null

    stage_status

    Optional

    stageStatus.Win

    stage_playtime

    int

    Optional

    30
    When the user leaves or surrenders the stage
    Method Parameter Type Required Notes

    PlayStage

    player_uuid

    string

    Required

    character_uuids

    string

    Required

    TentuPlayKeyword._DUMMY_CHARACTER_ID_, Justin

    stage_type

    Required

    stageType.PvE

    stage_slug

    string

    Required

    1-1

    stage_category_slug

    string

    Optional

    Justin path

    stage_level

    string

    Optional

    1-1

    stage_score

    int

    Optional

    null

    stage_status

    Optional

    stageStatus.Quit

    stage_playtime

    int

    Optional

    30