Class VehicleWheel

Inheritance
Object
VehicleWheel
Inherited Members
Namespace: GTA
Assembly: ScriptHookVDotNet3.dll
Syntax
public sealed class VehicleWheel

Properties

| Improve this Doc View Source

BoneId

Gets the bone id this VehicleWheel.

Declaration
public VehicleWheelBoneId BoneId { get; }
Property Value
Type Description
VehicleWheelBoneId
| Improve this Doc View Source

Health

Gets or sets the wheel health.

Declaration
public float Health { get; set; }
Property Value
Type Description
Single
| Improve this Doc View Source

Index

Gets the index for native functions. Obsoleted in v3 API because there is no legiminate ways to get value from or modify any of the 4 wheels wheel_lm2, wheel_rm2, wheel_lm3, or wheel_lm3 in native functions.

Declaration
[Obsolete("VehicleWheel.Index does not support any of the wheels wheel_lm2, wheel_rm2, wheel_lm3, or wheel_lm3, but provided for legacy scripts compatibility in v3 API. Use VehicleWheel.BoneId instead.")]
public int Index { get; }
Property Value
Type Description
Int32
| Improve this Doc View Source

IsBursted

Sets a value indicating whether this VehicleWheel is bursted.

Declaration
public bool IsBursted { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsDrivingWheel

Gets or sets a value indicating whether this VehicleWheel is a driving wheel.

Declaration
public bool IsDrivingWheel { get; set; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsPunctured

Sets a value indicating whether this VehicleWheel is punctured.

Declaration
public bool IsPunctured { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsSteeringWheel

Gets or sets a value indicating whether this VehicleWheel is a steering wheel.

Declaration
public bool IsSteeringWheel { get; set; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsTireOnFire

Gets or sets a value indicating whether this VehicleWheel's tire is on fire.

Declaration
public bool IsTireOnFire { get; set; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsTouchingSurface

Gets a value indicating whether this VehicleWheel is touching any surface.

Declaration
public bool IsTouchingSurface { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

LastContactPosition

Gets the last contact position.

Declaration
public Vector3 LastContactPosition { get; }
Property Value
Type Description
Vector3
| Improve this Doc View Source

MemoryAddress

Gets the memory address where this VehicleWheel is stored in memory.

Declaration
public IntPtr MemoryAddress { get; }
Property Value
Type Description
IntPtr
| Improve this Doc View Source

SteeringLimitMultiplier

Gets or sets the limit multiplier that affects how much this VehicleWheel can turn.

Declaration
public float SteeringLimitMultiplier { get; set; }
Property Value
Type Description
Single
| Improve this Doc View Source

Temperature

Gets or sets the temperature of VehicleWheel. This value rises when Vehicle is drifting, braking, or in burnout. If this value is kept at 59f when Vehicle is on burnout for a short time, the tire will burst.

Declaration
public float Temperature { get; set; }
Property Value
Type Description
Single
| Improve this Doc View Source

TireHealth

Gets or sets the tire health. If WearMultiplier is set to exactly 0f, the value will default to 350f if the value is positive and less than 1000f.

Declaration
public float TireHealth { get; set; }
Property Value
Type Description
Single
| Improve this Doc View Source

Vehicle

Gets the Vehiclethis VehicleWheel belongs to.

Declaration
public Vehicle Vehicle { get; }
Property Value
Type Description
Vehicle
| Improve this Doc View Source

WearMultiplier

Gets or sets the value indicating how fast the tires will wear out. The higher this value is, the greater downforce will be created.

Only supported in v1.0.1868.0 and later versions. Will throw GameVersionNotSupportedException if the setter is called in earlier versions (the getter always returns false in earlier versions).

Declaration
public float WearMultiplier { get; set; }
Property Value
Type Description
Single
Exceptions
Type Condition
GameVersionNotSupportedException

Methods

| Improve this Doc View Source

Burst()

Bursts this VehicleWheel's tire completely.

Declaration
public void Burst()
| Improve this Doc View Source

Fix()

Fixes this VehicleWheel's tire.

Declaration
public void Fix()
| Improve this Doc View Source

Fix(Boolean)

Fixes this VehicleWheel's tire.

Declaration
public void Fix(bool leaveOtherBurstedTiresNotShowing)
Parameters
Type Name Description
Boolean leaveOtherBurstedTiresNotShowing

If set to false, bursted tires will appear again just like SET_VEHICLE_TYRE_FIXED does.
| Improve this Doc View Source

Puncture(Single)

Punctures this VehicleWheel's tire.

Declaration
public void Puncture(float damage = 1000F)
Parameters
Type Name Description
Single damage

How much damage this VehicleWheel will take.