Chapbook

https://klembot.github.io/chapbook/
Admin
Chapbook is a story format for Twine 2 that enables authors to create interactive fiction and...
Tokens:314,540
Snippets:3,051
Trust Score:9.7
Update:5 months ago
Show doc for...
Tokens:
Raw
### ontouchstart

Source: https://klembot.github.io/chapbook/api/classes/display_custom_elements_page_skip.PageSkip.html

Handles the start of a touch event.

```APIDOC
## ontouchstart

### Description
Handles the start of a touch event.

### Method
Event Handler

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None
```

--------------------------------

### ontouchstart

Source: https://klembot.github.io/chapbook/api/classes/backstage_custom_elements_tabs_tab.Tab.html

Handles the start of a touch event. This event fires when a touch point is placed on the surface.

```APIDOC
## ontouchstart

### Description
Handles the start of a touch event. This event fires when a touch point is placed on the surface.

### Method
Event Handler

### Parameters
#### Event Parameters
- **this**: GlobalEventHandlers - The context in which the event handler is called.
- **ev**: TouchEvent - The touch event object.

### Returns
- any: The return value of the event handler.
```

--------------------------------

### onselectstart Event

Source: https://klembot.github.io/chapbook/api/classes/backstage_custom_elements_tabs_tab.Tab.html

Handles the select start event.

```APIDOC
## onselectstart

### Description
Handles the select start event.

### Type declaration
```typescript
(this: GlobalEventHandlers, ev: Event) => any
```

### Parameters
#### this
Type: GlobalEventHandlers

#### ev
Type: Event

### Returns
Type: any
```

--------------------------------

### ontouchstart Event

Source: https://klembot.github.io/chapbook/api/classes/backstage_custom_elements_tabs_tabs.Tabs.html

Handles the 'touchstart' event, which occurs when a touch point is placed on the screen. The starting point for touch interactions.

```APIDOC
## ontouchstart

### Description
Handles the `ontouchstart` event.

### Type Declaration
```typescript
(this: GlobalEventHandlers, ev: TouchEvent) => any
```

### Parameters
#### this
Type: `GlobalEventHandlers`

#### ev
Type: `TouchEvent`

### Returns
Type: `any`
```

--------------------------------

### ontransitionstart

Source: https://klembot.github.io/chapbook/api/classes/backstage_custom_elements_tabs_tab.Tab.html

Handles the start of a CSS transition. This event fires when a CSS transition begins.

```APIDOC
## ontransitionstart

### Description
Handles the start of a CSS transition. This event fires when a CSS transition begins.

### Method
Event Handler

### Parameters
#### Event Parameters
- **this**: GlobalEventHandlers - The context in which the event handler is called.
- **ev**: TransitionEvent - The transition event object.

### Returns
- any: The return value of the event handler.
```

--------------------------------

### onplaying Event

Source: https://klembot.github.io/chapbook/api/classes/backstage_custom_elements_tabs_tab.Tab.html

Handles the event when the audio or video has started playing.

```APIDOC
## onplaying

### Description
Occurs when the audio or video has started playing.

### Type declaration
```typescript
(this: GlobalEventHandlers, ev: Event) => any
```

### Parameters
#### this
Type: GlobalEventHandlers

#### ev
Type: Event

### Returns
Type: any

### Param
The event.
```

--------------------------------

### onanimationstart Event Handler

Source: https://klembot.github.io/chapbook/api/classes/template_custom_elements_variable_binding.VariableBinding.html

Fires when an animation starts.

```APIDOC
## onanimationstart
onanimationstart: null | ((this, ev) => any)
#### Type declaration
  *     * (this, ev): any
    * #### Parameters
      * ##### this: GlobalEventHandlers
      * ##### ev: AnimationEvent
#### Returns any
```

--------------------------------

### startPassage()

Source: https://klembot.github.io/chapbook/api/functions/story_story.startPassage.html

Returns the start passage of the story. If none exists, returns undefined.

```APIDOC
## Function startPassage

### Description
Returns the start passage of the story. If none exists, returns undefined.

### Signature
`startPassage(): undefined | Passage`

### Returns
- `undefined`: If no start passage is found.
- `Passage`: The start passage object if it exists.
```

--------------------------------

### ondragstart

Source: https://klembot.github.io/chapbook/api/classes/template_custom_elements_reveal_link.RevealLink.html

Fires on the source object when the user starts to drag a text selection or selected object. Handles the 'dragstart' event.

