Skip to main content

StageCutsceneHostOptions

@zylem/game-lib

@zylem/game-lib / cinematics / StageCutsceneHostOptions

Interface: StageCutsceneHostOptions

Defined in: packages/game-lib/src/lib/cinematics/stage-host.ts:12

Properties​

onEvent?​

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

Defined in: packages/game-lib/src/lib/cinematics/stage-host.ts:22

Called for emit events in addition to the stage dispatch.

Parameters​

name​

string

payload​

Record<string, unknown>

Returns​

void

resolveSong?​

optional resolveSong?: (ref) => \{ bpm: number; clips: (\{ id: string; kind: "notes"; length: number; name?: string; notes: object[]; start: number; trackId: string; \} | \{ gain?: number; id: string; kind: "audio"; length: number; name?: string; offset?: number; start: number; trackId: string; url: string; \})[]; id: string; instruments: object[]; lengthBars: number; loop?: \{ enabled: boolean; end: number; start: number; \}; masterVolume?: number; name: string; timeSignature: \{ denominator: number; numerator: number; \}; tracks: object[]; \} | Promise<\{ bpm: number; clips: (\{ id: string; kind: "notes"; length: number; name?: string; notes: object[]; start: number; trackId: string; \} | \{ gain?: number; id: string; kind: "audio"; length: number; name?: string; offset?: number; start: number; trackId: string; url: string; \})[]; id: string; instruments: object[]; lengthBars: number; loop?: \{ enabled: boolean; end: number; start: number; \}; masterVolume?: number; name: string; timeSignature: \{ denominator: number; numerator: number; \}; tracks: object[]; \} | undefined> | undefined

Defined in: packages/game-lib/src/lib/cinematics/stage-host.ts:18

Looks a song reference (slug or URL from a playSong event / audio item) up to a definition the audio module can play. Without it song items are ignored.

Parameters​

ref​

string

Returns​

Type Literal​

\{ bpm: number; clips: (\{ id: string; kind: "notes"; length: number; name?: string; notes: object[]; start: number; trackId: string; \} | \{ gain?: number; id: string; kind: "audio"; length: number; name?: string; offset?: number; start: number; trackId: string; url: string; \})[]; id: string; instruments: object[]; lengthBars: number; loop?: \{ enabled: boolean; end: number; start: number; \}; masterVolume?: number; name: string; timeSignature: \{ denominator: number; numerator: number; \}; tracks: object[]; \}

bpm​

bpm: number

clips​

clips: (\{ id: string; kind: "notes"; length: number; name?: string; notes: object[]; start: number; trackId: string; \} | \{ gain?: number; id: string; kind: "audio"; length: number; name?: string; offset?: number; start: number; trackId: string; url: string; \})[]

id​

id: string

instruments​

instruments: object[]

lengthBars​

lengthBars: number

loop?​

optional loop?: object

loop.enabled​

enabled: boolean

loop.end​

end: number

loop.start​

start: number

Beats.

masterVolume?​

optional masterVolume?: number

Master fader in dB.

name​

name: string

timeSignature​

timeSignature: object = TimeSignatureSchema

timeSignature.denominator​

denominator: number

timeSignature.numerator​

numerator: number

tracks​

tracks: object[]

Promise<\{ bpm: number; clips: (\{ id: string; kind: "notes"; length: number; name?: string; notes: object[]; start: number; trackId: string; \} | \{ gain?: number; id: string; kind: "audio"; length: number; name?: string; offset?: number; start: number; trackId: string; url: string; \})[]; id: string; instruments: object[]; lengthBars: number; loop?: \{ enabled: boolean; end: number; start: number; \}; masterVolume?: number; name: string; timeSignature: \{ denominator: number; numerator: number; \}; tracks: object[]; \} | undefined>

undefined

transitionShader?​

optional transitionShader?: (type) => ZylemTransitionShader | undefined

Defined in: packages/game-lib/src/lib/cinematics/stage-host.ts:20

Maps a transition type to a blend shader; defaults to a crossfade for every type.

Parameters​

type​

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

Returns​

ZylemTransitionShader | undefined