CutscenePlayerEvents
@zylem/game-lib / cinematics / CutscenePlayerEvents
Interface: CutscenePlayerEvents
Defined in: packages/game-lib/src/lib/cinematics/cutscene-player.ts:57
Properties
audio
audio: (
item) =>void
Defined in: packages/game-lib/src/lib/cinematics/cutscene-player.ts:63
Parameters
item
id
string = ...
kind
"song" | "sfx" = ...
loop
boolean = ...
ref
string = ...
Song slug for song, asset URL for sfx.
time
number = ...
volume
number = ...
Gain in dB.
Returns
void
complete
complete: () =>
void
Defined in: packages/game-lib/src/lib/cinematics/cutscene-player.ts:64
Returns
void
event
event: (
item) =>void
Defined in: packages/game-lib/src/lib/cinematics/cutscene-player.ts:62
Parameters
item
event
\{ name: string; payload: \{[key: string]: string | number | boolean; \}; type: "emit"; \} | \{ entity: string; key: string; type: "playAnimation"; \} | \{ loop: boolean; song: string; type: "playSong"; \} | \{ song?: string; type: "stopSong"; \} | \{ name: string; type: "setVariable"; value: string | number | boolean; \} = CutsceneEventSchema
id
string = ...
time
number = ...
Returns
void
scene
scene: (
scene) =>void
Defined in: packages/game-lib/src/lib/cinematics/cutscene-player.ts:60
Parameters
scene
\{ end: number; id: string; name: string; start: number; transitionIn: \{ duration: number; easing: "linear" | "easeInOut" | "easeIn" | "easeOut"; type: "fade" | "cut" | "wipe" | "radial" | "noise" | "cells"; \}; \} | undefined
Type Literal
\{ end: number; id: string; name: string; start: number; transitionIn: \{ duration: number; easing: "linear" | "easeInOut" | "easeIn" | "easeOut"; type: "fade" | "cut" | "wipe" | "radial" | "noise" | "cells"; \}; \}
end
number = ...
id
string = ...
name
string = ...
start
number = ...
Seconds from the cutscene start.
transitionIn
\{ duration: number; easing: "linear" | "easeInOut" | "easeIn" | "easeOut"; type: "fade" | "cut" | "wipe" | "radial" | "noise" | "cells"; \} = SceneTransitionSchema
How the picture arrives at this scene's start.
transitionIn.duration
number = ...
Seconds; ignored for cut.
transitionIn.easing
"linear" | "easeInOut" | "easeIn" | "easeOut" = CutsceneEasingSchema
transitionIn.type
"fade" | "cut" | "wipe" | "radial" | "noise" | "cells" = SceneTransitionTypeSchema
undefined
Returns
void
shot
shot: (
shot) =>void
Defined in: packages/game-lib/src/lib/cinematics/cutscene-player.ts:61
Parameters
shot
\{ blend: \{ duration: number; easing: "linear" | "easeInOut" | "easeIn" | "easeOut"; \}; cameraId: string; end: number; id: string; start: number; \} | undefined
Returns
void
skip
skip: () =>
void
Defined in: packages/game-lib/src/lib/cinematics/cutscene-player.ts:65
Returns
void
state
state: (
state) =>void
Defined in: packages/game-lib/src/lib/cinematics/cutscene-player.ts:59
Parameters
state
Returns
void
time
time: (
time) =>void
Defined in: packages/game-lib/src/lib/cinematics/cutscene-player.ts:58
Parameters
time
number
Returns
void