Skip to content

eulerjs API / @eulerjs/vehicle / RaycastVehicleOptions

RaycastVehicleOptions ​

Defined in: packages/vehicle/src/RaycastVehicle.ts:133

Properties ​

PropertyTypeDescriptionDefined in
forward?Vector3-packages/vehicle/src/RaycastVehicle.ts:137
sidewaysResponse?numberThe share of a wheel's sideways slip its tyre takes out each step, grip allowing. All of it at once would overshoot, the other wheels pulling the same way. Defaults to 0.5.packages/vehicle/src/RaycastVehicle.ts:142
surface?(point, hit) => GroundSurface | undefinedWhat the ground is like where a wheel touches it, at point in world space: its grip and how it drags, for a track whose kerbs, grass and gravel are one collider, or any ground whose grip varies. Asked for every wheel on the ground, every step. Without it, the ground is the same everywhere.packages/vehicle/src/RaycastVehicle.ts:158
tyres?"grip" | "slip"How the tyres grip. 'grip', the default: each takes out a share of its slip, up to its grip times its load, and its wheel turns as the ground goes by; give it driveForce and brakeForce. 'slip': each wheel spins as a body of its own, given driveTorque and brakeTorque, and its tyre pulls with how much it slips, along and across, harder up to a peak and less past it, so that it spins up, locks and slides as a tyre does, and grips less for each newton the more it is loaded. For a racing car.packages/vehicle/src/RaycastVehicle.ts:151
up?Vector3The body's up and forward axes, in its own frame. Default +y and +z.packages/vehicle/src/RaycastVehicle.ts:136
wheelsreadonly WheelOptions[]-packages/vehicle/src/RaycastVehicle.ts:134

Released under the MIT License.