Skip to main content

CutscenePlayer

@zylem/game-lib

@zylem/game-lib / cinematics / CutscenePlayer

Interface: CutscenePlayer

Defined in: packages/game-lib/src/lib/cinematics/cutscene-player.ts:68

Properties​

definition​

readonly definition: object

Defined in: packages/game-lib/src/lib/cinematics/cutscene-player.ts:69

cameras​

cameras: object[]

dollies​

dollies: object[]

duration​

duration: number

Seconds.

id​

id: string

name​

name: string

scenes​

scenes: object[]

skippable​

skippable: boolean

stage​

stage: string | null

Stage the cutscene was authored against; informational.

tracks​

tracks: (\{ id: string; items: object[]; kind: "camera"; name: string; \} | \{ id: string; items: object[]; kind: "event"; name: string; \} | \{ id: string; items: object[]; kind: "audio"; name: string; \})[]

length​

readonly length: number

Defined in: packages/game-lib/src/lib/cinematics/cutscene-player.ts:73

pose​

readonly pose: EvaluatedPose | undefined

Defined in: packages/game-lib/src/lib/cinematics/cutscene-player.ts:75

The pose the picture shows right now, if a shot is active.

state​

readonly state: CutscenePlayerState

Defined in: packages/game-lib/src/lib/cinematics/cutscene-player.ts:70

time​

readonly time: number

Defined in: packages/game-lib/src/lib/cinematics/cutscene-player.ts:72

Seconds.

Methods​

dispose()​

dispose(): void

Defined in: packages/game-lib/src/lib/cinematics/cutscene-player.ts:88

Returns​

void

on()​

on<K>(event, handler): () => void

Defined in: packages/game-lib/src/lib/cinematics/cutscene-player.ts:87

Type Parameters​

K​

K extends keyof CutscenePlayerEvents

Parameters​

event​

K

handler​

CutscenePlayerEvents[K]

Returns​

() => void

pause()​

pause(): void

Defined in: packages/game-lib/src/lib/cinematics/cutscene-player.ts:77

Returns​

void

play()​

play(from?): void

Defined in: packages/game-lib/src/lib/cinematics/cutscene-player.ts:76

Parameters​

from?​

number

Returns​

void

seek()​

seek(time): void

Defined in: packages/game-lib/src/lib/cinematics/cutscene-player.ts:80

Parameters​

time​

number

Returns​

void

setDefinition()​

setDefinition(definition): void

Defined in: packages/game-lib/src/lib/cinematics/cutscene-player.ts:86

Swaps the definition in place, keeping time and state (live editing).

Parameters​

definition​
cameras​

object[] = ...

dollies​

object[] = ...

duration​

number = ...

Seconds.

id​

string = ...

name​

string = ...

scenes​

object[] = ...

skippable​

boolean = ...

stage​

string | null = ...

Stage the cutscene was authored against; informational.

tracks​

(\{ id: string; items: object[]; kind: "camera"; name: string; \} | \{ id: string; items: object[]; kind: "event"; name: string; \} | \{ id: string; items: object[]; kind: "audio"; name: string; \})[] = ...

Returns​

void

skip()​

skip(): boolean

Defined in: packages/game-lib/src/lib/cinematics/cutscene-player.ts:82

Jumps to the end (when skippable) and completes.

Returns​

boolean

stop()​

stop(): void

Defined in: packages/game-lib/src/lib/cinematics/cutscene-player.ts:79

Stops, rewinds, and returns the camera to gameplay.

Returns​

void

update()​

update(dt): void

Defined in: packages/game-lib/src/lib/cinematics/cutscene-player.ts:84

Advances by dt seconds; only needed with tick: 'manual'.

Parameters​

dt​

number

Returns​

void