Skip to content

Kiln API / kiln / Recording

Interface: Recording ​

A recorded session. JSON; save it under recordings/ and replay it with replay() or kiln replay.

Properties ​

PropertyTypeDescription
kiln"recording"-
version1-
configobjectThe loop config the session ran with. Replays build the app with the same values.
config.seednumber-
config.fixedHznumber-
config.maxFrameDtnumber-
config.maxFixedStepsnumber-
config.mode"2d" | "3d"-
framesnumberFrames recorded. Frame 1 is the first frame after Startup.
dtnumber[]Each frame's delta in seconds (clamped by maxFrameDt), dt[0] for frame 1.
exactnumber[]Frames that ran exactly one fixed step (the debug panel's "Step 1 frame").
inputScriptEvent[]What the game saw from the input plugin, as an input script relative to boot.
start?Record<string, unknown>Outside state the session started with, by plugin ('save': the game's stored saves and settings).
channelsChannelEvent[]Side-channel events: 'ui-click' (DOM HUD buttons), 'asset' (a load finished).
checkEverynumberCheckpoint spacing in frames and rounding (decimals) for the state hashes.
checkPrecisionnumber-
checksobject[]State hash (entities and Rng) after the frame's Late phase, every checkEvery frames.
final?SnapshotEntities and resources when the recording was taken (precision 4).
error?objectThe error that stopped the session, if one did.
error.framenumber-
error.messagestring-
error.code?string-
notesstring[]Things a reader should know (hot swaps mid-session).
recordedAt?string-