Class Vehicle

Inheritance
Object
PoolObject
Entity
Vehicle
Inherited Members
Namespace: GTA
Assembly: ScriptHookVDotNet3.dll
Syntax
public sealed class Vehicle : Entity, INativeValue, IDeletable, IExistable, ISpatial

Properties

| Improve this Doc View Source

Acceleration

Gets the acceleration of this Vehicle.

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

AlarmTimeLeft

Gets or sets time left before this Vehicle alarm stops. If greater than zero, the vehicle alarm will be sounding. the value is up to 65534.

Declaration
public int AlarmTimeLeft { get; set; }
Property Value
Type Description
Int32

The time left before this Vehicle alarm stops.
| Improve this Doc View Source

AllowRappel

Gets a value indicating whether this Vehicle allows Peds to rappel.

Declaration
public bool AllowRappel { get; }
Property Value
Type Description
Boolean

true if this Vehicle allows Peds to rappel; otherwise, false.
| Improve this Doc View Source

AreBrakeLightsOn

Gets or sets a value indicating whether this Vehicle has its brake light on.

Declaration
public bool AreBrakeLightsOn { set; }
Property Value
Type Description
Boolean

true if this Vehicle has its brake light on; otherwise, false.
| Improve this Doc View Source

AreHighBeamsOn

Gets or sets a value indicating whether this Vehicle has its high beams on.

Declaration
public bool AreHighBeamsOn { get; set; }
Property Value
Type Description
Boolean

true if this Vehicle has its high beams on; otherwise, false.
| Improve this Doc View Source

AreLightsOn

Gets or sets a value indicating whether this Vehicle has its lights on.

Declaration
public bool AreLightsOn { get; set; }
Property Value
Type Description
Boolean

true if this Vehicle has its lights on; otherwise, false.
| Improve this Doc View Source

BodyHealth

Gets or sets this Vehicles body health.

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

BrakePower

Gets or sets the current brake power of this Vehicle.

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

CanBeVisiblyDamaged

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

CanEngineDegrade

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

CanJump

Gets a value indicating whether this Vehicle can jump.

Declaration
public bool CanJump { get; }
Property Value
Type Description
Boolean

true if this Vehicle can jump; otherwise, false.
| Improve this Doc View Source

CanPretendOccupants

Gets or sets a value indicating whether this Vehicle can pretend it has the same Peds. Set to false to prevent this Vehicle from creating new Peds as its occupants.

Declaration
public bool CanPretendOccupants { get; set; }
Property Value
Type Description
Boolean
Remarks

Vehicles do not pretend occupants regardless of this value if PopulationType is set to Permanent or Mission.

| Improve this Doc View Source

CanStandOnTop

Gets a value indicating whether Peds can stand on this Vehicle regardless of Vehicles speed.

Declaration
public bool CanStandOnTop { get; }
Property Value
Type Description
Boolean

true if Peds can stand on this Vehicle regardless of Vehicles speed; otherwise, false.
| Improve this Doc View Source

CanTiresBurst

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

CanWheelsBreak

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

ClassDisplayName

Gets the display name of this Vehicles VehicleClass. Use GetLocalizedString(String) to get the localized class name.

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

ClassLocalizedName

Gets the localized name of this Vehicles VehicleClass.

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

ClassType

Gets the class of this Vehicle.

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

Clutch

Gets or sets the current clutch of this Vehicle.

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

CurrentGear

Gets or sets the current gear this Vehicle is using.

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

CurrentRPM

Gets or sets the current RPM of this Vehicle.

Declaration
public float CurrentRPM { get; set; }
Property Value
Type Description
Single

The current RPM between 0.0f and 1.0f.
| Improve this Doc View Source

DirtLevel

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

DisplayName

Gets the display name of this Vehicle. Use GetLocalizedString(String) to get the localized name.

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

Doors

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

Driver

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

DropsMoneyOnExplosion

Gets or sets a value indicating whether this Vehicle drops money when destroyed. Only works when the vehicle model is a car, quad bikes or trikes (strictly when the internal vehicle class is CAutomobile or derived class from CAutomobile).

Declaration
public bool DropsMoneyOnExplosion { get; set; }
Property Value
Type Description
Boolean

true if this Vehicle drops money when destroyed; otherwise, false.
| Improve this Doc View Source

EngineHealth

Gets or sets this Vehicle engine health.

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

EnginePowerMultiplier

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

EngineTemperature

Gets the engine temperature of this Vehicle.

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

