CutsceneScript

interface CutsceneScript

A scripted scene. prepare resolves everything the script needs from the live world — body positions, radii, the stage anchor — once, at play time; sample is then a pure function of the (fractional) frame number. The split matters: sampling runs every rendered frame and must not touch the world, or a paused cutscene would still be asking the universe questions.

devtools/src/cutscene.ts:35

Members

descriptionreadonly

description: string

One line for the dock and ir.cutscene.list().

durationFramesreadonly

durationFrames: number

fpsreadonly

fps: number

Frames per second of the reference edit this script is timed against.

idreadonly

id: string

soundtrackreadonly

soundtrack?: string

The name of the track the scene is cut to, under the site's /media/, without its extension — the overlay asks for it in whichever encoding the browser decodes. Absent for a scene with no music, which plays silent.

Sound is staging, so the script declares it, the same way a script turns an effect on. A track chosen by the overlay is a track for every scene: the title sequence's music played over the Mars landing, from the first frame of the entry burn, because the overlay owned one track and started it for whatever was open.

prepare

prepare(world: World) → PreparedCutscene
worldWorld
Undocumented