Class Engine

applyTheme

Readonly currentPassage

Readonly globals

Readonly history

Readonly loading

Readonly saveDB

Readonly title

Static Readonly engine

locals

• get locals(): object

• The locals object of the current story Moment.

  Returns object

passages

• get passages(): (() => IterableIterator<Passage>)

• Get all Passages.

  Returns (() => IterableIterator<Passage>)

  • • (): IterableIterator<Passage>

    • Returns an iterable of values in the array

      Returns IterableIterator<Passage>

addPassages

• addPassages(passages): void

• Add Passages to the engine. This should only be called during initialization.

  Parameters

  • passages: Passage[]

  Returns void

goTo

• goTo(passage, locals?): void

• Adds a new Moment to the history with the specified Passage and sets it as the current Moment. Optionally you can pre-set local variables.

  Parameters

  • passage: Passage
  • locals: object = {}

  Returns void

initHistory

• initHistory(h): void

• Sets the initial History if no history could be found in session storage. Initiates an autoload if autoload is enabled and no session history is found.

  Parameters

  • h: History

  Returns void

loadTheme

• loadTheme(): null | Theme

• Loads a Theme from local storage.

  Returns null | Theme

passage

• passage(name): undefined | Passage

• Gets a Passage by its name.

  Parameters

  • name: string

  Returns undefined | Passage

passageAt

• passageAt(i): Passage

• Gets a Passage by its index.

  Parameters

  • i: number

  Returns Passage

saveSession

• saveSession(): void

• Tries to save the current save in session storage, if small enough and enabled.

  Returns void

saveTheme

• saveTheme(t): void

• Saves a Theme to local storage.

  Parameters

  • t: Theme

  Returns void