VehicleWheel

Physics object that simulates the behavior of a wheel.

This node needs to be used as a child node of VehicleBody and simulates the behavior of one of its wheels. This node also acts as a collider to detect if the wheel is touching a surface. 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.

@GodotBaseClass

struct VehicleWheel {

enum string _GODOT_internal_name;

union __anonymous;

alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses);

package @nogc nothrow __gshared

bool _classBindingInitialized;

struct GDNativeClassBinding;

bool opEquals(VehicleWheel other);

typeof(null) opAssign(typeof(null) n);

bool opEquals(typeof(null) n);

size_t toHash();

mixin baseCasts ;

static VehicleWheel _new();

double getBrake();

double getDampingCompression();

double getDampingRelaxation();

double getEngineForce();

double getFrictionSlip();

double getRadius();

double getRollInfluence();

double getRpm();

double getSkidinfo();

double getSteering();

double getSuspensionMaxForce();

double getSuspensionRestLength();

double getSuspensionStiffness();

double getSuspensionTravel();

bool isInContact();

bool isUsedAsSteering();

bool isUsedAsTraction();

void setBrake(double brake);

void setDampingCompression(double length);

void setDampingRelaxation(double length);

void setEngineForce(double engine_force);

void setFrictionSlip(double length);

void setRadius(double length);

void setRollInfluence(double roll_influence);

void setSteering(double steering);

void setSuspensionMaxForce(double length);

void setSuspensionRestLength(double length);

void setSuspensionStiffness(double length);

void setSuspensionTravel(double length);

void setUseAsSteering(bool enable);

void setUseAsTraction(bool enable);

double brake [@property getter];

double brake [@property setter];

double dampingCompression [@property getter];

double dampingCompression [@property setter];

double dampingRelaxation [@property getter];

double dampingRelaxation [@property setter];

double engineForce [@property getter];

double engineForce [@property setter];

double steering [@property getter];

double steering [@property setter];

double suspensionMaxForce [@property getter];

double suspensionMaxForce [@property setter];

double suspensionStiffness [@property getter];

double suspensionStiffness [@property setter];

double suspensionTravel [@property getter];

double suspensionTravel [@property setter];

bool useAsSteering [@property getter];

bool useAsSteering [@property setter];

bool useAsTraction [@property getter];

bool useAsTraction [@property setter];

double wheelFrictionSlip [@property getter];

double wheelFrictionSlip [@property setter];

double wheelRadius [@property getter];

double wheelRadius [@property setter];

double wheelRestLength [@property getter];

double wheelRestLength [@property setter];

double wheelRollInfluence [@property getter];

double wheelRollInfluence [@property setter];

}

Members

Aliases

BaseClasses alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses): Undocumented in source.

Functions

getBrake double getBrake()
getDampingCompression double getDampingCompression()
getDampingRelaxation double getDampingRelaxation()
getEngineForce double getEngineForce()
getFrictionSlip double getFrictionSlip()
getRadius double getRadius()
getRollInfluence double getRollInfluence()
getRpm double getRpm(): Returns the rotational speed of the wheel in revolutions per minute.
getSkidinfo double getSkidinfo(): Returns a value between 0.0 and 1.0 that indicates whether this wheel is skidding. 0.0 is skidding (the wheel has lost grip, e.g. icy terrain), 1.0 means not skidding (the wheel has full grip, e.g. dry asphalt road).
getSteering double getSteering()
getSuspensionMaxForce double getSuspensionMaxForce()
getSuspensionRestLength double getSuspensionRestLength()
getSuspensionStiffness double getSuspensionStiffness()
getSuspensionTravel double getSuspensionTravel()
isInContact bool isInContact(): Returns true if this wheel is in contact with a surface.
isUsedAsSteering bool isUsedAsSteering()
isUsedAsTraction bool isUsedAsTraction()
opAssign typeof(null) opAssign(typeof(null) n)
opEquals bool opEquals(VehicleWheel other)
opEquals bool opEquals(typeof(null) n)
setBrake void setBrake(double brake)
setDampingCompression void setDampingCompression(double length)
setDampingRelaxation void setDampingRelaxation(double length)
setEngineForce void setEngineForce(double engine_force)
setFrictionSlip void setFrictionSlip(double length)
setRadius void setRadius(double length)
setRollInfluence void setRollInfluence(double roll_influence)
setSteering void setSteering(double steering)
setSuspensionMaxForce void setSuspensionMaxForce(double length)
setSuspensionRestLength void setSuspensionRestLength(double length)
setSuspensionStiffness void setSuspensionStiffness(double length)
setSuspensionTravel void setSuspensionTravel(double length)
setUseAsSteering void setUseAsSteering(bool enable)
setUseAsTraction void setUseAsTraction(bool enable)
toHash size_t toHash()