```APIDOC
## ondragstart

### Description
Fires on the source object when the user starts to drag a text selection or selected object.

### Parameters
- **this**: GlobalEventHandlers - The context in which the event handler is called.
- **ev**: DragEvent - The drag event object.

### Returns
any - The return value of the event handler.

### Param
The event.
```

--------------------------------

### ondragstart

Source: https://klembot.github.io/chapbook/api/classes/backstage_custom_elements_style_config.StyleConfig.html

Handles the 'dragstart' event, which fires on the source object when the user starts to drag a text selection or selected object. It accepts a callback function that receives the drag event object.

```APIDOC
## ondragstart

### Description
Fires on the source object when the user starts to drag a text selection or selected object. It accepts a callback function that receives the drag event object.

### Type Declaration
```typescript
(this: GlobalEventHandlers, ev: DragEvent) => any
```

### Parameters
#### this
- Type: GlobalEventHandlers
- Description: The context in which the event handler is called.

#### ev
- Type: DragEvent
- Description: The drag event object associated with the 'dragstart' event.
```

--------------------------------

### SugarCube Conditional Logic Example

Source: https://klembot.github.io/chapbook/guide/state/conditional-display.html

This example demonstrates conditional logic in the SugarCube story format for managing a door's state (found, unlocked, has key).

```sugarcube
__
<<if $doorFound>>
<<if $doorUnlocked>>
The door stands open and unlocked, ready for you to [[enter it]].
<<else>>
You've found a door here, <<if $hasKey>>ready to be [[unlocked]]<<else>>but you haven't found a key yet that will open it.
<</if>>
<<else>>
There seems to be nothing of note here, but perhaps [[a search would turn up something]].
<</if>>


```

--------------------------------

### Chapbook Passage Example: Shopping List

Source: https://klembot.github.io/chapbook/guide/print.html

An example passage demonstrating content that can be revealed or embedded. Chapbook handles multi-paragraph content by maintaining surrounding text order.

```chapbook
__
Apples

Bananas

Carrots

```

--------------------------------

### Font Scaling Example Configuration

Source: https://klembot.github.io/chapbook/guide/customization/font-scaling.html

This example demonstrates how font size scales with viewport width given specific configuration values for base width, double width addition, and maximum size.

```javascript
__
config.page.font: 'Helvetica 20'
config.style.fontScaling.baseViewportWidth: 1000
config.style.fontScaling.addAtDoubleWidth: 5
config.style.fontScaling.maximumSize: '30px'


```

--------------------------------

### onselectstart

Source: https://klembot.github.io/chapbook/api/classes/display_custom_elements_error_handler.ErrorHandler.html

Handles the selectstart event, which fires when the user begins to select text.

```APIDOC
## onselectstart

### Description
Handles the selectstart event.

### Parameters
- **this**: GlobalEventHandlers - The context of the event.
- **ev**: Event - The event object.

### Returns
any
```

--------------------------------

### animate

Source: https://klembot.github.io/chapbook/api/classes/backstage_custom_elements_notes_notes.Notes.html

Starts an animation on the element.

```APIDOC
## animate
animate(keyframes: null | Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions): Animation

### Description
Starts an animation on the element.

### Parameters
#### keyframes: null | Keyframe[] | PropertyIndexedKeyframes
  An array of keyframes or a property-indexed keyframes object.
#### `Optional` options: number | KeyframeAnimationOptions
  An object containing options for the animation.

### Returns
Animation
```

--------------------------------

### ontouchstart Event

Source: https://klembot.github.io/chapbook/api/classes/backstage_custom_elements_tabs_tab_panel.TabPanel.html

Handles the touchstart event. This is an optional event handler.

```APIDOC
## ontouchstart

### Description
Handles the touchstart event.

### Type Declaration
```typescript
(this: GlobalEventHandlers, ev: TouchEvent) => any
```

### Parameters
* **this**: GlobalEventHandlers - The context in which the event handler is called.
* **ev**: TouchEvent - The touch event object.

### Returns
* any - The return value of the event handler.
```

--------------------------------

### spyOnWarnings

Source: https://klembot.github.io/chapbook/api/classes/display_custom_elements_warning_list.WarningList.html

Starts spying on warning events.

```APIDOC
## spyOnWarnings

### Description
Starts spying on warning events.

### Returns
void
```

--------------------------------

### animate

Source: https://klembot.github.io/chapbook/api/classes/display_custom_elements_page_skip.PageSkip.html

Starts playing animations on the element.

```APIDOC
## animate
  * animate(keyframes, options?): Animation
  * #### Parameters
    * ##### keyframes: null | Keyframe[] | PropertyIndexedKeyframes
    * ##### `Optional` options: number | KeyframeAnimationOptions
#### Returns Animation
```

