Class VehicleWheelCollection

Inheritance
Object
VehicleWheelCollection
Inherited Members
Namespace: GTA
Assembly: ScriptHookVDotNet3.dll
Syntax
public sealed class VehicleWheelCollection : IEnumerable<VehicleWheel>, IEnumerable

Properties

| Improve this Doc View Source

Count

Gets the number of VehicleWheel this VehicleWheelCollection has. 0 will be returned if the owner vehicle does not exist.

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

Item[VehicleWheelBoneId]

Declaration
public VehicleWheel this[VehicleWheelBoneId boneId] { get; }
Parameters
Type Name Description
VehicleWheelBoneId boneId
Property Value
Type Description
VehicleWheel
| Improve this Doc View Source

Item[Int32]

Declaration
[Obsolete("VehicleWheel indexer overload with int 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 indexer overload with VehicleWheelBoneId enum instead.")]
public VehicleWheel this[int index] { get; }
Parameters
Type Name Description
Int32 index
Property Value
Type Description
VehicleWheel
| Improve this Doc View Source

Vehicle

Gets the Vehiclethis VehicleWheelCollection belongs to.

Declaration
public Vehicle Vehicle { get; }
Property Value
Type Description
Vehicle

Methods

| Improve this Doc View Source

GetAllWheels()

Gets an array of all VehicleWheels this VehicleWheelCollection has.

Declaration
public VehicleWheel[] GetAllWheels()
Returns
Type Description
VehicleWheel[]
| Improve this Doc View Source

GetEnumerator()

Declaration
public IEnumerator<VehicleWheel> GetEnumerator()
Returns
Type Description
IEnumerator<VehicleWheel>
| Improve this Doc View Source

GetWheelByIndexOfCollection(Int32)

Gets the VehicleWheel by index.

Declaration
public VehicleWheel GetWheelByIndexOfCollection(int index)
Parameters
Type Name Description
Int32 index

The index of the wheel collection. The order is the same as how the wheel array of the owner Vehicle is aligned.
Returns
Type Description
VehicleWheel
Exceptions
Type Condition
ArgumentOutOfRangeException

Explicit Interface Implementations

| Improve this Doc View Source

IEnumerable.GetEnumerator()

Declaration
IEnumerator IEnumerable.GetEnumerator()
Returns
Type Description
IEnumerator

Implements