Actions
What are actions?

Actions are operations you can do to manipulate the {scenes}, {objects} in a {scene} or the flow of the story. Every scene has a list of actions that are executed sequentially from top to bottom (unless there is an action that changes this behaviour).

Actions' Catalog
Branch

Creates a branch in the story. In other words, it evaluates a condition and executes a list of actions if the condition is true or another list if it's false. The actions available to use are any of the actions listed on this page.

Change Background

Changes the current scene's background. The new background can be either a color or an image.

Change Color

Changes the color or background color of any object on the scene.

Dialogue

The dialogue action is used for displaying text in a {TextBox} or {DialogueBox}. You can choose any {TextBox} or {DialogueBox} currently available in a scene.

Wait

The wait action blocks the execution of the game according to one of the following criteria:

  • For a period of time (in seconds).
  • Until left mouse button is clicked.
  • Forever.
End Novel

Terminates the game completly.

Go To Scene

Jumps execution to the beginning of a {Scene}. The {Scene} name is needed for this action.

Go To Label

This action allows you to jump to a {Label} in the current {Scene}.

Show

Shows any object available in the scene. It's possible to append some effects/transitions like {Slide} and {Fade}.

Hide

Works the same as {Show} except it hides the object instead of showing it. The same effects/transitions that are available for {Show} are also available for this action aswell.

Label

Defines a label. Labels are used for creating "restore" points in the same scene, therefore, Labels give more flexibility and organization.

Fade

Fades any object in the scene. It can either fade in, making the object visible, or fade out, making the object invisible.
Note: By rendering the object invisible with this action, isn't the same as hidding it using {Hide}. The object will still receive all kind of events and will still be painted (with full transparency).

Slide

Slides any object in the scene in any direction.
It makes the object slide from a start point to an end point. These two points represent the top left point of the rectangle that limits the object.

Show Menu

Displays a menu with a set of choices (buttons) for the player to select. Each choice can be associated with a list of actions that will be executed in case the choice gets selected.
The actions available for a choice are any of the actions listed on this page.

Play Sound

Plays a sound. Not all sound formats work, for more information check the {audio section} of the engine.

Stop Sound

Stops a sound previously set to play. It requires the name of the {PlaySound} action or the name of the file.

Set Game Variable

Sets a value in a game variable.
In case the game variable doesn't exist, it's automatically created, otherwise the previous value is overwritten.
The value can be either text, numbers or both. If the value is just made by numbers, you can make arithmetic operations with the variable that contains it.

Get User Input

Displays a dialog box where the player can insert text. This text can be saved in a game variable for later use.