--------------------------------

### initBackstage()

Source: https://klembot.github.io/chapbook/api/functions/backstage_init.initBackstage.html

Initializes Chapbook's backstage functionality and adds the backstage UI to the DOM.

```APIDOC
## initBackstage()

### Description
Initializes Chapbook's backstage functionality and adds the backstage UI to the DOM.

### Method
`initBackstage()`

### Returns
void
```

--------------------------------

### initSound

Source: https://klembot.github.io/chapbook/api/functions/sound_init.initSound.html

Initializes the sound system. This function does not return any value.

```APIDOC
## Function initSound

### Description
Initializes the sound system. This function returns void.

### Signature
`initSound(): void`

### Returns
void
```

--------------------------------

### onloadstart

Source: https://klembot.github.io/chapbook/api/classes/template_custom_elements_reveal_link.RevealLink.html

Handles the loadstart event for RevealLink elements, occurring when media loading begins.

```APIDOC
## onloadstart
onloadstart: null | ((this, ev) => any)

### Description
Occurs when Internet Explorer begins looking for media data.

### Parameters
* **this**: GlobalEventHandlers - The event target.
* **ev**: Event - The event object.

### Returns
any - The return value of the event handler.

### Param
The event.
```

--------------------------------

### Attribute Management

Source: https://klembot.github.io/chapbook/api/classes/backstage_custom_elements_style_theme.StyleTheme.html

Methods for getting and setting element attributes.

```APIDOC
## removeAttribute

### Description
Removes an attribute from the element based on its qualified name.

### Method Signature
```typescript
removeAttribute(qualifiedName: string): void;
```

### Parameters
- `qualifiedName` (string): The qualified name of the attribute to remove.

### Returns
- `void`
```

```APIDOC
## removeAttributeNS

### Description
Removes an attribute from the element based on its namespace and local name.

### Method Signature
```typescript
removeAttributeNS(namespace: null | string, localName: string): void;
```

### Parameters
- `namespace` (null | string): The namespace of the attribute.
- `localName` (string): The local name of the attribute.

### Returns
- `void`
```

```APIDOC
## removeAttributeNode

### Description
Removes a specified attribute node from the element.

### Method Signature
```typescript
removeAttributeNode(attr: Attr): Attr;
```

### Parameters
- `attr` (Attr): The attribute node to remove.

### Returns
- `Attr`: The removed attribute node.
```

```APIDOC
## setAttribute

### Description
Sets the value of an attribute on the element. If the attribute already exists, its value is updated; otherwise, a new attribute is added.

### Method Signature
```typescript
setAttribute(qualifiedName: string, value: string): void;
```

### Parameters
- `qualifiedName` (string): The qualified name of the attribute to set.
- `value` (string): The value to set for the attribute.

### Returns
- `void`
```

--------------------------------

### onwebkitanimationstart

Source: https://klembot.github.io/chapbook/api/classes/backstage_custom_elements_variable_input.VariableInput.html

Handles the webkitanimationstart event.

```APIDOC
## onwebkitanimationstart

### Description
Handles the webkitanimationstart event.

### Method
Event Handler

### Parameters
#### Event Parameters
- **this**: GlobalEventHandlers - The context in which the event handler is called.
- **ev**: Event - The event object.

### Returns
- any: The return value of the event handler.
```

--------------------------------

### ontransitionstart

Source: https://klembot.github.io/chapbook/api/classes/display_custom_elements_error_handler.ErrorHandler.html

Handles the transitionstart event.

```APIDOC
## ontransitionstart

### Description
Handles the transitionstart event.

### Parameters
- **this**: GlobalEventHandlers - The context of the event.
- **ev**: TransitionEvent - The transition event object.

### Returns
any
```

--------------------------------

### initSound

Source: https://klembot.github.io/chapbook/api/modules/sound_init.html

Initializes the sound system. This function must be called before using any other sound-related functions.

```APIDOC
## initSound

### Description
Initializes the sound system.

### Parameters
This function does not take any parameters.

### Returns
- void: This function does not return any value.
```

--------------------------------

### ThemeSwitcher Constructor

Source: https://klembot.github.io/chapbook/api/classes/template_custom_elements_theme_switcher.ThemeSwitcher.html

Initializes a new instance of the ThemeSwitcher.

```APIDOC
## constructor

### Description
Initializes a new instance of the ThemeSwitcher.

### Method
constructor

### Returns
- ThemeSwitcher: A new instance of the ThemeSwitcher.
```

