Class TextScroll

Index

Methods

create start append skip pause resume clear tick visibleText fullText isComplete isPaused revealedCount totalCount setCharsPerSecond dispose

Methods

`Static`create

create(opts?: TextScrollOptions): TextScroll
Parameters
- opts: TextScrollOptions = {}
Returns TextScroll
- Defined in runtime/text-scroll.ts:65

start

start(text: string): void
Parameters
- text: string
Returns void
- Defined in runtime/text-scroll.ts:70

append

append(text: string): void
Parameters
- text: string
Returns void
- Defined in runtime/text-scroll.ts:85

skip

skip(): void
Returns void
- Defined in runtime/text-scroll.ts:98

pause

pause(): void
Returns void
- Defined in runtime/text-scroll.ts:106

resume

resume(): void
Returns void
- Defined in runtime/text-scroll.ts:111

clear

clear(): void
Returns void
- Defined in runtime/text-scroll.ts:116

tick

tick(dtMs: number): void
Parameters
- dtMs: number
Returns void
- Defined in runtime/text-scroll.ts:130

visibleText

visibleText(): string
Returns string
- Defined in runtime/text-scroll.ts:169

fullText

fullText(): string
Returns string
- Defined in runtime/text-scroll.ts:175

isComplete

isComplete(): boolean
Returns boolean
- Defined in runtime/text-scroll.ts:179

isPaused

isPaused(): boolean
Returns boolean
- Defined in runtime/text-scroll.ts:183

revealedCount

revealedCount(): number
Returns number
- Defined in runtime/text-scroll.ts:186

totalCount

totalCount(): number
Returns number
- Defined in runtime/text-scroll.ts:189

setCharsPerSecond

setCharsPerSecond(rate: number): void
Parameters
- rate: number
Returns void
- Defined in runtime/text-scroll.ts:191

dispose

dispose(): void
Returns void
- Defined in runtime/text-scroll.ts:197