Five On It

Appearance

five-on-it / packages/sim/src/vehicle-classes / VehicleClass

Interface: VehicleClass ​

Defined in: packages/sim/src/vehicle-classes.ts:80

Tuning of one vehicle class.

Properties ​

analog? ​

optional analog?: boolean

Defined in: packages/sim/src/vehicle-classes.ts:224

An old car with nothing to hack (R14): no connected engine computer for a kill switch, no electronics an EMP stops (ordnance.ts' pulse leaves its engine running). A flag the police's hacking reads too (a later phase's).

angularDamping ​

angularDamping: number

Defined in: packages/sim/src/vehicle-classes.ts:196

Rapier angular damping of the chassis (keeps spins controllable).

axles ​

axles: AxleDef[]

Defined in: packages/sim/src/vehicle-classes.ts:102

The axles, front to rear.

boat? ​

optional boat?: BoatDef

Defined in: packages/sim/src/vehicle-classes.ts:206

A boat (see BoatDef); none for a car, a truck or a two-wheeler.

boostFactor ​

boostFactor: number

Defined in: packages/sim/src/vehicle-classes.ts:188

Engine multiplier while boosting (double-tap and hold the throttle): sized so that it overpowers the driven tyres and the car can power-drift, whatever the class.

boostRecharge ​

boostRecharge: number

Defined in: packages/sim/src/vehicle-classes.ts:192

How long an empty boost meter takes to refill (s).

boostSeconds ​

boostSeconds: number

Defined in: packages/sim/src/vehicle-classes.ts:190

How long a full boost meter lasts (s).

bullets? ​

optional bullets?: number

Defined in: packages/sim/src/vehicle-classes.ts:214

The share of a bullet's damage it takes (a hitscan weapon's: mods.ts), 1 by default.

centreOfMassDrop ​

centreOfMassDrop: number

Defined in: packages/sim/src/vehicle-classes.ts:98

How far below the chassis centre the centre of mass sits (m). Low enough that the engine impulse at the contact patches cannot lift the nose at 2 g, and that the car does not roll over in a full-lock turn.

coastBrake ​

coastBrake: number

Defined in: packages/sim/src/vehicle-classes.ts:141

Rolling resistance brake applied when the throttle is released.

driftRearGrip ​

driftRearGrip: number

Defined in: packages/sim/src/vehicle-classes.ts:168

Rear grip while a drift is sustained by lateral slip alone.

driftSlipThreshold ​

driftSlipThreshold: number

Defined in: packages/sim/src/vehicle-classes.ts:166

Lateral slip speed (m/s) above which the rear keeps sliding after the handbrake is released.

drivetrain ​

drivetrain: Drivetrain

Defined in: packages/sim/src/vehicle-classes.ts:84

Which axle the engine drives.

enginePlacement ​

enginePlacement: EnginePlacement

Defined in: packages/sim/src/vehicle-classes.ts:86

Where the engine sits.

engineSound ​

engineSound: boolean

Defined in: packages/sim/src/vehicle-classes.ts:115

Whether it has an engine to hear (a bicycle has none).

features? ​

optional features?: VehicleFeatures

Defined in: packages/sim/src/vehicle-classes.ts:204

What the class carries beyond a car's usual fittings; the client reads them (VehicleFeatures).

frictionSlip ​

frictionSlip: number

Defined in: packages/sim/src/vehicle-classes.ts:158

Rapier frictionSlip for every wheel: the tyre's friction coefficient. It caps the force a wheel can transmit (sideways and forward together) at this multiple of the load it carries, so it sets the cornering limit and the traction budget wheelspin is measured against.

gripFront ​

gripFront: number

Defined in: packages/sim/src/vehicle-classes.ts:160

Front wheel side grip.

gripRear ​

gripRear: number

Defined in: packages/sim/src/vehicle-classes.ts:162

Rear wheel side grip when not sliding.

gripRecovery ​

gripRecovery: number

Defined in: packages/sim/src/vehicle-classes.ts:176

How fast grip returns to normal, in grip units per second.

halfExtents ​

halfExtents: [number, number, number]

Defined in: packages/sim/src/vehicle-classes.ts:90

Chassis half-extents [x, y, z]: half width, half height, half length (m).

handbrakeForce ​

handbrakeForce: number

Defined in: packages/sim/src/vehicle-classes.ts:139

Brake force on the rear wheels while the handbrake is held.

handbrakeRearGrip ​

handbrakeRearGrip: number

Defined in: packages/sim/src/vehicle-classes.ts:164

Rear wheel side grip while the handbrake is held.

health? ​

optional health?: number

Defined in: packages/sim/src/vehicle-classes.ts:212

Its full hit points, in a car's (100, the default; mods.ts): an armoured class takes a hit's damage as a share of them, so its hit points on the wire stay out of 100 (what is left) and the fires' and the smoke's thresholds read the same on every class.

jet? ​

optional jet?: JetDef

Defined in: packages/sim/src/vehicle-classes.ts:226

A water jet it carries (jets.ts): a riot truck's turret, a police boat's bow nozzle.

landingControl ​

landingControl: number

Defined in: packages/sim/src/vehicle-classes.ts:183

Share of the steering and engine that still works while stunned (0..1).

landingStun ​

landingStun: number

Defined in: packages/sim/src/vehicle-classes.ts:181

How long the controls stay dulled after landing from a 10 m/s drop (s); shorter drops stun proportionally, hops under 4 m/s not at all.

linearDamping ​

linearDamping: number

Defined in: packages/sim/src/vehicle-classes.ts:194

Rapier linear damping of the chassis (air drag stand-in).

livery? ​

optional livery?: Livery

Defined in: packages/sim/src/vehicle-classes.ts:202

A livery the client paints instead of the owner's colour: police black and white, taxi yellow with a chequered band, ambulance white with a red band, fire red with white bands. None for an ordinary car, which wears its owner's colour.

mass ​

mass: number

Defined in: packages/sim/src/vehicle-classes.ts:92

Chassis mass (kg).

maxBrakeForce ​

maxBrakeForce: number

Defined in: packages/sim/src/vehicle-classes.ts:137

Brake force per wheel when braking with the throttle axis (a Rapier brake value: an impulse per tick).

maxEngineForce ​

maxEngineForce: number

Defined in: packages/sim/src/vehicle-classes.ts:133

Total engine force over the driven wheels at full throttle (N).

maxReverseForce ​

maxReverseForce: number

Defined in: packages/sim/src/vehicle-classes.ts:135

Total engine force in reverse (N).

maxReverseSpeed ​

maxReverseSpeed: number

Defined in: packages/sim/src/vehicle-classes.ts:145

Reverse speed limit (m/s).

maxSpeed ​

maxSpeed: number

Defined in: packages/sim/src/vehicle-classes.ts:143

Forward speed at which the engine stops pushing (m/s).

maxSuspensionForce ​

maxSuspensionForce: number

Defined in: packages/sim/src/vehicle-classes.ts:131

Maximum force one suspension can exert (N); limits launches on ramps.

maxSuspensionTravel ​

maxSuspensionTravel: number

Defined in: packages/sim/src/vehicle-classes.ts:129

Maximum suspension travel (m).

name ​

name: string

Defined in: packages/sim/src/vehicle-classes.ts:82

Display name.

ram? ​

optional ram?: RamPlate

Defined in: packages/sim/src/vehicle-classes.ts:218

A ram plate on its nose (mods.ts): what its rams deal and take, as shares.

runFlats? ​

optional runFlats?: boolean

Defined in: packages/sim/src/vehicle-classes.ts:216

Run-flat tyres: a nail strip slows it a little for a few seconds and pops nothing (mods.ts).

seats ​

seats: number

Defined in: packages/sim/src/vehicle-classes.ts:88

How many characters fit, the driver included.

steerLock ​

steerLock: number

Defined in: packages/sim/src/vehicle-classes.ts:147

Steering lock at standstill (rad).

steerLockHighSpeed ​

steerLockHighSpeed: number

Defined in: packages/sim/src/vehicle-classes.ts:149

Steering lock at maxSpeed (rad); linearly interpolated in between.

steerRate ​

steerRate: number

Defined in: packages/sim/src/vehicle-classes.ts:151

How fast the steering moves toward the input, in fraction of lock per second.

suspensionCompression ​

suspensionCompression: number

Defined in: packages/sim/src/vehicle-classes.ts:125

Suspension compression damping.

suspensionRelaxation ​

suspensionRelaxation: number

Defined in: packages/sim/src/vehicle-classes.ts:127

Suspension relaxation damping.

suspensionRest ​

suspensionRest: number

Defined in: packages/sim/src/vehicle-classes.ts:121

Suspension rest length (m).

suspensionStiffness ​

suspensionStiffness: number

Defined in: packages/sim/src/vehicle-classes.ts:123

Suspension spring stiffness (per kg of chassis; Rapier multiplies by the mass).

thirst? ​

optional thirst?: number

Defined in: packages/sim/src/vehicle-classes.ts:228

How many fill-ups a fill-up at a pump costs (fuel.ts): a thirsty armoured limo's 3; 1 by default.

track ​

track: number

Defined in: packages/sim/src/vehicle-classes.ts:104

Half the distance between the left and right wheels (m).

trailer? ​

optional trailer?: TrailerDef

Defined in: packages/sim/src/vehicle-classes.ts:113

A trailer towed behind the chassis, if any.

trunk? ​

optional trunk?: number

Defined in: packages/sim/src/vehicle-classes.ts:111

Its trunk's slots (items.ts): a pickup's bed holds more, a delivery scooter's top box a few; by default a car's six, a two-wheeler's none.

twoWheeler ​

twoWheeler: boolean

Defined in: packages/sim/src/vehicle-classes.ts:109

A two-wheeler: one raycast wheel per axle on the centre line, held upright by a self-righting torque (the arcade way); the lean into corners is drawn, not simulated.

wheelAttachY ​

wheelAttachY: number

Defined in: packages/sim/src/vehicle-classes.ts:117

Height of the wheel attachment relative to the chassis centre (m).

wheelBase ​

wheelBase: number

Defined in: packages/sim/src/vehicle-classes.ts:100

Half the distance between the front and rear axles (m); the lever the slip and the engine shift are measured on.

wheelRadius ​

wheelRadius: number

Defined in: packages/sim/src/vehicle-classes.ts:119

Wheel radius (m).

wheelspinGrip ​

wheelspinGrip: number

Defined in: packages/sim/src/vehicle-classes.ts:174

Side grip of a driven axle whose tyres spin, reached when the engine asks for 1.4× what the tyres can put down. Rear-wheel drive turns this into power oversteer (and donuts); front-wheel drive into power understeer.