Class Speech

Displays the phrases told by the characters or the narrator

Hierarchy

Speech

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Speech(): Speech

Returns Speech

Properties

Static signalForwardTicker

signalForwardTicker: Signal = ...

Static signalNext

signalNext: Signal = ...

Methods

Static clear

clear(): void

- Defined in Documents/HFU/FUDGE_Story/Source/Speech.ts:83
Clears the speech

Returns void

Static deserialize

deserialize(_serialization: Serialization): void

- Defined in Documents/HFU/FUDGE_Story/Source/Speech.ts:141
Restores the state of the speech given with the serialization-object

Parameters
- _serialization: Serialization
Returns void

Static getInput

getInput(): Promise<string>

- Defined in Documents/HFU/FUDGE_Story/Source/Speech.ts:107
Displays an input field to be filled by the user and returns the input

Returns Promise<string>

Static hide

hide(): void

- Defined in Documents/HFU/FUDGE_Story/Source/Speech.ts:94
Hides the speech

Returns void

Static serialize

serialize(): Serialization

- Defined in Documents/HFU/FUDGE_Story/Source/Speech.ts:127
Returns a serialization-object holding the current state of the speech

Returns Serialization

Static set

set(_character: string | Object, _text: string, _class?: string): void

- Defined in Documents/HFU/FUDGE_Story/Source/Speech.ts:25
Displays the Characters name or the string given as name and the given text at once

Parameters
- _character: string | Object
- _text: string
- Optional _class: string
Returns void

Static setTickerDelays

setTickerDelays(_letter: number, _paragraph?: number): void

- Defined in Documents/HFU/FUDGE_Story/Source/Speech.ts:75
Defines the pauses used by ticker between letters and before a paragraph in milliseconds

Parameters
- _letter: number
- _paragraph: number = 1000
Returns void

Static show

show(): void

- Defined in Documents/HFU/FUDGE_Story/Source/Speech.ts:100
Shows the speech

Returns void

Static tell

tell(_character: string | Object, _text: string, _waitForSignalNext?: boolean, _class?: string): Promise<void>

- Defined in Documents/HFU/FUDGE_Story/Source/Speech.ts:44
Displays the Characters name or the string given as name and slowly writes the text letter by letter

Parameters
- _character: string | Object
- _text: string
- _waitForSignalNext: boolean = true
- Optional _class: string
Returns Promise<void>

Generated using TypeDoc