NarraLeaf

Types

Index of the NarraLeaf-React type reference: the configuration objects, unions and helper types the rest of the documentation refers to, grouped by the part of the framework they belong to.

Every configuration object, union and helper type named elsewhere in this documentation has a page here. Each one states the shape of the type, what its fields mean, and which API accepts it.

The groups below follow the part of the framework a type is defined for. A type used in several places is listed once, under the part it was written for.

Story and actions

The types a scene body is written in, and the context an action or condition receives while it runs.

Dialogue and text

What a line of dialogue is made of, how a character is configured, and the component slot that draws the dialog box.

One option in a menu: its prompt, the actions it leads to, and the conditions that disable or hide it.

Images, layers and color

The configuration of everything drawn on the stage, from a single image to the scene it sits in, and the color values they accept.

Position and animation

Where a displayable sits on the stage, and the easing, timing and properties a transform animates.

Audio

A sound’s own configuration, and the buses a game mixes it through.

Saves and stored data

The shape of a save file, the namespaced values it carries, and the backlog recorded alongside it.

Game configuration and runtime

What new Game() accepts, the player-facing preferences, the replaceable UI slots, and the tokens returned by the runtime.

On this page