EngineTorqueMultiplier

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

ForwardSpeed

Sets this Vehicles forward speed.

Declaration
public float ForwardSpeed { set; }
Property Value
Type Description
Single

The forward speed in m/s.
| Improve this Doc View Source

FuelLevel

Gets or sets this Vehicle fuel level.

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

Gears

Gets or sets the gears value of this Vehicle.

Declaration
[Obsolete("Vehicle.Gears is obsolete, please use Vehicle.HighGear for the high gear value and Vehicle.CurrentGear for the current gear value instead.")]
public int Gears { get; set; }
Property Value
Type Description
Int32
| Improve this Doc View Source

HandlingData

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

HasBombBay

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

HasBulletProofGlass

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

HasDonkHydraulics

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

HasForks

Gets a value indicating whether this Vehicle has forks.

Declaration
public bool HasForks { get; }
Property Value
Type Description
Boolean

true if this Vehicle has forks; otherwise, false.
| Improve this Doc View Source

HasLowriderHydraulics

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

HasParachute

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

HasRocketBoost

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

HasRoof

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

HasSiren

Gets a value indicating whether this Vehicle has a siren.

Declaration
public bool HasSiren { get; }
Property Value
Type Description
Boolean

true if this Vehicle has a siren; otherwise, false.
| Improve this Doc View Source

HasTowArm

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

HeliBladesSpeed

Gets or sets the blades speed for this heli.

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

HeliEngineHealth

Gets or sets the engine health for this heli.

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

HeliMainRotorHealth

Gets or sets the main rotor health for this heli.

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

HeliTailRotorHealth

Gets or sets the tail rotor health for this heli.

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

HighGear

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

IsAircraft

Gets a value indicating whether this Vehicle is an aircraft.

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

IsAlarmSet

Sets a value indicating whether this Vehicle has an alarm set.

Declaration
public bool IsAlarmSet { get; set; }
Property Value
Type Description
Boolean

true if this Vehicle has an alarm set; otherwise, false.
| Improve this Doc View Source

IsAlarmSounding

Gets a value indicating whether this Vehicle is sounding its alarm.

Declaration
public bool IsAlarmSounding { get; }
Property Value
Type Description
Boolean

true if this Vehicle is sounding its alarm; otherwise, false.
| Improve this Doc View Source

IsAmphibious

Gets a value indicating whether this Vehicle is an amphibious vehicle.

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

IsAmphibiousAutomobile

Gets a value indicating whether this Vehicle is an amphibious automobile.

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

IsAmphibiousQuadBike

Gets a value indicating whether this Vehicle is an amphibious quad bike.

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

IsAutomobile

Gets a value indicating whether this Vehicle is an automobile.

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

IsAxlesStrong

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

IsBicycle

Gets a value indicating whether this Vehicle is a bicycle.

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

IsBig

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

IsBike

Gets a value indicating whether this Vehicle is a bike.

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

IsBlimp

Gets a value indicating whether this Vehicle is a helicopter.

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

IsBoat

Gets a value indicating whether this Vehicle is a boat.

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

IsBurnoutForced

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

IsConsideredDestroyed

Gets or sets a value indicating whether this Vehicle is considered destroyed. Will be set to true when Vehicles are exploded or sinking for a short time.

IsDead will return true and IsDriveable will return false if this value is set to true. Does not affect if this Vehicle will rendered scorched.

Declaration
public bool IsConsideredDestroyed { get; set; }
Property Value
Type Description
Boolean
Remarks

Many features of Vehicle will be disabled when this value is set to true. For example, Peds cannot enter Vehicles considered destroyed or start the engines of them. Peds cannot use weapons of them. The player cannot unflip Vehicles considered destroyed.

| Improve this Doc View Source

IsConvertible

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

IsDamaged

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

IsDriveable

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

IsEngineRunning

Gets or sets a value indicating whether this Vehicles engine is running.

Declaration
public bool IsEngineRunning { get; set; }
Property Value
Type Description
Boolean

true if this Vehicles engine is running; otherwise, false.
| Improve this Doc View Source

IsEngineStarting

Gets or sets a value indicating whether this Vehicles engine is currently starting.

Declaration
public bool IsEngineStarting { get; }
Property Value
Type Description
Boolean

true if this Vehicles engine is starting; otherwise, false.
| Improve this Doc View Source

IsFrontBumperBrokenOff

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

IsHandbrakeForcedOn

Sets a value indicating whether the Handbrake on this Vehicle is forced on.

