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:22

Inputs of the HUD.

Properties ​

aim ​

aim: number

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

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

armour ​

armour: number

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

The player's body armour (@foi/sim's gear.ts), 0 to 200: a bar beside the health while there is any.

boat? ​

optional boat?: boolean

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

The player is in a boat: its speed reads in knots, and whether it floats instead of the wheels.

boost ​

boost: number

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

Boost meter (1 = full).

boosting ​

boosting: boolean

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

Boosting right now.

carFire ​

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

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

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:72

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

chasers ​

chasers: object[]

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

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:28

Client id once welcomed.

connection ​

connection: string

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

connecting, connected or disconnected.

cooking ​

cooking: number

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

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

cover ​

cover: number

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

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

coverLow ​

coverLow: boolean

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

The cover is low (hidden means crouching).

fps ​

fps: number

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

Frames per second.

gear ​

gear: readonly GearWord[]

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

What the player's gear does now, as words (hudText.gear.<word>): gassed, a mask on, the suit on, an adrenaline shot, stunned, the car stalled.

gripFront ​

gripFront: number

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

Front grip (1 = full).

gripRear ​

gripRear: number

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

Rear grip (1 = full).

health ​

health: number

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

The player's hit points.

invincible ​

invincible: boolean

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

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

kit? ​

optional kit?: CarKit

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

The upgrades of the car the player drives (mods.ts, jets.ts), when it has any to show: describeKit.

landing ​

landing: number

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

Seconds of dulled control left after a hard landing.

lastCorrection ​

lastCorrection: number

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

Last correction (m).

level ​

level: string

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

Name of the level the server runs.

log ​

log: string[]

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

The latest hits given and taken, oldest first.

maxCorrection ​

maxCorrection: number

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

Largest correction (m).

maxHealth ​

maxHealth: number

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

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:86

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

peeking ​

peeking: boolean

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

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:101

Unacknowledged inputs.

prediction ​

prediction: boolean

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

Prediction on or off.

remotes ​

remotes: number

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

Other players' cars, trailers and characters on screen.

render ​

render: string

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

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:115

Runtime label (Electron 44 or browser).

serverTick ​

serverTick: number

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

Latest server tick.

simulatedLossPercent ​

simulatedLossPercent: number

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

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

simulatedRttMs ​

simulatedRttMs: number

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

Simulated round-trip time (ms).

slip ​

slip: number

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

Rear-axle lateral slip (m/s).

smoothing ​

smoothing: boolean

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

Correction smoothing on or off.

speed ​

speed: number

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

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:123

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:76

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:54

Bitmask of flat tyres.

vehicle ​

vehicle: string

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

Where the player is: from describeSeat.

via? ​

optional via?: string

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

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:121

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:84

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:58

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

wheelContact ​

wheelContact: number

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

Bitmask of wheels on the ground; on foot, bit 0 = standing; in a boat, 1 afloat.

wheels ​

wheels: number

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

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:42

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

x ​

x: number

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

Where the character stands (m).

z ​

z: number

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