Class StoryEngine

Headless story state machine. Holds no rendering concerns — cyoa-react (or any other consumer) drives its UI off currentNode/availableChoices and calls choose() in response to user input.

Index

Constructors

Accessors

availableChoices currentNode history variables

Methods

back canGoBack choose getSnapshot

Constructors

constructor

new StoryEngine(story: Story): StoryEngine
Parameters
- story: Story
Returns StoryEngine
- Defined in packages/core/src/engine.ts:23

Accessors

availableChoices

get availableChoices(): Choice[]
Choices on the current node whose condition passes against current variables.

Returns Choice[]
- Defined in packages/core/src/engine.ts:49

currentNode

get currentNode(): StoryNode
Returns StoryNode
- Defined in packages/core/src/engine.ts:32

history

get history(): readonly string[]
Returns readonly string[]
- Defined in packages/core/src/engine.ts:40

variables

get variables(): Readonly<Record<string, unknown>>
Returns Readonly<Record<string, unknown>>
- Defined in packages/core/src/engine.ts:44

Methods

back

back(): void
Navigates to the previous node for re-reading. Variables are intentionally NOT reverted — back() is narrative "go re-read" navigation, not a state undo.

Returns void
- Defined in packages/core/src/engine.ts:87

canGoBack

canGoBack(): boolean
Returns boolean
- Defined in packages/core/src/engine.ts:79

choose

choose(choiceIndex: number): void
Advances to currentNode.choices[choiceIndex], applying its effects then the target node's onEnter effects.
Parameters
- choiceIndex: number
Returns void
- Defined in packages/core/src/engine.ts:56

getSnapshot

getSnapshot(): StoryEngineSnapshot
Returns StoryEngineSnapshot
- Defined in packages/core/src/engine.ts:99