Declaration
public bool IsHandbrakeForcedOn { set; }
Property Value
Type Description
Boolean

true if the Handbrake on this Vehicle is forced on; otherwise, false.
| Improve this Doc View Source

IsHelicopter

Gets a value indicating whether this Vehicle is a helicopter.

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

IsInBurnout

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

IsInteriorLightOn

Gets or sets a value indicating whether this Vehicle has its interior lights on.

Declaration
public bool IsInteriorLightOn { get; set; }
Property Value
Type Description
Boolean

true if this Vehicle has its interior lights on; otherwise, false.
| Improve this Doc View Source

IsLeftHeadLightBroken

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

IsLeftIndicatorLightOn

Gets or sets a value indicating whether this Vehicle has its left indicator light on.

Declaration
public bool IsLeftIndicatorLightOn { set; }
Property Value
Type Description
Boolean

true if this Vehicle has its left indicator light on; otherwise, false.
| Improve this Doc View Source

IsMotorcycle

Gets a value indicating whether this Vehicle is a motorcycle.

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

IsOnAllWheels

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

IsPlane

Gets a value indicating whether this Vehicle is a plane.

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

IsQuadBike

Gets a value indicating whether this Vehicle is a quad bike.

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

IsRadioEnabled

Turns this Vehicles radio on or off

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

IsRearBumperBrokenOff

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

IsRegularAutomobile

Gets a value indicating whether this Vehicle is a regular automobile.

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

IsRegularQuadBike

Gets a value indicating whether this Vehicle is a regular quad bike.

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

IsRightHeadLightBroken

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

IsRightIndicatorLightOn

Gets or sets a value indicating whether this Vehicle has its right indicator light on.

Declaration
public bool IsRightIndicatorLightOn { set; }
Property Value
Type Description
Boolean

true if this Vehicle has its right indicator light on; otherwise, false.
| Improve this Doc View Source

IsSearchLightOn

Gets or sets a value indicating whether this Vehicle has its search light on.

Declaration
public bool IsSearchLightOn { get; set; }
Property Value
Type Description
Boolean

true if this Vehicle has its search light on; otherwise, false.
| Improve this Doc View Source

IsSirenActive

Gets or sets a value indicating whether this Vehicle has its siren turned on.

Declaration
public bool IsSirenActive { get; set; }
Property Value
Type Description
Boolean

true if this Vehicle has its siren turned on; otherwise, false.
| Improve this Doc View Source

IsSirenSilent

Sets a value indicating whether the siren on this Vehicle plays sounds.

Declaration
public bool IsSirenSilent { set; }
Property Value
Type Description
Boolean

true if the siren on this Vehicle plays sounds; otherwise, false.
| Improve this Doc View Source

IsStolen

Gets or sets a value indicating whether this Vehicle was stolen.

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

IsStopped

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

IsStoppedAtTrafficLights

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

IsSubmarine

Gets a value indicating whether this Vehicle is a submarine.

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

IsSubmarineCar

Gets a value indicating whether this Vehicle is a submarine car.

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

IsTaxiLightOn

Gets or sets a value indicating whether this Vehicle has its taxi light on.

Declaration
public bool IsTaxiLightOn { get; set; }
Property Value
Type Description
Boolean

true if this Vehicle has its taxi light on; otherwise, false.
| Improve this Doc View Source

IsTrailer

Gets a value indicating whether this Vehicle is a trailer.

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

IsTrain

Gets a value indicating whether this Vehicle is a train.

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

IsWanted

Gets or sets a value indicating whether this Vehicle is wanted by the police.

Declaration
public bool IsWanted { get; set; }
Property Value
Type Description
Boolean

true if this Vehicle is wanted by the police; otherwise, false.
| Improve this Doc View Source

LandingGearState

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

LightsMultiplier

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

LocalizedName

Gets the localized name of this Vehicle

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

LockStatus

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

LodMultiplier

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

MaxBraking

Gets the maximum brake power of this Vehicle.

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

MaxTraction

Gets the maximum traction of this Vehicle.

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

Mods

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

NeedsToBeHotwired

Gets or sets a value indicating whether this Vehicle needs to be hotwired to start.

Declaration
public bool NeedsToBeHotwired { get; set; }
Property Value
Type Description
Boolean

true if this Vehicle needs to be hotwired to start; otherwise, false.
| Improve this Doc View Source

NextGear

Gets or sets the next gear value of this Vehicle.

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

