createCutscenePlayer
@zylem/game-lib / cinematics / createCutscenePlayer
Function: createCutscenePlayer()
createCutscenePlayer(
initial,options):CutscenePlayer
Defined in: packages/game-lib/src/lib/cinematics/cutscene-player.ts:104
Plays a cutscene against a live stage: drives the camera through a pipeline behavior, fires event/audio items as the playhead crosses them, and runs scene transitions through the renderer.
const player = createCutscenePlayer(INTRO_CUTSCENE, { host: createStageCutsceneHost(stage) });
player.on('complete', () => player.dispose());
player.play();
Parameters
initial
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; \})[] = ...