CutsceneEventSchema

@zylem/game-lib / cinematics / CutsceneEventSchema

Variable: CutsceneEventSchema

const CutsceneEventSchema: TUnion<[TObject<\{ name: TString; payload: TRecord<TString, TUnion<[TString, TNumber, TBoolean]>>; type: TLiteral<"emit">; \}>, TObject<\{ entity: TString; key: TString; type: TLiteral<"playAnimation">; \}>, TObject<\{ loop: TBoolean; song: TString; type: TLiteral<"playSong">; \}>, TObject<\{ song: TOptional<TString>; type: TLiteral<"stopSong">; \}>, TObject<\{ name: TString; type: TLiteral<"setVariable">; value: TUnion<[TString, TNumber, TBoolean]>; \}>]>

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

@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.