CutsceneDefinitionSchema

@zylem/game-lib / cinematics / CutsceneDefinitionSchema

Variable: CutsceneDefinitionSchema

const CutsceneDefinitionSchema: TObject<\{ cameras: TArray<TObject<\{ damping: TNumber; dollyEasing: TUnion<[TLiteral<"linear">, TLiteral<"easeIn">, TLiteral<"easeOut">, TLiteral<"easeInOut">]>; dollyId: TOptional<TString>; fov: TNumber; id: TString; keyframes: TArray<TObject<\{ easing: TUnion<[TLiteral<...>, TLiteral<...>, TLiteral<...>, TLiteral<...>]>; fov: TOptional<TNumber>; id: TString; lookAt: TOptional<TObject<\{ x: ...; y: ...; z: ...; \}>>; position: TOptional<TObject<\{ x: ...; y: ...; z: ...; \}>>; time: TNumber; \}>>; kind: TUnion<[TLiteral<"static">, TLiteral<"dolly">, TLiteral<"follow">]>; name: TString; offset: TOptional<TObject<\{ x: TNumber; y: TNumber; z: TNumber; \}>>; pose: TObject<\{ lookAt: TObject<\{ x: TNumber; y: TNumber; z: TNumber; \}>; position: TObject<\{ x: TNumber; y: TNumber; z: TNumber; \}>; \}>; target: TOptional<TString>; \}>>; dollies: TArray<TObject<\{ closed: TBoolean; id: TString; name: TString; points: TArray<TObject<\{ x: TNumber; y: TNumber; z: TNumber; \}>>; tension: TNumber; \}>>; duration: TNumber; id: TString; name: TString; scenes: TArray<TObject<\{ end: TNumber; id: TString; name: TString; start: TNumber; transitionIn: TObject<\{ duration: TNumber; easing: TUnion<[TLiteral<"linear">, TLiteral<"easeIn">, TLiteral<"easeOut">, TLiteral<"easeInOut">]>; type: TUnion<[TLiteral<"cut">, TLiteral<"fade">, TLiteral<"wipe">, TLiteral<"radial">, TLiteral<"noise">, TLiteral<"cells">]>; \}>; \}>>; skippable: TBoolean; stage: TUnion<[TString, TNull]>; tracks: TArray<TUnion<[TObject<\{ id: TString; items: TArray<TObject<\{ blend: TObject<...>; cameraId: TString; end: TNumber; id: TString; start: TNumber; \}>>; kind: TLiteral<"camera">; name: TString; \}>, TObject<\{ id: TString; items: TArray<TObject<\{ event: TUnion<...>; id: TString; time: TNumber; \}>>; kind: TLiteral<"event">; name: TString; \}>, TObject<\{ id: TString; items: TArray<TObject<\{ id: TString; kind: TUnion<...>; loop: TBoolean; ref: TString; time: TNumber; volume: TNumber; \}>>; kind: TLiteral<"audio">; name: TString; \}>]>>; \}>

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

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