Global

Methods

(async) _choiceHandler()

Handles choices made by clicking on a chat message

continueSession(sessionData)

Steps an inkStory forward, notifying any listeners by calling hooks to send them new data.

Parameters:
Name Type Description
sessionData Object | serde.SessionData

Information about the story being resumed

Properties
Name Type Description
name String

the name of the binding in ink by the when bound by the EXTERNAL command or called as a function.
sessionData SessionData

information about the session that will be used to rebind the external function.
externalFn function

the binding to be serialized (deserializing this is effectively eval running at the privilege of a macro).
Fires:
  • foundry-ink.event:loadSession
  • foundry-ink.event:bindExternalFunctions
  • foundry-ink.event:deliverLines
  • foundry-ink.event:currentTags
  • foundry-ink.event:deliverFrame
  • foundry-ink.event:deliverChoices
  • foundry-ink.event:deliverPage
  • foundry-ink.event:saveSession

suppressVisited()

Suppresses DOM listeners on visited choices