Class DialogVoice

Index

Methods

create registerLine unregisterLine hasLine getLine lineCount play playQueue enqueue interrupt pause resume isPlaying isPaused queueLength getCurrent tick clear dispose

Methods

`Static`create

create(opts?: DialogVoiceOptions): DialogVoice
Parameters
- opts: DialogVoiceOptions = {}
Returns DialogVoice
- Defined in runtime/dialog-voice.ts:123

registerLine

registerLine(line: VoiceLine): boolean
Parameters
- line: VoiceLine
Returns boolean
- Defined in runtime/dialog-voice.ts:129

unregisterLine

unregisterLine(nodeId: string): boolean
Parameters
- nodeId: string
Returns boolean
- Defined in runtime/dialog-voice.ts:151

hasLine

hasLine(nodeId: string): boolean
Parameters
- nodeId: string
Returns boolean
- Defined in runtime/dialog-voice.ts:156

getLine

getLine(nodeId: string): VoiceLine | null
Parameters
- nodeId: string
Returns VoiceLine | null
- Defined in runtime/dialog-voice.ts:160

lineCount

lineCount(): number
Returns number
- Defined in runtime/dialog-voice.ts:173

play

play(nodeId: string, opts?: PlayLineOptions): boolean
Parameters
- nodeId: string
- opts: PlayLineOptions = {}
Returns boolean
- Defined in runtime/dialog-voice.ts:177

playQueue

playQueue(opts: DialogVoiceQueueOptions): boolean
Parameters
- opts: DialogVoiceQueueOptions
Returns boolean
- Defined in runtime/dialog-voice.ts:198

enqueue

enqueue(nodeId: string, opts?: PlayLineOptions): boolean
Parameters
- nodeId: string
- opts: PlayLineOptions = {}
Returns boolean
- Defined in runtime/dialog-voice.ts:218

interrupt

interrupt(): boolean
Returns boolean
- Defined in runtime/dialog-voice.ts:227

pause

pause(): void
Returns void
- Defined in runtime/dialog-voice.ts:235

resume

resume(): void
Returns void
- Defined in runtime/dialog-voice.ts:240

isPlaying

isPlaying(): boolean
Returns boolean
- Defined in runtime/dialog-voice.ts:245

isPaused

isPaused(): boolean
Returns boolean
- Defined in runtime/dialog-voice.ts:246

queueLength

queueLength(): number
Returns number
- Defined in runtime/dialog-voice.ts:247

getCurrent

getCurrent(): VoiceLineState | null
Returns VoiceLineState | null
- Defined in runtime/dialog-voice.ts:249

tick

tick(dtMs: number): void
Parameters
- dtMs: number
Returns void
- Defined in runtime/dialog-voice.ts:264

clear

clear(): void
Returns void
- Defined in runtime/dialog-voice.ts:310

dispose

dispose(): void
Returns void
- Defined in runtime/dialog-voice.ts:317