VehicleBody

Inherits: RigidBody < PhysicsBody < CollisionObject < Spatial < Node < Object

Physics body that simulates the behavior of a car.

Description

This node implements all the physics logic needed to simulate a car. It is based on the raycast vehicle system commonly found in physics engines. You will need to add a CollisionShape for the main body of your vehicle and add VehicleWheel nodes for the wheels. You should also add a MeshInstance to this node for the 3D model of your car but this model should not include meshes for the wheels. You should control the vehicle by using the brake, engine_force, and steering properties and not change the position or orientation of this node directly.

Note: The origin point of your VehicleBody will determine the center of gravity of your vehicle so it is better to keep this low and move the CollisionShape and MeshInstance upwards.

Note: This class has known issues and isn't designed to provide realistic 3D vehicle physics. If you want advanced vehicle physics, you will probably have to write your own physics integration using another PhysicsBody class.

Warning: With a non-uniform scale this node will probably not function as expected. Please make sure to keep its scale uniform (i.e. the same on all axes), and change the size(s) of its collision shape(s) instead.

Tutorials

Properties

float

brake

0.0

float

engine_force

0.0

float

mass

40.0 (overrides RigidBody)

float

steering

0.0

float

weight

392.0 (overrides RigidBody)

Property Descriptions

float brake = 0.0

  • void set_brake ( float value )

  • float get_brake ( )

Slows down the vehicle by applying a braking force. The vehicle is only slowed down if the wheels are in contact with a surface. The force you need to apply to adequately slow down your vehicle depends on the RigidBody.mass of the vehicle. For a vehicle with a mass set to 1000, try a value in the 25 - 30 range for hard braking.

float engine_force = 0.0

  • void set_engine_force ( float value )

  • float get_engine_force ( )

Accelerates the vehicle by applying an engine force. The vehicle is only sped up if the wheels that have VehicleWheel.use_as_traction set to true and are in contact with a surface. The RigidBody.mass of the vehicle has an effect on the acceleration of the vehicle. For a vehicle with a mass set to 1000, try a value in the 25 - 50 range for acceleration.

Note: The simulation does not take the effect of gears into account, you will need to add logic for this if you wish to simulate gears.

A negative value will result in the vehicle reversing.

float steering = 0.0

  • void set_steering ( float value )

  • float get_steering ( )

The steering angle for the vehicle. Setting this to a non-zero value will result in the vehicle turning when it's moving. Wheels that have VehicleWheel.use_as_steering set to true will automatically be rotated.