--------------------------------

### ontransitionrun

Source: https://klembot.github.io/chapbook/api/classes/backstage_custom_elements_tabs_tab.Tab.html

Handles the run of a CSS transition. This event fires when a CSS transition starts.

```APIDOC
## ontransitionrun

### Description
Handles the run of a CSS transition. This event fires when a CSS transition starts.

### Method
Event Handler

### Parameters
#### Event Parameters
- **this**: GlobalEventHandlers - The context in which the event handler is called.
- **ev**: TransitionEvent - The transition event object.

### Returns
- any: The return value of the event handler.
```

--------------------------------

### init()

Source: https://klembot.github.io/chapbook/api/functions/index.init.html

Initializes the Chapbook engine. This function is automatically called when the page first loads to prepare the search index.

```APIDOC
## init()

### Description
Does all initialization of the engine. This function is called when the page first loads.

### Method
void

### Returns
void
```

--------------------------------

### initStateRecorder

Source: https://klembot.github.io/chapbook/api/functions/backstage_state_recorder.initStateRecorder.html

Initializes recordings of state changes.

```APIDOC
## Function initStateRecorder

### Description
Initializes recordings of state changes.

### Signature
`initStateRecorder(): void`

### Returns
`void`
```

--------------------------------

### initBackstage

Source: https://klembot.github.io/chapbook/api/modules/backstage_init.html

Initializes the Backstage environment. This function is generated using TypeDoc.

```APIDOC
## initBackstage

### Description
Initializes the Backstage environment.

### Signature
initBackstage()
```

--------------------------------

### ondragstart

Source: https://klembot.github.io/chapbook/api/classes/backstage_custom_elements_tabs_tab.Tab.html

Fires on the source object when the user starts to drag a text selection or selected object.

```APIDOC
## ondragstart

### Description
Fires on the source object when the user starts to drag a text selection or selected object.

### Method
Event Handler

### Parameters
#### Event Parameters
- **this**: GlobalEventHandlers - The context of the event.
- **ev**: DragEvent - The event.
```

--------------------------------

### initNotes

Source: https://klembot.github.io/chapbook/api/modules/backstage_notes.html

Initializes the notes system.

```APIDOC
## initNotes

### Description
Initializes the notes system.

### Function Signature
initNotes()
```

--------------------------------

### onplaying Event Handler

Source: https://klembot.github.io/chapbook/api/classes/display_custom_elements_error_handler.ErrorHandler.html

Handles the 'playing' event, which occurs when the audio or video has started playing.

```APIDOC
## onplaying

### Description
Occurs when the audio or video has started playing.

### Type Declaration
```typescript
(this: GlobalEventHandlers, ev: Event) => any
```

### Parameters
* **this**: GlobalEventHandlers
* **ev**: Event - The event object.

### Returns
any
```

--------------------------------

### onanimationstart

Source: https://klembot.github.io/chapbook/api/classes/display_custom_elements_warning_list.WarningList.html

Fires when a CSS animation begins. This event can be used to initiate actions as soon as an animation starts.

```APIDOC
## onanimationstart

### Description
Fires when a CSS animation begins.

### Type declaration
```typescript
(this: GlobalEventHandlers, ev: AnimationEvent) => any
```

### Parameters
*   **this**: GlobalEventHandlers
*   **ev**: AnimationEvent - The event object.

### Returns
any
```

--------------------------------

### initDisplayEvents

Source: https://klembot.github.io/chapbook/api/functions/display_events.initDisplayEvents.html

Initializes listeners that emit `display-change` and `system-theme-change` events.

```APIDOC
## Function initDisplayEvents

### Description
Sets up listeners that emit `display-change` events with rendered content when the trail state variable changes, and `system-theme-change` events when the system theme changes.

### Signature
`initDisplayEvents(): void`

### Returns
`void`
```

--------------------------------

### Chapbook Passage Example: Train Arrival

Source: https://klembot.github.io/chapbook/guide/print.html

A passage demonstrating a link to another passage, which can be replaced by an embed insert.

```chapbook
__
The cross-country train ride leaves plenty of space for contemplation on the way to [[L.A.]]

```

--------------------------------

### initLoggerState

Source: https://klembot.github.io/chapbook/api/functions/logger_init.initLoggerState.html

Initializes the logging system. This function does not return any value.

```APIDOC
## Function initLoggerState

### Description
Initializes logging.

### Signature
`initLoggerState(): void`

### Returns
`void`
```

--------------------------------

### Chapbook Passage Example: Plane Arrival