Mixins

__anonymous mixin baseCasts: Undocumented in source.

Properties

brake double brake [@property getter]
double brake [@property setter]: Slows down the wheel by applying a braking force. The wheel is only slowed down if it is 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.
dampingCompression double dampingCompression [@property getter]
double dampingCompression [@property setter]: The damping applied to the spring when the spring is being compressed. This value should be between 0.0 (no damping) and 1.0. A value of 0.0 means the car will keep bouncing as the spring keeps its energy. A good value for this is around 0.3 for a normal car, 0.5 for a race car.
dampingRelaxation double dampingRelaxation [@property getter]
double dampingRelaxation [@property setter]: The damping applied to the spring when relaxing. This value should be between 0.0 (no damping) and 1.0. This value should always be slightly higher than the dampingCompression property. For a dampingCompression value of 0.3, try a relaxation value of 0.5.
engineForce double engineForce [@property getter]
double engineForce [@property setter]: Accelerates the wheel by applying an engine force. The wheel is only speed up if it is 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 wheel reversing.
steering double steering [@property getter]
double steering [@property setter]: The steering angle for the wheel. Setting this to a non-zero value will result in the vehicle turning when it's moving.
suspensionMaxForce double suspensionMaxForce [@property getter]
double suspensionMaxForce [@property setter]: The maximum force the spring can resist. This value should be higher than a quarter of the RigidBody.mass of the VehicleBody or the spring will not carry the weight of the vehicle. Good results are often obtained by a value that is about 3× to 4× this number.
suspensionStiffness double suspensionStiffness [@property getter]
double suspensionStiffness [@property setter]: This value defines the stiffness of the suspension. Use a value lower than 50 for an off-road car, a value between 50 and 100 for a race car and try something around 200 for something like a Formula 1 car.
suspensionTravel double suspensionTravel [@property getter]
double suspensionTravel [@property setter]: This is the distance the suspension can travel. As Godot units are equivalent to meters, keep this setting relatively low. Try a value between 0.1 and 0.3 depending on the type of car.
useAsSteering bool useAsSteering [@property getter]
bool useAsSteering [@property setter]: If true, this wheel will be turned when the car steers. This value is used in conjunction with VehicleBody.steering and ignored if you are using the per-wheel steering value instead.
useAsTraction bool useAsTraction [@property getter]
bool useAsTraction [@property setter]: If true, this wheel transfers engine force to the ground to propel the vehicle forward. This value is used in conjunction with VehicleBody.engineForce and ignored if you are using the per-wheel engineForce value instead.
wheelFrictionSlip double wheelFrictionSlip [@property getter]
double wheelFrictionSlip [@property setter]: This determines how much grip this wheel has. It is combined with the friction setting of the surface the wheel is in contact with. 0.0 means no grip, 1.0 is normal grip. For a drift car setup, try setting the grip of the rear wheels slightly lower than the front wheels, or use a lower value to simulate tire wear. It's best to set this to 1.0 when starting out.
wheelRadius double wheelRadius [@property getter]
double wheelRadius [@property setter]: The radius of the wheel in meters.
wheelRestLength double wheelRestLength [@property getter]
double wheelRestLength [@property setter]: This is the distance in meters the wheel is lowered from its origin point. Don't set this to 0.0 and move the wheel into position, instead move the origin point of your wheel (the gizmo in Godot) to the position the wheel will take when bottoming out, then use the rest length to move the wheel down to the position it should be in when the car is in rest.
wheelRollInfluence double wheelRollInfluence [@property getter]
double wheelRollInfluence [@property setter]: This value affects the roll of your vehicle. If set to 1.0 for all wheels, your vehicle will be prone to rolling over, while a value of 0.0 will resist body roll.

Static functions

_new VehicleWheel _new(): Construct a new instance of VehicleWheel. Note: use memnew!VehicleWheel instead.

Static variables

_classBindingInitialized bool _classBindingInitialized;: Undocumented in source.

Structs

GDNativeClassBinding struct GDNativeClassBinding: Undocumented in source.

Unions

__anonymous union __anonymous: Undocumented in source.

Variables

_GODOT_internal_name enum string _GODOT_internal_name;: Undocumented in source.

Mixed In Members

From `mixin baseCasts`

as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(ToRef) as(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast template opCast(To): Undocumented in source.
opCast template opCast(To): Undocumented in source.
opCast template opCast(ToRef): Undocumented in source.
opCast void* opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast godot_object opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast bool opCast(): Undocumented in source. Be warned that the author may not have intended to support it.

Meta

Source

See Implementation

godot vehiclewheel structs

VehicleWheel