Essentials Docs Wiki

This page describes the credits screen.

Credits screen

The credits screen displays the game's credits. They are displayed as lines of text that scroll up the screen, while the background image occasionally changes.

It is defined in class UI_Credits. The credits themselves are written in this class, alongside other constants that affect how the credits screen appears. These constants are:

  • BACKGROUNDS_LIST - An array of background images that are displayed during the credits. These images are located in the "Graphics/Titles" folder. Any number of images can be listed here. They are displayed in order, and will loop back to the start of the list if necessary.
  • BGM - The name of the BGM (music) that plays during the credits.
  • SCROLL_SPEED - The speed at which the credits scroll up the screen. Any number greater than 0 can be used (including non-whole numbers), although speeds of around 5 or higher are too fast to be legible.
  • SECONDS_PER_BACKGROUND - The length of time each background image is displayed for, before changing to the next background image.
  • TEXT_OUTLINE_COLOR, TEXT_BASE_COLOR, TEXT_SHADOW_COLOR - The font colors for the credits.

To display the credits, use the following line of code:

$scene =

The credits cannot be skipped (ended early) the first time they are played. However, in subsequent viewings, pressing the C key will immediately exit the credits presentation. This is determined by the value of $PokemonGlobal.creditsPlayed - TRUE means they have already been played at least once and can be skipped in future. This is set to TRUE at the end of playing the credits.

Editing the credits text

The credits text is stored in the constant CREDIT. The space where you should add your own credits is clearly indicated. Please leave the existing credits in the game, at the end of the text.

Each line of text will be centred. However, if there is a <s> in the line, the text will be split into two columns on either side of this, with each column aligned towards the centre of the screen.

The line of text {INSERTS_PLUGIN_CREDITS_DO_NOT_REMOVE} will be replaced by credits from all the plugins in the game. Do not remove this line.