Occupants

Declaration
public Ped[] Occupants { get; }
Property Value
Type Description
Ped[]
| Improve this Doc View Source

OilLevel

Gets or sets this Vehicle oil level. If this value is above zero, this value decreases instead of EngineHealth when the engine emits black smoke.

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

OilVolume

Gets the oil volume of this Vehicle.

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

PassengerCapacity

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

PassengerCount

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

Passengers

Declaration
public Ped[] Passengers { get; }
Property Value
Type Description
Ped[]
| Improve this Doc View Source

PetrolTankHealth

Gets or sets this Vehicle petrol tank health.

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

PetrolTankVolume

Gets the petrol tank volume of this Vehicle.

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

PreviouslyOwnedByPlayer

Gets or sets a value indicating whether this Vehicle was previously owned by a Player.

Declaration
public bool PreviouslyOwnedByPlayer { get; set; }
Property Value
Type Description
Boolean

true if this Vehicle was previously owned by a Player; otherwise, false.
| Improve this Doc View Source

ProvidesCover

Gets or sets a value indicating whether peds can use this Vehicle for cover.

Declaration
public bool ProvidesCover { get; set; }
Property Value
Type Description
Boolean

true if peds can use this Vehicle for cover; otherwise, false.
| Improve this Doc View Source

RadioStation

Sets this Vehicles radio station.

Declaration
public RadioStation RadioStation { set; }
Property Value
Type Description
RadioStation
| Improve this Doc View Source

RoofState

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

SteeringAngle

Gets or sets the steering angle of this Vehicle.

Declaration
public float SteeringAngle { get; set; }
Property Value
Type Description
Single

The steering angle in degrees.
| Improve this Doc View Source

SteeringScale

Gets or sets the steering scale of this Vehicle.

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

Throttle

Gets or sets the current throttle of this Vehicle.

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

ThrottlePower

Gets or sets the current throttle power of this Vehicle.

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

TowArmPosition

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

TowedVehicle

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

Turbo

Gets or sets the current turbo value of this Vehicle.

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

Type

Gets the type of this Vehicle.

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

Wheels

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

WheelSpeed

Gets the speed the drive wheels are turning at, This is the value used for the dashboard speedometers(after being converted to mph).

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

Windows

Declaration
public VehicleWindowCollection Windows { get; }
Property Value
Type Description
VehicleWindowCollection

Methods

| Improve this Doc View Source

ApplyDamage(Vector3, Single, Single)

Declaration
public void ApplyDamage(Vector3 position, float damageAmount, float radius)
Parameters
Type Name Description
Vector3 position
Single damageAmount
Single radius
| Improve this Doc View Source

CargoBobMagnetGrabVehicle()

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

CargoBobMagnetReleaseVehicle()

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

CloseBombBay()

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

CreatePedOnSeat(VehicleSeat, Model)

Declaration
public Ped CreatePedOnSeat(VehicleSeat seat, Model model)
Parameters
Type Name Description
VehicleSeat seat
Model model
Returns
Type Description
Ped
| Improve this Doc View Source

CreateRandomPedOnSeat(VehicleSeat)

Declaration
public Ped CreateRandomPedOnSeat(VehicleSeat seat)
Parameters
Type Name Description
VehicleSeat seat
Returns
Type Description
Ped
| Improve this Doc View Source

DetachFromTowTruck()

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

DetachTowedVehicle()

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

DropCargobobHook(CargobobHook)

Declaration
public void DropCargobobHook(CargobobHook hook)
Parameters
Type Name Description
CargobobHook hook
| Improve this Doc View Source

Exists()

Determines if this Vehicle exists. You should ensure Vehicles still exist before manipulating them or getting some values for them on every tick, since some native functions may crash the game if invalid entity handles are passed.

Declaration
public bool Exists()
Returns
Type Description
Boolean

true if this Vehicle exists; otherwise, false
| Improve this Doc View Source

Explode()

Explode this Vehicle instantaneously.

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

ExtraExists(Int32)

Declaration
public bool ExtraExists(int extra)
Parameters
Type Name Description
Int32 extra
Returns
Type Description
Boolean
| Improve this Doc View Source

GetAllLoadedModelsAppropriateForAmbientVehicles()

Gets an array of all loaded VehicleHashs that is appropriate to spawn as ambient vehicles. All the model hashes of the elements are loaded and the Vehicles with the model hashes can be spawned immediately.

