Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.borntocraftstudio.net/llms.txt

Use this file to discover all available pages before exploring further.

The Option Dialogue entry presents the player with a set of choices. Each choice can trigger different actions, allowing for branching narratives.

​
Configuration

​
text
Var<String>
required
The text content or question displayed above the options.
​
columns
Var<Int>
default:"1"
Number of columns to arrange the option buttons in.
​
speaker
Ref<SpeakerEntry>
Reference to a speaker entry to define who is talking.

​
Options

A list of DialogueOption objects.
​
text
Var<String>
required
Text displayed on the option button.
​
triggers
List<Ref<TriggerableEntry>>
Triggers to run when this option is selected.
​
criteria
List<Criteria>
Criteria required for this option to be visible/selectable.

​
Triggers

​
startTriggers
List<Ref<TriggerableEntry>>
Triggers to fire when this dialogue starts.
​
endTriggers
List<Ref<TriggerableEntry>>
Triggers to fire when the dialogue ends (option selected).
​
cancelTriggers
List<Ref<TriggerableEntry>>
Triggers to fire if the dialogue is cancelled (e.g. via ESC key).
type: dialogue_option
text: "What brings you here?"
options:
  - text: "I'm looking for a quest."
    triggers: [ ... ]
  - text: "Just passing through."
    triggers: [ ... ]