CutsceneHost

@zylem/game-lib

---

@zylem/game-lib / cinematics / CutsceneHost

Interface: CutsceneHost

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

What the player needs from the running game. createStageCutsceneHost builds one from a live stage; tests and the editor can hand in stubs.

Properties

beginTransition?

optional beginTransition?: (transition, shader) => void

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

Runs a picture transition into the new scene: snapshot the current frame and blend it into the frames that follow. Omit to hard-cut everywhere.

Parameters

transition

duration

number = ...

Seconds; ignored for cut.

easing

"linear" | "easeInOut" | "easeIn" | "easeOut" = CutsceneEasingSchema

type

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

shader

ZylemTransitionShader | undefined

Returns

void

---

camera

camera: () => ZylemCamera | null

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

The camera the cutscene drives; resolved each frame so stage swaps are safe.

Returns

ZylemCamera | null

---

dispatch?

optional dispatch?: (name, payload) => void

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

Stage event dispatch (emit events).

Parameters

name

string

payload

Record<string, unknown>

Returns

void

---

entityPosition?

optional entityPosition?: (name) => \{ x: number; y: number; z: number; \} | undefined

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

World position of a named entity, for follow cameras and dolly look-ats.

Parameters

name

string

Returns

\{ x: number; y: number; z: number; \} | undefined

---

playAnimation?

optional playAnimation?: (entity, key) => void

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

Parameters

entity

string

key

string

Returns

void

---

playSfx?

optional playSfx?: (url, options) => void

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

Parameters

url

string

options

loop

boolean

volume

number

Returns

void

---

playSong?

optional playSong?: (ref, options) => void

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

Parameters

ref

string

options

loop

boolean

volume

number

Returns

void

---

setVariable?

optional setVariable?: (name, value) => void

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

Parameters

name

string

value

unknown

Returns

void

---

stopSong?

optional stopSong?: (ref?) => void

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

Parameters

ref?

string

Returns

void