Type Alias: PassageTarget

PassageTarget = Passage | string

Defined in: packages/core/src/passages/passage.ts:132

Anything the engine accepts as a navigation target.

Either a passage instance — a Story, an InteractiveMap, a Widget, or any other Passage subclass — or the id of a registered passage.

Remarks

Passing the instance is preferred: the id is read from the object, so a renamed passage cannot silently become a dead link. Accepted by Game.jumpTo(), Game.setCurrent(), the startPassage option and the jump() helper.

Example

import { defineStory, Game } from '@react-text-game/core';

const chapter1 = defineStory('chapter-1', (h) => [h.text('...')]);

Game.jumpTo(chapter1);    // passage instance
Game.jumpTo('chapter-1'); // registered passage id