In-game tools · interface

NetworkReadout

What the panel needs of a session.

Explained in In-game tools.

interface NetworkReadout
import type { NetworkReadout } from '@driftengine/tools';

In depth

Supplied rather than read off a LockstepSession, for the reason the asset index is supplied: an editor attached to a session, a recording or a replay wants the same panel, and only two of those have a session to read.

Properties

NameTypeDescription
inputDelayreadonlynumber
participantsreadonlynumber
snapshotBytesreadonlynumberBytes in one snapshot slot.
snapshotCountreadonlynumberHow many slots the rewind window holds.
desyncsreadonlyreadonly Desync[]Everything the session has seen disagree, oldest first.
componentHashesreadonly{ readonly ours: ReadonlyMap<string, string>; readonly theirs: ReadonlyMap<string, string>; } | nullA per-component breakdown, where the caller has one. See the header.