extwee
Version:
A story compiler tool using Twine-compatible formats
256 lines (255 loc) • 8.25 kB
TypeScript
/**
* Story class.
* @class
* @classdesc Represents a Twine story.
* @property {string} name - Name of the story.
* @property {string} IFID - Interactive Fiction ID (IFID) of Story.
* @property {string} start - Name of start passage.
* @property {string} format - Story format of Story.
* @property {string} formatVersion - Story format version of Story.
* @property {number} zoom - Zoom level.
* @property {Array} passages - Array of Passage objects. @see {@link Passage}
* @property {string} creator - Program used to create Story.
* @property {string} creatorVersion - Version used to create Story.
* @property {object} metadata - Metadata of Story.
* @property {object} tagColors - Tag Colors
* @property {string} storyJavaScript - Story JavaScript
* @property {string} storyStylesheet - Story Stylesheet
* @method {number} addPassage - Add a passage to the story and returns the new length of the passages array.
* @method {number} removePassageByName - Remove a passage from the story by name and returns the new length of the passages array.
* @method {Array} getPassagesByTag - Find passages by tag.
* @method {Array} getPassageByName - Find passage by name.
* @method {number} size - Size (number of passages).
* @method {string} toJSON - Export Story as JSON representation.
* @method {string} toTwee - Return Twee representation.
* @method {string} toTwine2HTML - Return Twine 2 HTML representation.
* @method {string} toTwine1HTML - Return Twine 1 HTML representation.
* @example
* const story = new Story('My Story');
* story.IFID = '12345678-1234-5678-1234-567812345678';
* story.start = 'Start';
* story.format = 'SugarCube';
* story.formatVersion = '2.31.0';
* story.zoom = 1;
* story.creator = 'extwee';
* story.creatorVersion = '2.2.1';
*/
export class Story {
/**
* Creates a story.
* @param {string} name - Name of the story.
*/
constructor(name?: string);
/**
* @param {string} a - Replacement story name
*/
set name(a: string);
/**
* Each story has a name
* @returns {string} Name
*/
get name(): string;
/**
* @param {object} a - Replacement tag colors
*/
set tagColors(a: object);
/**
* Tag Colors object (each property is a tag and its color)
* @returns {object} tag colors array
*/
get tagColors(): object;
/**
* @param {string} i - Replacement IFID.
*/
set IFID(i: string);
/**
* Interactive Fiction ID (IFID) of Story.
* @returns {string} IFID
*/
get IFID(): string;
/**
* @param {string} s - Replacement start
*/
set start(s: string);
/**
* Name of start passage.
* @returns {string} start
*/
get start(): string;
/**
* @param {string} f - Replacement format version
*/
set formatVersion(f: string);
/**
* Story format version of Story.
* @returns {string} story format version
*/
get formatVersion(): string;
/**
* @param {object} o - Replacement metadata
*/
set metadata(o: object);
/**
* Metadata of Story.
* @returns {object} metadata of story
*/
get metadata(): object;
/**
* @param {string} f - Replacement format
*/
set format(f: string);
/**
* Story format of Story.
* @returns {string} format
*/
get format(): string;
/**
* @param {string} c - Creator Program of Story
*/
set creator(c: string);
/**
* Program used to create Story.
* @returns {string} Creator Program
*/
get creator(): string;
/**
* @param {string} c - Version of creator program
*/
set creatorVersion(c: string);
/**
* Version used to create Story.
* @returns {string} Version
*/
get creatorVersion(): string;
/**
* @param {number} n - Replacement zoom level
*/
set zoom(n: number);
/**
* Zoom level.
* @returns {number} Zoom level
*/
get zoom(): number;
/**
* Set passages in Story.
* @param {Array} p - Replacement passages
* @property {Array} passages - Passages
* @throws {Error} Passages must be an Array!
* @throws {Error} Passages must be an Array of Passage objects!
*/
set passages(p: any[]);
/**
* Passages in Story.
* @returns {Array} Passages
* @property {Array} passages - Passages
*/
get passages(): any[];
/**
* @param {string} s - Replacement story stylesheet
*/
set storyStylesheet(s: string);
/**
* Story stylesheet data can be set as a passage, property value, or both.
* @returns {string} storyStylesheet
*/
get storyStylesheet(): string;
/**
* Set story JavaScript.
* @param {string} s - Replacement story JavaScript
*/
set storyJavaScript(s: string);
/**
* Get story JavaScript.
* @returns {string} storyJavaScript
*/
get storyJavaScript(): string;
/**
* Add a passage to the story.
* Passing `StoryData` will override story metadata and `StoryTitle` will override story name.
* @method addPassage
* @param {Passage} p - Passage to add to Story.
* @returns {number} Return new length of passages array.
*/
addPassage(p: Passage): number;
/**
* Remove a passage from the story by name.
* @method removePassageByName
* @param {string} name - Passage name to remove.
* @returns {number} Return new length of passages array.
*/
removePassageByName(name: string): number;
/**
* Find passages by tag.
* @method getPassagesByTag
* @param {string} t - Passage name to search for
* @returns {Array} Return array of passages
*/
getPassagesByTag(t: string): any[];
/**
* Find passage by name.
* @method getPassageByName
* @param {string} name - Passage name to search for
* @returns {Passage | null} Return passage or null
*/
getPassageByName(name: string): Passage | null;
/**
* Size (number of passages).
* @method size
* @returns {number} Return number of passages
*/
size(): number;
/**
* Export Story as JSON representation.
* @method toJSON
* @returns {string} JSON string.
*/
toJSON(): string;
/**
* Return Twee representation.
*
* See: Twee 3 Specification
* (https://github.com/iftechfoundation/twine-specs/blob/master/twee-3-specification.md)
*
* @method toTwee
* @returns {string} Twee String
*/
toTwee(): string;
/**
* Return Twine 2 HTML.
*
* See: Twine 2 HTML Output
* (https://github.com/iftechfoundation/twine-specs/blob/master/twine-2-htmloutput-spec.md)
*
* The only required attributes are `name` and `ifid` of the `<tw-storydata>` element. All others are optional.
*
* The `<tw-storydata>` element may have any number of optional attributes, which are:
* - `startnode`: (integer) Optional. The PID of the starting passage.
* - `creator`: (string) Optional. The name of the program that created the story.
* - `creator-version`: (string) Optional. The version of the program that created the story.
* - `zoom`: (decimal) Optional. The zoom level of the story.
* - `format`: (string) Optional. The format of the story.
* - `format-version`: (string) Optional. The version of the format of the story.
*
* Because story stylesheet data can be represented as a passage, property value, or both, all approaches are encoded.
*
* Because story JavaScript can be represented as a passage, property value, or both, all approaches are encoded.
*
* @method toTwine2HTML
* @returns {string} Twine 2 HTML string
*/
toTwine2HTML(): string;
/**
* Return Twine 1 HTML.
*
* See: Twine 1 HTML Output
* (https://github.com/iftechfoundation/twine-specs/blob/master/twine-1-htmloutput-doc.md)
*
* @method toTwine1HTML
* @returns {string} Twine 1 HTML string.
*/
toTwine1HTML(): string;
#private;
}
export const creatorName: "extwee";
export const creatorVersion: "2.2.6";
import Passage from './Passage.js';