Class Story

A Twine story.

Hierarchy

Story

Index

Constructors

Properties

attributes javascript passages startPassage? stylesheet

Methods

mergeJavaScript mergeStory mergeStylesheet setStartByName toHTML toTwee fromHTML fromTWS fromTwee

Constructors

constructor

new Story(props?): Story
Parameters
- props: StoryOptions = {}
Returns Story
- Defined in src/story.ts:91

Properties

attributes

attributes: Record<string, unknown>

General attributes of the story itself, like name or startnode. These appear on the <tw-storydata> element when published.

javascript

javascript: string

The story's custom JavaScript.

passages

passages: Passage[]

Passages in the story.

`Optional` startPassage

startPassage?: Passage

The start passage of the story, if one exists. This should always be a member of passages.

stylesheet

stylesheet: string

The story's custom stylesheet.

Methods

mergeJavaScript

mergeJavaScript(source): Story
Merges JavaScript source into this story, adding to any existing.
Parameters
- source: string
  
  Source JavaScript to add
Returns Story
- Defined in src/story.ts:408

mergeStory

mergeStory(story): Story
Merges the contents of another story object with this one.
Parameters
- story: Story
  
  Other story to merge with; will not be modified
Returns Story
- Defined in src/story.ts:374

mergeStylesheet

mergeStylesheet(source): Story
Merges CSS source into this story, adding to any existing.
Parameters
- source: string
  
  Source CSS to add
Returns Story
- Defined in src/story.ts:417

setStartByName

setStartByName(name): Story
Sets the start attribute to a named passage. If the passage with this name doesn't exist, this throws an error.
Parameters
- name: string
  
  Passage name
Returns Story
- Defined in src/story.ts:426

toHTML

toHTML(): string
Returns a Twine 2 HTML fragment for this story. Normally, you'd use a StoryFormat to bind it as a complete HTML page.

Returns string
- Defined in src/story.ts:443

toTwee

toTwee(tweeVersion?, passageSpacer?): 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 Twee to use
- passageSpacer: string = '\n\n'
  
  text to output between passages, e.g. one or more newlines
Returns string

See
https://github.com/iftechfoundation/twine-specs/blob/master/twee-3-specification.md
- Defined in src/story.ts:489

`Static` fromHTML

fromHTML(source, twineVersion?, silent?): Story
Creates an instance from HTML source. This converts from Twine 1 attribute names to Twine 2 attribute names where possible. Where a mapping isn't possible, the attributes are set as-is.
Parameters
- source: string
  
  source HTML to use
- twineVersion: number = 2
  
  Twine version used to created the HTML--must be either 1 or 2
- silent: boolean = false
  
  If true, doesn't issue any console warnings about potential problems
Returns Story
- Defined in src/story.ts:111

`Static` fromTWS

fromTWS(buffer): Story
Creates an instance from TWS (or Twine 1) source. This converts from Twine 1 attribute names to Twine 2 attribute names where possible. Where a mapping isn't possible, the attributes are set as-is.
Parameters
- buffer: Uint8Array | Int8Array | Uint8ClampedArray
Returns Story
- Defined in src/story.ts:319

`Static` fromTwee

fromTwee(source, tweeVersion?, silent?): Story
Creates an instance from Twee source.
Parameters
- source: string
  
  Twee source
- tweeVersion: number = 1
  
  version of Twee to use
- silent: boolean = false
Returns Story

See
https://github.com/iftechfoundation/twine-specs/blob/master/twee-3-specification.md
- Defined in src/story.ts:215

Generated using TypeDoc