Interface Story<TEffect>

Complete story definition.

A story consists of one or more knots, each containing nodes that represent story beats. The story starts at the entryKnot's entryNode.

interface Story<TEffect> {
    entryKnot: string;
    knots: Record<string, Knot<TEffect>>;
    version: 1;
}

Type Parameters

TEffect = unknown
The type of effects that can be applied in this story

Index

Properties

entryKnot knots version

Properties

entryKnot

entryKnot: string

knots

knots: Record<string, Knot<TEffect>>

version

version: 1