Source: https://klembot.github.io/chapbook/guide/print.html

A passage demonstrating a link to another passage, which can be replaced by an embed insert.

```chapbook
__
You spend a few hours watching the clouds drift below the wings of the plane before arriving in [[L.A.]]

```

--------------------------------

### ontransitionstart Event

Source: https://klembot.github.io/chapbook/api/classes/backstage_custom_elements_tabs_tab_panel.TabPanel.html

Handles the transitionstart event. It accepts a 'this' context and an 'ev' event object.

```APIDOC
## ontransitionstart

### Description
Handles the transitionstart event.

### Type Declaration
```typescript
(this: GlobalEventHandlers, ev: TransitionEvent) => any
```

### Parameters
* **this**: GlobalEventHandlers - The context in which the event handler is called.
* **ev**: TransitionEvent - The transition event object.

### Returns
* any - The return value of the event handler.
```

--------------------------------

### Basic Font Stack Example

Source: https://klembot.github.io/chapbook/guide/customization/fonts-and-colors.html

Sets the Palatino typeface at 18 pixels. Use this format for simple font declarations.

```text
__
Palatino 18
```

--------------------------------

### initStyle

Source: https://klembot.github.io/chapbook/api/modules/style_init.html

Initializes the styles for the application. This function is generated using TypeDoc.

```APIDOC
## initStyle

### Description
Initializes the styles.

### Parameters
This function does not take any parameters.

### Returns
This function does not return any value.
```

--------------------------------

### onloadstart

Source: https://klembot.github.io/chapbook/api/classes/template_custom_elements_variable_binding.VariableBinding.html

Occurs when Internet Explorer begins looking for media data.

```APIDOC
## onloadstart

### Description
Occurs when Internet Explorer begins looking for media data.

### Method Signature
`onloadstart(this: GlobalEventHandlers, ev: Event): any`

### Parameters
*   **this**: GlobalEventHandlers
*   **ev**: Event

### Param
The event.
```

--------------------------------

### initStateSnapshots

Source: https://klembot.github.io/chapbook/api/functions/backstage_state_snapshots.initStateSnapshots.html

Initializes the snapshot functionality. This function does not take any arguments and returns void.

```APIDOC
## Function initStateSnapshots

### Description
Initializes snapshot functionality.

### Signature
`initStateSnapshots(): void`

### Returns
`void`
```

--------------------------------

### ondragstart

Source: https://klembot.github.io/chapbook/api/classes/display_custom_elements_external_fonts.ExternalFonts.html

Fires on the source object when the user starts to drag a text selection or selected object. Handles drag events.

```APIDOC
## ondragstart

### Description
Fires on the source object when the user starts to drag a text selection or selected object.

### Method
Event Handler

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None
```

--------------------------------

### onloadstart Event Handler

Source: https://klembot.github.io/chapbook/api/classes/backstage_custom_elements_history_history_table.HistoryTable.html

Handles loadstart events, occurring when the browser begins looking for media data.

```APIDOC
## onloadstart
onloadstart: null | ((this, ev) => any)

Occurs when Internet Explorer begins looking for media data.

### Parameters
* **this**: GlobalEventHandlers
* **ev**: Event - The event.

### Returns
any
```

--------------------------------

### onloadstart Event

Source: https://klembot.github.io/chapbook/api/classes/backstage_custom_elements_tabs_tabs.Tabs.html

Occurs when the browser begins looking for media data. Useful for showing loading indicators.

```APIDOC
## onloadstart

### Description
Occurs when Internet Explorer begins looking for media data.

### Method
Event Handler

### Parameters
#### Event Parameters
- **this**: GlobalEventHandlers - The context in which the event is fired.
- **ev**: Event - The event object.
```

--------------------------------

### Get all passages

Source: https://klembot.github.io/chapbook/api/functions/story_story.passages.html

Retrieves all passages from the current story. This function is useful for iterating through or accessing all content segments within a story.

```APIDOC
## passages()

### Description
Returns all passages in the story.

### Method
Function call

### Parameters
None

### Returns
Passage[] - An array of Passage objects representing all passages in the story.
```

--------------------------------

### startTransition

Source: https://klembot.github.io/chapbook/api/classes/display_custom_elements_page_transition.PageTransition.html

Initiates a page transition process, executing a callback function and optionally applying transition options.

```APIDOC
## startTransition

### Description
Initiates a page transition process.

### Method Signature
`startTransition(callback: (() => void | Promise<void>), options?: UpdateContentOptions): Promise<void>`

### Parameters
* `callback` (function) - The function to execute during the transition. It can be synchronous or return a Promise.
* `options` (UpdateContentOptions, optional) - Configuration options for the transition.

### Returns
`Promise<void>` - A promise that resolves when the transition is complete.
```

