Skip to main content

Dialogue & Menus

Display Dialogue​

Show a dialogue box at the bottom of the game screen. When text is shown the dialogue box will slide up from the bottom of the screen and will slide down after it has been shown.

Display Dialogue
Text
Layout
Behavior
Presets
Text...
Avatar
Avatar 1

  • Text

    • Avatar: The avatar image to optionally display on the left hand side of the dialogue box.

  • Layout

    • Min Height: The minimum height to draw the dialogue window.
    • Max Height: The maxiumum height to draw the dialogue window.
    • Text X: The horizontal offset to start drawing text in the dialogue window.
    • Text Y: The vertical offset to start drawing text in the dialogue window.
    • Scroll Height: The number of lines of text that can be displayed before scrolling.
    • Position: The position to place the dialogue window.
    • Clear Previous: Clears any content that was previously drawn on the overlay.
    • Show Frame: Draw a frame around the border of the dialogue window.

  • Behavior

    • Text Open Speed: The speed that the text and menu dialogue boxes scroll on to the screen.
    • Text Close Speed: The speed that the text and menu dialogue boxes scroll off of the screen.
    • Close When...: The condition which will cause the dialogue window to close.
    • Close Delay: Delay closing for a period of time.

Display Menu​

Display a menu of multiple options and set the specified variable to the value of the chosen option. Multiple layouts are provided, 'Menu' displays as a single column on the right hand side of the game screen and 'Dialogue' displays a full width dialogue box with two columns. You can optionally set the 'B' button to close the menu setting the variable to '0' and can also make the last menu item return '0' when selected.

Display Menu
Set Variable
$Variable0
Number of options
2
Set to '1' if
Item 1
Set to '2' if
Item 2
Last option sets to '0'
Set to '0' if 'B' is pressed
Layout
Dialogue
  • Set Variable: The variable to use.
  • Number of options: The number of options required.
  • Set to '1' if: The menu item text label which when selected will set variable to '1'.
  • Set to '2' if: The menu item text label which when selected will set variable to '2'.
  • Last option sets to '0': Set if last menu item should cause variable to become '0' when selected.
  • Set to '0' if 'B' is pressed: Set if pressing 'B' should cause menu to close and variable to become '0'.
  • Layout: Set the layout style of the menu.

Display Multiple Choice​

Present two options to player allowing them to make a choice, will set the specified variable to true if the first option is chosen and to false if the second option is chosen.

Display Multiple Choice
Set Variable
$Variable0
Set to 'True' if
Choice A
Set to 'False' if
Choice B
  • Set Variable: The variable to use.
  • Set to 'True' if: The menu item text label which when selected will set variable to 'true'.
  • Set to 'False' if: The menu item text label which when selected will set variable to 'false'.

Draw Text​

Write some text to a specified positon on either the scene's background or the overlay.

Draw Text
Text...
X
1
Y
1
Location
Background
  • X: The horizontal position.
  • Y: The vertical position.
  • Location: The location where text should be drawn.

Music & Sound Effects​

Set Text Sound Effect​

Set a sound effect to play as each text character is displayed.

Set Text Sound Effect
Sound Effect
Beep
Frequency in hz
300
Duration
0.05
Effect Index
0
  • Sound Effect: The sound effect to play. Can choose from files within /assets/sounds or from preset sounds like Beep, Pitch and Tone.
  • Pitch: The pitch of the sound effect (Beep effect only).
  • Frequency in hz: The frequency of the sound effect in hz (Tone effect only).
  • Duration: The length of time to play the sound effect.
  • Effect Index: The effect number to play (for fxhammer only).

Properties​

Close Non-Modal Dialogue​

Close any dialogue box or overlay currently on screen and reset the overlay scanline cutoff value.

Close Non-Modal Dialogue
Speed
Speed 1
Only required if you have opened a dialogue box with no close condition
  • Speed: The movement speed.

Set Dialogue Frame​

Set a tileset to replace the dialogue frame image.

Set Dialogue Frame
Frame Image
flowers
Must be a tileset of size 24px x 24px
  • Frame Image: The tileset to use as a dialogue frame.

Set Text Animation Speed​

Set the speed that dialogue boxes appear and disappear and how fast text appears within the box.

Set Text Animation Speed
Text Open Speed
Speed 1
Text Close Speed
Speed 1
Text Draw Speed
Speed 1
Fast forward text while buttons held
  • Text Open Speed: The speed that the text and menu dialogue boxes scroll on to the screen.
  • Text Close Speed: The speed that the text and menu dialogue boxes scroll off of the screen.
  • Text Draw Speed: The speed that characters are drawn into the dialogue boxes.
  • Fast forward text while buttons held: Allow skipping through animation of text if joypad buttons are pressed.