Text Step

Displays narrative text, descriptions, and atmospheric details to create immersive storytelling experiences.

Interface

interface TextStep {
  kind: 'text';
  condition?: string;
  text: string;
  sfx?: SoundEffectName;
}

Properties

kind - Always 'text'

text - The content to display. Supports HTML formatting and templates like {forename}, {surname}, {fullname}, and gender-specific text using {male option|female option}.

condition (optional) - Flag expression that must evaluate to true for the step to execute.

sfx (optional) - Sound effect to play when text appears.

Examples

Basic Text

{
  kind: 'text',
  text: 'You stride towards the edge of the bubbling lake, heat rising with each step.'
}

Using Templates

{
  kind: 'text',
  text: 'Welcome to our sect, {forename}. You are regarded as a promising {young man/young woman} with great potential.'
}