Five On It

Appearance

five-on-it / apps/client/src/renderer/hud-format / HudState

Interface: HudState ​

Defined in: apps/client/src/renderer/hud-format.ts:19

Inputs of the HUD.

Properties ​

aim ​

aim: number

Defined in: apps/client/src/renderer/hud-format.ts:79

Where the character aims (rad, 0 faces +z).

boost ​

boost: number

Defined in: apps/client/src/renderer/hud-format.ts:43

Boost meter (1 = full).

boosting ​

boosting: boolean

Defined in: apps/client/src/renderer/hud-format.ts:45

Boosting right now.

carFire ​

carFire: "" | "burning" | "smoking"

Defined in: apps/client/src/renderer/hud-format.ts:65

That car's fire: smoking low on hit points (about to catch fire), burning on fire (get out before it blows up), else empty.

carHealth ​

carHealth: number

Defined in: apps/client/src/renderer/hud-format.ts:63

Hit points of the car the player sits in; -1 on foot.

chasers ​

chasers: object[]

Defined in: apps/client/src/renderer/hud-format.ts:110

The chasers the server reads out: what each does and how far away it is (empty without any).

distance ​

distance: number

eid ​

eid: number

mode ​

mode: string

seated ​

seated: boolean

clientId ​

clientId: number

Defined in: apps/client/src/renderer/hud-format.ts:25

Client id once welcomed.

connection ​

connection: string

Defined in: apps/client/src/renderer/hud-format.ts:21

connecting, connected or disconnected.

cooking ​

cooking: number

Defined in: apps/client/src/renderer/hud-format.ts:55

Seconds left on the grenade held with its pin out (0 = none).

cover ​

cover: number

Defined in: apps/client/src/renderer/hud-format.ts:69

Cover: 0 in the open, 1 hidden, 2 popped up.

coverLow ​

coverLow: boolean

Defined in: apps/client/src/renderer/hud-format.ts:71

The cover is low (hidden means crouching).

fps ​

fps: number

Defined in: apps/client/src/renderer/hud-format.ts:88

Frames per second.

gripFront ​

gripFront: number

Defined in: apps/client/src/renderer/hud-format.ts:35

Front grip (1 = full).

gripRear ​

gripRear: number

Defined in: apps/client/src/renderer/hud-format.ts:37

Rear grip (1 = full).

health ​

health: number

Defined in: apps/client/src/renderer/hud-format.ts:57

The player's hit points.

invincible ​

invincible: boolean

Defined in: apps/client/src/renderer/hud-format.ts:61

The player shrugs off every hit (the infinite-health switch): the bar reads ∞.

landing ​

landing: number

Defined in: apps/client/src/renderer/hud-format.ts:41

Seconds of dulled control left after a hard landing.

lastCorrection ​

lastCorrection: number

Defined in: apps/client/src/renderer/hud-format.ts:94

Last correction (m).

level ​

level: string

Defined in: apps/client/src/renderer/hud-format.ts:27

Name of the level the server runs.

log ​

log: string[]

Defined in: apps/client/src/renderer/hud-format.ts:84

The latest hits given and taken, oldest first.

maxCorrection ​

maxCorrection: number

Defined in: apps/client/src/renderer/hud-format.ts:96

Largest correction (m).

maxHealth ​

maxHealth: number

Defined in: apps/client/src/renderer/hud-format.ts:59

The player's full hit points (a player's, or the Player page's max health).

onFoot ​

onFoot: boolean

Defined in: apps/client/src/renderer/hud-format.ts:77

The player is on foot (the character line is shown).

peeking ​

peeking: boolean

Defined in: apps/client/src/renderer/hud-format.ts:73

Popped up past the end of tall cover (leaning out of it, or on the way).

pending ​

pending: number

Defined in: apps/client/src/renderer/hud-format.ts:92

Unacknowledged inputs.

prediction ​

prediction: boolean

Defined in: apps/client/src/renderer/hud-format.ts:90

Prediction on or off.

remotes ​

remotes: number

Defined in: apps/client/src/renderer/hud-format.ts:104

Other players' cars, trailers and characters on screen.

render ​

render: string

Defined in: apps/client/src/renderer/hud-format.ts:108

How the engine draws when it draws cheaper (no GPU); empty on a GPU.

runtime ​

runtime: string

Defined in: apps/client/src/renderer/hud-format.ts:106

Runtime label (Electron 44 or browser).

serverTick ​

serverTick: number

Defined in: apps/client/src/renderer/hud-format.ts:86

Latest server tick.

simulatedLossPercent ​

simulatedLossPercent: number

Defined in: apps/client/src/renderer/hud-format.ts:100

Simulated loss of the snapshots and the inputs (%).

simulatedRttMs ​

simulatedRttMs: number

Defined in: apps/client/src/renderer/hud-format.ts:98

Simulated round-trip time (ms).

slip ​

slip: number

Defined in: apps/client/src/renderer/hud-format.ts:33

Rear-axle lateral slip (m/s).

smoothing ​

smoothing: boolean

Defined in: apps/client/src/renderer/hud-format.ts:102

Correction smoothing on or off.

speed ​

speed: number

Defined in: apps/client/src/renderer/hud-format.ts:31

Signed forward speed of the car, or walking speed on foot (m/s).

stealth? ​

optional stealth?: object

Defined in: apps/client/src/renderer/hud-format.ts:114

The player's stealth, where the room watches its players: seen or hidden, and the room's alert.

alert ​

alert: string

visibility ​

visibility: string

target ​

target: string

Defined in: apps/client/src/renderer/hud-format.ts:67

The target on the line of fire, from describeTarget; empty with nobody there.

tyres ​

tyres: number

Defined in: apps/client/src/renderer/hud-format.ts:49

Bitmask of flat tyres.

vehicle ​

vehicle: string

Defined in: apps/client/src/renderer/hud-format.ts:29

Where the player is: from describeSeat.

via? ​

optional via?: string

Defined in: apps/client/src/renderer/hud-format.ts:23

Which way the inputs and the snapshots go while connected: udp (a WebRTC data channel) or ws (rtc.ts).

wanted ​

wanted: object

Defined in: apps/client/src/renderer/hud-format.ts:112

The player's Wanted level: the stars, the Heat behind them, whether the police see the player.

heat ​

heat: number

seen ​

seen: boolean

stars ​

stars: number

water ​

water: "" | "swimming" | "wading"

Defined in: apps/client/src/renderer/hud-format.ts:75

In water on foot: wading (over the knees), swimming (out of its depth), else empty.

weapon ​

weapon: string

Defined in: apps/client/src/renderer/hud-format.ts:53

The weapon held with the ammunition left for it (weaponLine).

wheelContact ​

wheelContact: number

Defined in: apps/client/src/renderer/hud-format.ts:47

Bitmask of wheels on the ground; on foot, bit 0 = standing.

wheels ​

wheels: number

Defined in: apps/client/src/renderer/hud-format.ts:51

Raycast wheels of the car (two per axle, one per axle on a two-wheeler).

wheelspin ​

wheelspin: number

Defined in: apps/client/src/renderer/hud-format.ts:39

How hard the driven tyres spin (0..1).

x ​

x: number

Defined in: apps/client/src/renderer/hud-format.ts:81

Where the character stands (m).

z ​

z: number

Defined in: apps/client/src/renderer/hud-format.ts:82