--------------------------------

### Get Story Name

Source: https://klembot.github.io/chapbook/api/functions/story_story.name.html

The `name()` function returns the name of the story. It can return either a string or undefined if the name is not set.

```APIDOC
## Function: name()

### Description
Returns the name of the story.

### Returns
`undefined | string` - The name of the story, or undefined if not available.
```

--------------------------------

### state.get

Source: https://klembot.github.io/chapbook/api/functions/state_state.get.html

Gets the value of a variable or lookup. The return type of this function is unknown because an author may have altered it outside of this code.

```APIDOC
## get(name)

### Description
Gets the value of a variable or lookup. The return type of this function is unknown because an author may have altered it outside of this code.

### Parameters
#### Path Parameters
- **name** (string) - Required - The name of the variable or lookup to retrieve.

### Returns
unknown
```

--------------------------------

### onloadstart

Source: https://klembot.github.io/chapbook/api/classes/backstage_custom_elements_backstage.BackstageSidebar.html

Occurs when the browser begins looking for media data for the Backstage Sidebar.

```APIDOC
## onloadstart
onloadstart: null | ((this, ev) => any)

Occurs when Internet Explorer begins looking for media data.

### Parameters
* **this**: GlobalEventHandlers
* **ev**: Event

### Returns
any

#### Param
The event.
```

--------------------------------

### StyleTheme Constructor

Source: https://klembot.github.io/chapbook/api/classes/backstage_custom_elements_style_theme.StyleTheme.html

Initializes a new instance of the StyleTheme class.

```APIDOC
## constructor

### Description
Initializes a new instance of the StyleTheme class.

### Returns
StyleTheme - A new instance of the StyleTheme class.
```

--------------------------------

### Function Call Inserts

Source: https://klembot.github.io/chapbook/api/functions/template_render_inserts.default.html

Shows examples of inserts that act as syntax sugar for function calls, including variations with and without arguments.

```text
{restart link} {link to: "From the Top"} {link to: "From the Top", hidden: true}
Copy
```

--------------------------------

### Template Parsing Example

Source: https://klembot.github.io/chapbook/api/functions/template_parse.parse.html

Demonstrates the structure of a template with variables and modifiers. Variables can have conditions. Modifiers affect the following text block.

```plaintext
var1: value
var2: value
var2 (condition): value
--
Copy
```

--------------------------------

### initDisplay

Source: https://klembot.github.io/chapbook/api/modules/display_init.html

Initializes the display. Generated using TypeDoc.

```APIDOC
## initDisplay()

### Description
Initializes the display.

### Method
(Not specified, likely a function call)

### Parameters
(No parameters specified)

### Request Example
(No request example provided)

### Response
(No response details provided)
```

--------------------------------

### Define a Sound Effect in Chapbook

Source: https://klembot.github.io/chapbook/guide/multimedia/audio.html

Define a sound effect by specifying its URL and a description for accessibility. This setup is required before playing the sound.

```twine
__
sound.effect.explosion.url: 'boom.mp3'
sound.effect.explosion.description: 'a large explosion'
--
```

--------------------------------

### initStyle()

Source: https://klembot.github.io/chapbook/api/functions/style_init.initStyle.html

Initializes all style-related defaults. This function does not return any value.

```APIDOC
## Function initStyle

### Description
Sets all defaults related to style.

### Signature
initStyle(): void

### Returns
void
```

--------------------------------

### Complex Conditional Logic in SugarCube

Source: https://klembot.github.io/chapbook/guide/print.html

This example demonstrates complex conditional logic for a door scenario using SugarCube's macro syntax.

```sugarcube
<<if $doorFound>>
<<if $doorUnlocked>>
The door stands open and unlocked, ready for you to [[enter it]].
<<else>>
You've found a door here, <<if $hasKey>>ready to be [[unlocked]]<<else>>but you haven't found a key yet that will open it.
<</if>>
<<else>>
There seems to be nothing of note here, but perhaps [[a search would turn up something]].
<</if>>
```

--------------------------------

### onloadstart Event Handler

Source: https://klembot.github.io/chapbook/api/classes/display_custom_elements_page_skip.PageSkip.html

Occurs when the browser begins looking for media data, with event details.

