Skip to main content

CutsceneTrackSchema

@zylem/game-lib

@zylem/game-lib / cinematics / CutsceneTrackSchema

Variable: CutsceneTrackSchema

const CutsceneTrackSchema: TUnion<[TObject<\{ id: TString; items: TArray<TObject<\{ blend: TObject<\{ duration: TNumber; easing: TUnion<[..., ..., ..., ...]>; \}>; cameraId: TString; end: TNumber; id: TString; start: TNumber; \}>>; kind: TLiteral<"camera">; name: TString; \}>, TObject<\{ id: TString; items: TArray<TObject<\{ event: TUnion<[TObject<\{ name: ...; payload: ...; type: ...; \}>, TObject<\{ entity: ...; key: ...; type: ...; \}>, TObject<\{ loop: ...; song: ...; type: ...; \}>, TObject<\{ song: ...; type: ...; \}>, TObject<\{ name: ...; type: ...; value: ...; \}>]>; id: TString; time: TNumber; \}>>; kind: TLiteral<"event">; name: TString; \}>, TObject<\{ id: TString; items: TArray<TObject<\{ id: TString; kind: TUnion<[TLiteral<"song">, TLiteral<"sfx">]>; loop: TBoolean; ref: TString; time: TNumber; volume: TNumber; \}>>; kind: TLiteral<"audio">; name: TString; \}>]>

Defined in: packages/game-lib/src/lib/cinematics/cutscene-definition.ts:235

@zylem/game-lib/cinematics public API.

In-game cutscenes authored in Creator's Director mode: a timeline of scenes, cameras (static, dolly, follow) placed as shots with keyframes and blends, plus event and audio tracks. createCutscenePlayer drives a live stage's camera through the camera pipeline and fires the gameplay hooks.