DriftEngine

In-game tools · function

sessionReadout

The session and what has been seen of it, as the panel's readout.

Explained in In-game tools.

function sessionReadout(session: SessionLike, recorder: SessionRecorder, snapshotBytes: number, componentHashes?: NetworkReadout['componentHashes']): NetworkReadout
import { sessionReadout } from '@driftengine/tools';

Parameters

ParameterTypeDescription
sessionSessionLike
recorderSessionRecorder
snapshotBytesnumber
componentHashes?NetworkReadout['componentHashes']

In depth

snapshotBytes is the caller's, because the engine cannot know it. RewindLoop is generic over the state it snapshots, so its depth is knowable here and the size of one is not. A caller passing zero is saying it has not measured, which the panel renders as such.