Declaration
public static VehicleHash[] GetAllLoadedModelsAppropriateForAmbientVehicles()
Returns
Type Description
VehicleHash[]
| Improve this Doc View Source

GetAllModels()

Declaration
public static VehicleHash[] GetAllModels()
Returns
Type Description
VehicleHash[]
| Improve this Doc View Source

GetAllModelsOfClass(VehicleClass)

Declaration
public static VehicleHash[] GetAllModelsOfClass(VehicleClass vehicleClass)
Parameters
Type Name Description
VehicleClass vehicleClass
Returns
Type Description
VehicleHash[]
| Improve this Doc View Source

GetAllModelsOfType(VehicleType)

Declaration
public static VehicleHash[] GetAllModelsOfType(VehicleType vehicleType)
Parameters
Type Name Description
VehicleType vehicleType
Returns
Type Description
VehicleHash[]
| Improve this Doc View Source

GetAllModelValues()

Declaration
public static int[] GetAllModelValues()
Returns
Type Description
Int32[]
| Improve this Doc View Source

GetClassDisplayName(VehicleClass)

Declaration
public static string GetClassDisplayName(VehicleClass vehicleClass)
Parameters
Type Name Description
VehicleClass vehicleClass
Returns
Type Description
String
| Improve this Doc View Source

GetModelClass(Model)

Declaration
public static VehicleClass GetModelClass(Model vehicleModel)
Parameters
Type Name Description
Model vehicleModel
Returns
Type Description
VehicleClass
| Improve this Doc View Source

GetModelDisplayName(Model)

Declaration
public static string GetModelDisplayName(Model vehicleModel)
Parameters
Type Name Description
Model vehicleModel
Returns
Type Description
String
| Improve this Doc View Source

GetModelMakeName(Model)

Declaration
public static string GetModelMakeName(Model vehicleModel)
Parameters
Type Name Description
Model vehicleModel
Returns
Type Description
String
| Improve this Doc View Source

GetModelType(Model)

Declaration
public static VehicleType GetModelType(Model vehicleModel)
Parameters
Type Name Description
Model vehicleModel
Returns
Type Description
VehicleType
| Improve this Doc View Source

GetPedOnSeat(VehicleSeat)

Declaration
public Ped GetPedOnSeat(VehicleSeat seat)
Parameters
Type Name Description
VehicleSeat seat
Returns
Type Description
Ped
| Improve this Doc View Source

IsCargobobHookActive()

Declaration
public bool IsCargobobHookActive()
Returns
Type Description
Boolean
| Improve this Doc View Source

IsCargobobHookActive(CargobobHook)

Declaration
public bool IsCargobobHookActive(CargobobHook hook)
Parameters
Type Name Description
CargobobHook hook
Returns
Type Description
Boolean
| Improve this Doc View Source

IsExtraOn(Int32)

Declaration
public bool IsExtraOn(int extra)
Parameters
Type Name Description
Int32 extra
Returns
Type Description
Boolean
| Improve this Doc View Source

IsSeatFree(VehicleSeat)

Declaration
public bool IsSeatFree(VehicleSeat seat)
Parameters
Type Name Description
VehicleSeat seat
Returns
Type Description
Boolean
| Improve this Doc View Source

OpenBombBay()

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

PlaceOnGround()

Declaration
public bool PlaceOnGround()
Returns
Type Description
Boolean
| Improve this Doc View Source

PlaceOnNextStreet()

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

Repair()

Repair all damage to this Vehicle instantaneously.

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

RetractCargobobHook()

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

SetHeliYawPitchRollMult(Single)

Declaration
public void SetHeliYawPitchRollMult(float mult)
Parameters
Type Name Description
Single mult
| Improve this Doc View Source

SoundHorn(Int32)

Sounds the horn on this Vehicle.

Declaration
public void SoundHorn(int duration)
Parameters
Type Name Description
Int32 duration

The duration in milliseconds to sound the horn for.
| Improve this Doc View Source

StartAlarm()

Starts sounding the alarm on this Vehicle.

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

ToggleExtra(Int32, Boolean)

Declaration
public void ToggleExtra(int extra, bool toggle)
Parameters
Type Name Description
Int32 extra
Boolean toggle
| Improve this Doc View Source

TowVehicle(Vehicle, Boolean)

Declaration
public void TowVehicle(Vehicle vehicle, bool rear)
Parameters
Type Name Description
Vehicle vehicle
Boolean rear
| Improve this Doc View Source

Wash()

Declaration
public void Wash()

Implements