```APIDOC
## onloadstart

### Description
Occurs when Internet Explorer begins looking for media data.

### Type Declaration
```typescript
(this: GlobalEventHandlers, ev: Event) => any
```

### Parameters
* **this**: GlobalEventHandlers
* **ev**: Event - The event.

### Returns
any
```

--------------------------------

### Chapbook Dice Roll Examples

Source: https://klembot.github.io/chapbook/guide/state/randomness.html

Illustrates the use of various dice roll lookup variables provided by Chapbook, such as `random.d4` for a four-sided die.

```chapbook
[if random.d4 === 1]
One.

[if random.d4 === 2]
Two.

[if random.d4 === 3]
Three.

[if random.d4 === 4]
Four.


```

--------------------------------

### onloadstart Event Handler

Source: https://klembot.github.io/chapbook/api/classes/display_custom_elements_error_handler.ErrorHandler.html

Occurs when the browser begins looking for media data. This handler is part of the ErrorHandler's event handling capabilities.

```APIDOC
## onloadstart

### Description
Occurs when the browser begins looking for media data.

### Parameters
- **this**: GlobalEventHandlers - The context in which the event handler is called.
- **ev**: Event - The event object.

### Returns
any - The return value of the event handler.
```

--------------------------------

### Rendered Passage After Custom Modifiers

Source: https://klembot.github.io/chapbook/guide/advanced/adding-custom-modifiers.html

Shows the output of the example passage after the 'remove' and 'also remove' modifiers have been applied, demonstrating the letter removal effect.

```chapbook
XmXrXcXn plXnXs, fXll Xf hXlXs Xnd wXXndXd mXn Xnd cXrpsXs tXXk Xff bXckwXrds frXm Xn XXrfXXld Xn XnglXnd. XvXr FrXncX X fXw GXrmXn fXghtXr plXnXs flXw Xt thXm bXckwXrds, sXckXd bXllXts Xnd shXll frXgmXnts frXm sXmX Xf thX plXnXs Xnd crXwmXn. ThXy dXd thX sXmX fXr wrXckXd XmXrXcXn bXmbXrs Xn thX grXXnd, Xnd thXsX plXnXs flXw Xp bXckwXrds tX jXXn thX fXrmXtXXn.

TXX fXXmXtXXn fXXw bXckwXXXX XvXX X GXXmXn cXty tXXt wXX Xn fXXmXX. TXX bXmbXXX XpXnXX tXXXX bXmb bXy XXXXX, XxXXtXX X mXXXcXXXXX mXgnXtXXm wXXcX XXXXnk tXX fXXXX, gXtXXXXX tXXm XntX cyXXnXXXcXX XtXXX cXntXXnXXX, XnX XXftXX tXX cXntXXnXXX XntX tXX bXXXXXX Xf tXX pXXnXX. TXX cXntXXnXXX wXXX XtXXXX nXXtXy Xn XXckX. TXX GXXmXnX bXXXw XXX mXXXcXXXXX XXvXcXX Xf tXXXX Xwn, wXXcX wXXX XXng XtXXX tXbXX. TXXy XXXX tXXm tX XXck mXXX fXXgmXntX fXXm tXX cXXwmXn XnX pXXnXX. BXt tXXXX wXXX XtXXX X fXw wXXnXXX XmXXXcXnX, tXXXgX, XnX XXmX Xf tXX bXmbXXX wXXX Xn bXX XXpXXX. XvXX FXXncX, tXXXgX, GXXmXn fXgXtXXX cXmX Xp XgXXn, mXXX XvXXytXXng XnX XvXXybXXy XX gXXX XX nXw.

```

--------------------------------

### onwebkitanimationstart Event

Source: https://klembot.github.io/chapbook/api/classes/backstage_custom_elements_tabs_tab_panel.TabPanel.html

Handles the webkitanimationstart event. This is a legacy alias of onanimationstart.

```APIDOC
## onwebkitanimationstart

### Description
Handles the webkitanimationstart event.

### Type Declaration
```typescript
(this: GlobalEventHandlers, ev: Event) => any
```

### Parameters
* **this**: GlobalEventHandlers - The context in which the event handler is called.
* **ev**: Event - The event object.

### Returns
* any - The return value of the event handler.

### Deprecated
This is a legacy alias of `onanimationstart`.
```

--------------------------------

### Example Passage with Custom Modifiers

Source: https://klembot.github.io/chapbook/guide/advanced/adding-custom-modifiers.html

Demonstrates the usage of custom 'remove' and 'also remove' modifiers on a passage from Kurt Vonnegut's 'Slaughterhouse Five'.

