Interface ReplayRecorderOptions

How a recording session is configured (§34).

interface ReplayRecorderOptions {
    fixedDeltaTime: number;
    metadata?: { readonly [key: string]: JsonValue };
    seed?: number;
    snapshotIntervalSteps?: number;
}

Properties

fixedDeltaTime: number

The fixed simulation step, in seconds (§10). Must be finite and > 0.

metadata?: { readonly [key: string]: JsonValue }

Free-form JSON the caller wants pinned to the recording: a scenario name, a build id, a date the caller read. Validated and deep-copied.

seed?: number

The run's RNG seed (§33), when there is one.

snapshotIntervalSteps?: number

Capture a periodic snapshot roughly every N simulation steps (§34).

Omit — or pass 0 — for none. See ReplayRecorder.recordFrame for exactly where the snapshots land.