Skip to main content

Type Alias: NewOptions

NewOptions = Pick<Options, "gameName"> & Partial<Omit<Options, "gameName" | "startPassage">> & object

Defined in: packages/core/src/options.ts:44

Type Declaration​

startPassage?​

optional startPassage: PassageTarget

The passage the game opens on.

Accepts a passage instance (Story, InteractiveMap, Widget, or any other Passage) or the id of a registered passage. The passage may register after Game.init(); navigation waits for it.

Example​

import { intro } from './game/stories/intro';

await Game.init({ gameName: 'My Game', startPassage: intro });
await Game.init({ gameName: 'My Game', startPassage: 'intro' });