```chapbook
[remove aeiou]
American planes, full of holes and wounded men and corpses took off backwards from an airfield in England. Over France a few German fighter planes flew at them backwards, sucked bullets and shell fragments from some of the planes and crewmen. They did the same for wrecked American bombers on the ground, and those planes flew up backwards to join the formation.

[also remove shrdlu]
The formation flew backwards over a German city that was in flames. The bombers opened their bomb bay doors, exerted a miraculous magnetism which shrunk the fires, gathered them into cylindrical steel containers, and lifted the containers into the bellies of the planes. The containers were stored neatly in racks. The Germans below had miraculous devices of their own, which were long steel tubes. They used them to suck more fragments from the crewmen and planes. But there were still a few wounded Americans, though, and some of the bombers were in bad repair. Over France, though, German fighters came up again, made everything and everybody as good as new.

[also remove t]
When the bombers got back to their base, the steel cylinders were taken from the racks and shipped back to the United States of America, where factories were operating night and day, dismantling the cylinders, separating the dangerous contents into minerals. Touchingly, it was mainly women who did this work. The minerals were then shipped to specialists in remote areas. It was their business to put them into the ground, to hide them cleverly, so they would never hurt anybody ever again.

```

--------------------------------

### ondragstart

Source: https://klembot.github.io/chapbook/api/classes/display_custom_elements_state_dark_theme_css_overrides.StateDarkThemeCssOverrides.html

Fires on the source object when the user starts to drag a text selection or selected object. Initiates drag-and-drop for custom elements in dark mode.

```APIDOC
## ondragstart

### Description
Fires on the source object when the user starts to drag a text selection or selected object.

### Method
Event Handler (JavaScript)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```javascript
const element = document.getElementById('myDraggableElement');
element.ondragstart = (event) => {
  console.log('Drag started in dark mode:', event);
};
```

### Response
#### Success Response (200)
N/A (Event handler)

#### Response Example
N/A
```

--------------------------------

### initStory()

Source: https://klembot.github.io/chapbook/api/functions/story_story.initStory.html

Initializes the story state. This function must be called after loadFromData() has been used to load story data.

```APIDOC
## initStory()

### Description
Sets up state. This _must_ be called after `loadFromData()`.

### Method
`initStory()`

### Returns
void
```

--------------------------------

### ondragstart

Source: https://klembot.github.io/chapbook/api/classes/backstage_custom_elements_backstage.BackstageSidebar.html

Fires on the source object when the user starts to drag a text selection or selected object. It accepts a callback function that receives the drag event object.

```APIDOC
## ondragstart

### Description
Fires on the source object when the user starts to drag a text selection or selected object.

### Method
Event Handler

### Parameters
#### Event Parameters
- **this** (GlobalEventHandlers) - The event target.
- **ev** (DragEvent) - The drag event object.

### Returns
- any: The return value of the event handler.
```

--------------------------------

### initExtensibility

Source: https://klembot.github.io/chapbook/api/functions/extensibility.initExtensibility.html

Initializes extensibility features for Chapbook, making the engine available globally.

```APIDOC
## Function initExtensibility

### Description
Exposes functionality to authors who would like to extend Chapbook via a global named `engine`.

### Signature
`initExtensibility(): void`

### Returns
`void`
```

--------------------------------

### Lookup Type Alias

Source: https://klembot.github.io/chapbook/api/types/state_types.Lookup.html

The Lookup type alias is used for configuring read-only values. It accepts a 'get' function for retrieving values and a 'set' function for updating them.

```APIDOC
## Type alias Lookup
Lookup: ((get, set) => unknown)

### Description
Function signature used for configuring read-only values.

### Parameters
#### get: ((name) => unknown)
  * **name**: string - The name of the value to retrieve.
  * **Returns**: unknown - The retrieved value.

#### set: ((name, value) => void)
  * **name**: string - The name of the value to set.
  * **value**: Settable - The value to set.
  * **Returns**: void
```

--------------------------------

### Basic Delayed Text Example

Source: https://klembot.github.io/chapbook/guide/modifiers-and-inserts/delayed-text.html

Use the '[after X time]' modifier to display text after a specified delay. The time can be in seconds, milliseconds, or minutes. This modifier is not visible to the player.

```chapbook
__
You settle in for the long transatlantic flight.

[after 1 second]
You remember suddenly that you left the stove on at home.

```

--------------------------------

### initStyle

Source: https://klembot.github.io/chapbook/api/modules/style.html

Re-exports initStyle for initializing styles.

```APIDOC
## initStyle

### Description
Re-exports initStyle.

### Type
Re-exported function.
```
Tokens:
Raw