Five On It

Appearance

five-on-it / packages/protocol/src/snapshot-v2 / DeltaFrame

Interface: DeltaFrame ​

Defined in: packages/protocol/src/snapshot-v2.ts:285

What one client is sent of a tick: the header's values, its entities and its events.

Properties ​

due ​

due: (eid) => boolean

Defined in: packages/protocol/src/snapshot-v2.ts:292

Whether an entity's pose is due this frame (a far one's is sent less often); what it is and does always goes, and the whole of one it has not got.

Parameters ​

eid ​

number

Returns ​

boolean

entities ​

entities: readonly number[]

Defined in: packages/protocol/src/snapshot-v2.ts:290

The entities the client sees, by id (all in the arena).

events ​

events: readonly GameEvent[]

Defined in: packages/protocol/src/snapshot-v2.ts:297

full ​

full: (eid) => boolean

Defined in: packages/protocol/src/snapshot-v2.ts:294

Whether an entity's pose goes full (the client's own character, car and trailer).

Parameters ​

eid ​

number

Returns ​

boolean

inputBuffer ​

inputBuffer: number

Defined in: packages/protocol/src/snapshot-v2.ts:288

lastSeq ​

lastSeq: number

Defined in: packages/protocol/src/snapshot-v2.ts:287

tick ​

tick: number

Defined in: packages/protocol/src/snapshot-v2.ts:286

tier ​

tier: (eid) => number

Defined in: packages/protocol/src/snapshot-v2.ts:296

An entity's tier for this client (TIER_EVERY), carried in each of its changes.

Parameters ​

eid ​

number

Returns ​

number