CutscenePlayerOptions

@zylem/game-lib

---

@zylem/game-lib / cinematics / CutscenePlayerOptions

Interface: CutscenePlayerOptions

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

Properties

fireEventsOnSeek?

optional fireEventsOnSeek?: boolean

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

Fire events/audio crossed by a seek. Off by default: scrubbing should not trigger gameplay.

---

host

host: CutsceneHost

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

---

tick?

optional tick?: "auto" | "manual"

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

auto (default) advances on requestAnimationFrame; manual leaves it to the caller's update(dt) — e.g. a stage update hook, so the cutscene pauses with the game.

---

timeScale?

optional timeScale?: number

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

---

transitionShader?

optional transitionShader?: (type) => ZylemTransitionShader | undefined

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

Maps a transition type to a blend shader (e.g. createStageTransition(\{ pattern \}).shader).

Parameters

type

"fade" | "cut" | "wipe" | "radial" | "noise" | "cells"

Returns

ZylemTransitionShader | undefined