Class Passage

constructor

• new Passage(props?): Passage

• Parameters

  • props: PassageOptions = {}

  Returns Passage

attributes

source

toHTML

• toHTML(pid?): string

• Returns an HTML fragment for this passage, optionally setting the passage id (or pid) manually.

  Parameters

  • Optional pid: number

    PID to set in the published HTML

  Returns string

toTwee

• toTwee(tweeVersion?): string

• Returns Twee source code for this story. Warning: if the Twee version specified is less than 3, this is a lossy conversion.

  Parameters

  • tweeVersion: number = 3

    version of the Twee spec to use

  Returns string

  See

  https://github.com/iftechfoundation/twine-specs/blob/master/twee-3-specification.md

Static fromHTML

• fromHTML(source, silent?): Passage

• Creates an instance from an HTML fragment.

  Parameters

  • source: string

    source HTML to use

  • silent: boolean = false

    If true, doesn't issue any console warnings about potential problems

  Returns Passage