five-on-it / packages/sim/src/vehicle-classes / VehicleClass
Interface: VehicleClass
Defined in: packages/sim/src/vehicle-classes.ts:52
Tuning of one vehicle class.
Properties
angularDamping
angularDamping:
number
Defined in: packages/sim/src/vehicle-classes.ts:168
Rapier angular damping of the chassis (keeps spins controllable).
axles
axles:
AxleDef[]
Defined in: packages/sim/src/vehicle-classes.ts:74
The axles, front to rear.
boostFactor
boostFactor:
number
Defined in: packages/sim/src/vehicle-classes.ts:160
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:164
How long an empty boost meter takes to refill (s).
boostSeconds
boostSeconds:
number
Defined in: packages/sim/src/vehicle-classes.ts:162
How long a full boost meter lasts (s).
centreOfMassDrop
centreOfMassDrop:
number
Defined in: packages/sim/src/vehicle-classes.ts:70
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:113
Rolling resistance brake applied when the throttle is released.
driftRearGrip
driftRearGrip:
number
Defined in: packages/sim/src/vehicle-classes.ts:140
Rear grip while a drift is sustained by lateral slip alone.
driftSlipThreshold
driftSlipThreshold:
number
Defined in: packages/sim/src/vehicle-classes.ts:138
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:56
Which axle the engine drives.
enginePlacement
enginePlacement:
EnginePlacement
Defined in: packages/sim/src/vehicle-classes.ts:58
Where the engine sits.
engineSound
engineSound:
boolean
Defined in: packages/sim/src/vehicle-classes.ts:87
Whether it has an engine to hear (a bicycle has none).
features?
optionalfeatures?:VehicleFeatures
Defined in: packages/sim/src/vehicle-classes.ts:176
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:130
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:132
Front wheel side grip.
gripRear
gripRear:
number
Defined in: packages/sim/src/vehicle-classes.ts:134
Rear wheel side grip when not sliding.
gripRecovery
gripRecovery:
number
Defined in: packages/sim/src/vehicle-classes.ts:148
How fast grip returns to normal, in grip units per second.
halfExtents
halfExtents: [
number,number,number]
Defined in: packages/sim/src/vehicle-classes.ts:62
Chassis half-extents [x, y, z]: half width, half height, half length (m).
handbrakeForce
handbrakeForce:
number
Defined in: packages/sim/src/vehicle-classes.ts:111
Brake force on the rear wheels while the handbrake is held.
handbrakeRearGrip
handbrakeRearGrip:
number
Defined in: packages/sim/src/vehicle-classes.ts:136
Rear wheel side grip while the handbrake is held.
landingControl
landingControl:
number
Defined in: packages/sim/src/vehicle-classes.ts:155
Share of the steering and engine that still works while stunned (0..1).
landingStun
landingStun:
number
Defined in: packages/sim/src/vehicle-classes.ts:153
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:166
Rapier linear damping of the chassis (air drag stand-in).
livery?
optionallivery?:Livery
Defined in: packages/sim/src/vehicle-classes.ts:174
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:64
Chassis mass (kg).
maxBrakeForce
maxBrakeForce:
number
Defined in: packages/sim/src/vehicle-classes.ts:109
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:105
Total engine force over the driven wheels at full throttle (N).
maxReverseForce
maxReverseForce:
number
Defined in: packages/sim/src/vehicle-classes.ts:107
Total engine force in reverse (N).
maxReverseSpeed
maxReverseSpeed:
number
Defined in: packages/sim/src/vehicle-classes.ts:117
Reverse speed limit (m/s).
maxSpeed
maxSpeed:
number
Defined in: packages/sim/src/vehicle-classes.ts:115
Forward speed at which the engine stops pushing (m/s).
maxSuspensionForce
maxSuspensionForce:
number
Defined in: packages/sim/src/vehicle-classes.ts:103
Maximum force one suspension can exert (N); limits launches on ramps.
maxSuspensionTravel
maxSuspensionTravel:
number
Defined in: packages/sim/src/vehicle-classes.ts:101
Maximum suspension travel (m).
name
name:
string
Defined in: packages/sim/src/vehicle-classes.ts:54
Display name.
seats
seats:
number
Defined in: packages/sim/src/vehicle-classes.ts:60
How many characters fit, the driver included.
steerLock
steerLock:
number
Defined in: packages/sim/src/vehicle-classes.ts:119
Steering lock at standstill (rad).
steerLockHighSpeed
steerLockHighSpeed:
number
Defined in: packages/sim/src/vehicle-classes.ts:121
Steering lock at maxSpeed (rad); linearly interpolated in between.
steerRate
steerRate:
number
Defined in: packages/sim/src/vehicle-classes.ts:123
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:97
Suspension compression damping.
suspensionRelaxation
suspensionRelaxation:
number
Defined in: packages/sim/src/vehicle-classes.ts:99
Suspension relaxation damping.
suspensionRest
suspensionRest:
number
Defined in: packages/sim/src/vehicle-classes.ts:93
Suspension rest length (m).
suspensionStiffness
suspensionStiffness:
number
Defined in: packages/sim/src/vehicle-classes.ts:95
Suspension spring stiffness (per kg of chassis; Rapier multiplies by the mass).
track
track:
number
Defined in: packages/sim/src/vehicle-classes.ts:76
Half the distance between the left and right wheels (m).
trailer?
optionaltrailer?:TrailerDef
Defined in: packages/sim/src/vehicle-classes.ts:85
A trailer towed behind the chassis, if any.
trunk?
optionaltrunk?:number
Defined in: packages/sim/src/vehicle-classes.ts:83
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:81
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:89
Height of the wheel attachment relative to the chassis centre (m).
wheelBase
wheelBase:
number
Defined in: packages/sim/src/vehicle-classes.ts:72
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:91
Wheel radius (m).
wheelspinGrip
wheelspinGrip:
number
Defined in: packages/sim/src/vehicle-classes.ts:146
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.