virtualx-engine/doc/classes/VehicleWheel.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="VehicleWheel" inherits="Spatial" category="Core" version="3.2">
	<brief_description>
		Physics object that simulates the behaviour of a wheel.
	</brief_description>
	<description>
		This node needs to be used as a child node of [VehicleBody] and simulates the behaviour of one of its wheels. This node also acts as a collider to detect if the wheel is touching a surface.
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="get_skidinfo" qualifiers="const">
			<return type="float">
			</return>
			<description>
				Returns a value between 0.0 and 1.0 that indicates whether this wheel is skidding. 0.0 is not skidding, 1.0 means the wheel has lost grip.
			</description>
		</method>
		<method name="is_in_contact" qualifiers="const">
			<return type="bool">
			</return>
			<description>
				Returns [code]true[/code] if this wheel is in contact with a surface.
			</description>
		</method>
	</methods>
	<members>
		<member name="damping_compression" type="float" setter="set_damping_compression" getter="get_damping_compression">
			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.
		</member>
		<member name="damping_relaxation" type="float" setter="set_damping_relaxation" getter="get_damping_relaxation">
			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 [member damping_compression] property. For a [member damping_compression] value of 0.3, try a relaxation value of 0.5
		</member>
		<member name="suspension_max_force" type="float" setter="set_suspension_max_force" getter="get_suspension_max_force">
			The maximum force the spring can resist. This value should be higher than a quarter of the [member 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 3x to 4x this number.
		</member>
		<member name="suspension_stiffness" type="float" setter="set_suspension_stiffness" getter="get_suspension_stiffness">
			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.
		</member>
		<member name="suspension_travel" type="float" setter="set_suspension_travel" getter="get_suspension_travel">
			This is the distance the suspension can travel. As Godot measures are in meters keep this setting relatively low. Try a value between 0.1 and 0.3 depending on the type of car .
		</member>
		<member name="use_as_steering" type="bool" setter="set_use_as_steering" getter="is_used_as_steering">
			If [code]true[/code] this wheel will be turned when the car steers.
		</member>
		<member name="use_as_traction" type="bool" setter="set_use_as_traction" getter="is_used_as_traction">
			If [code]true[/code] this wheel transfers engine force to the ground to propel the vehicle forward.
		</member>
		<member name="wheel_friction_slip" type="float" setter="set_friction_slip" getter="get_friction_slip">
			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.
		</member>
		<member name="wheel_radius" type="float" setter="set_radius" getter="get_radius">
			The radius of the wheel in meters.
		</member>
		<member name="wheel_rest_length" type="float" setter="set_suspension_rest_length" getter="get_suspension_rest_length">
			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.
		</member>
		<member name="wheel_roll_influence" type="float" setter="set_roll_influence" getter="get_roll_influence">
			This value effects the roll of your vehicle. If set to 0.0 for all wheels your vehicle will be prone to rolling over while a value of 1.0 will resist body roll.
		</member>
	</members>
	<constants>
	</constants>
</class>