Skip to main content

CharacterCreationPage

The main construct for pages in the character creation flow. The character will only be saved after all the steps have been completed successfully.

A character creation page can also be displayed to allow the user to edit their character. You can make use of the special stat $is_new in your effects (or even in the view) if you need to conditionally do things / display things only when the player is creating a new character. As the name implies, $is_new is a bool stat.

JSON Format​

{
  "type": "CharacterCreationPage",
  "title": ...,
  "view": ...,
  "on_page_open": ...,
  "pre_edit": ...,
  "post_edit": ...,
  "on_page_close": ...
}

Fields​

FieldTypeRequiredDescription
titleDisplayableData✓The title of the character creation page.
viewRPGView✓The view for this character creation step.
on_page_openEffectThis effect will be executed every time this step is opened. If you do something in this effect that needs undoing, you should use its counterpart, the on_page_close effect.
pre_editEffectThis effect will execute whenever this step is first opened. So, it will only be executed once in the character creation flow. In contrast, on_page_open will be executed as many times as the page is displayed on the screen.
post_editEffectThis effect will execute after the player saves their character (ie: after going through the entire flow, or after hitting save when editing their character). Because it's not guaranteed that this effect will be called (as the player can always dismiss the edit or creation), you should only do things that should happen upon saving here. In contrast, the on_page_close effect will be executed as many times as the page is closed (ie: stops showing on the screen).
on_page_closeEffectThis effect will be executed every time this step is closed. This effect is particularly useful for undoing changes made by the on_page_open effect.