Vehicle Properties

RAGE Plugin Hook Documentation

[This is preliminary documentation and is subject to change.]

The Vehicle type exposes the following members.

Properties

  NameDescription
Public propertyAbovePosition
Gets a position directly above this Entity.
(Inherited from Entity.)
Public propertyAccelerationScale
Gets the acceleration scale.
Public propertyAlarmTimeLeft

Gets or sets time left before the vehicle alarm stops.

If greater than zero, the vehicle alarm will be sounding.

Public propertyAngularVelocity
Gets or sets the rotational velocity of this entity.
(Inherited from Entity.)
Public propertyBelowPosition
Gets a position directly below this Entity.
(Inherited from Entity.)
Public propertyCanBeDamaged
Gets or sets a value indicating whether this entity can be damaged.
(Inherited from Entity.)
Public propertyCanTiresBurst
Gets or sets a value indicating whether the tired of this vehicle can be burst.
Public propertyClass
Public propertyCollisionIgnoredEntity
Gets or sets the Entity this entity currently ignores collisions from.
(Inherited from Entity.)
Public propertyConvertibleRoofState
Public propertyCreatedByTheCallingPlugin
Gets a value indicating whether this instance was created by the calling plugin.
(Inherited from Entity.)
Public propertyCurrentGear
Gets the current gear of this vehicle.
Public propertyDefaultEmergencyLighting
Gets the default emergency lighting settings for this type of vehicle.
Public propertyDesiredVerticalFlightPhase

Gets or sets the desired vertical flight phase. This adjusts the thruster angle on VTOL enabled planes.

VerticalFlightPhase will be interpolated towards the desired value.

Public propertyDirection
Gets or sets the direction of this instance.
(Inherited from Entity.)
Public propertyDirtLevel
Gets or sets the dirt level of this vehicle.
Public propertyDoors
Gets the doors of this vehicle.
Public propertyDriveForce
Gets or sets the drive force of this vehicle.
Public propertyDriver
Gets the Ped on the driver's seat of this vehicle.
Public propertyEmergencyLighting
Gets the emergency lighting settings currently assigned to this vehicle.
Public propertyEmergencyLightingOverride
Gets or sets the overriden emergency lighting settings for this vehicle.
Public propertyEngineHealth

Gets or sets the health of the car's engine.

The engine health ranges between 0.0f and 1000.0f.

When the engine health is below 400.0f, the engine will start to smoke.

When the engine health is 300.0f or below, the car's back fire will become smokey and sound worse.

When the engine health is below 300.0f, the car will have difficulties maintaining a stable acceleration.

When the engine health reaches 0.0f, the car's engine will die.

Public propertyEngineRevolutionsRatio
Gets the current engine revolutions ratio.
Public propertyForwardVector
Gets the forward vector of this instance.
(Inherited from Entity.)
Public propertyFreePassengerSeatsCount

Gets the number of free passenger seats in this vehicle.

Does not include the driver's seat.

Public propertyFreeSeatsCount

Gets the number of free seats in this vehicle.

Includes the driver's seat.

Public propertyFrontPosition
Gets a position directly in front of this Entity.
(Inherited from Entity.)
Public propertyFuelLevel

Gets or sets the amount of fuel in this vehicle.

Public propertyFuelTankHealth

Gets or sets the health of the car's fuel tank.

The fuel tank health ranges between 0.0f and 1000.0f.

When the fuel tank health is below 700.0f, fuel will start leaking.

When the fuel tank health is below 50.0f, the engine will be unable to start.

Public propertyHandle
Gets the handle of this instance. Used to identify the instance within its pool.
(Inherited from Entity.)
Public propertyHandlingData

Gets or sets the handling data associated with this vehicle.

Note, that this is a reference to the global handling data for this type of vehicle, and changing it, will change the handling data of all vehicles of this type.

Public propertyHasBeenDamagedByAnyObject
Gets or sets a value indicating whether this entity has been damaged by any Object.
(Inherited from Entity.)
Public propertyHasBeenDamagedByAnyPed
Gets or sets a value indicating whether this entity has been damaged by any Ped.
(Inherited from Entity.)
Public propertyHasBeenDamagedByAnyVehicle
Gets or sets a value indicating whether this entity has been damaged by any Vehicle.
(Inherited from Entity.)
Public propertyHasBeenDisabledByWater
Gets or sets whether this vehicle has been disabled by water. If this flag is set, the vehicle can't drive and the player can't enter it. When this flag has been set manually, it is reset when exiting the vehicle, so it should be set when not in the vehicle.
Public propertyHasBombBay
Gets a value indicating whether this vehicle has a bomb bay.
Public propertyHasDiggerArm
Gets a value indicating whether this vehicle has a digger arm.
Public propertyHasDriver
Gets a value indicating whether this vehicle has a driver.
Public propertyHasForks
Gets a value indicating whether this vehicle has forks.
Public propertyHasOccupants

Gets a value indicating whether this vehicle has one or more occupants.

Includes the driver.

Public propertyHasPassengers

Gets a value indicating whether this vehicle has one or more passengers.

Does not include the driver.

Public propertyHasRoof

Gets a value indicating whether this vehicle has a roof.

Returns true for convertibles, even when their roof is down.

Public propertyHasSiren
Gets a value indicating whether this vehicle has a siren.
Public propertyHasTowArm
Gets a value indicating whether this vehicle has a tow arm.
Public propertyHasTracks
Gets a value indicating whether this vehicle has tracks.
Public propertyHasTrailer
Gets a value indicating whether this vehicle has a trailer attached.
Public propertyHasTrailerHitch
Gets a value indicating whether this vehicle has a trailer hitch.
Public propertyHeading
Gets or sets the heading of this instance in degrees.
(Inherited from Entity.)
Public propertyHealth
Gets or sets the health of this instance.
(Inherited from Entity.)
Public propertyHeight
Gets the height of this Entity.
(Inherited from Entity.)
Public propertyHeightAboveGround

Gets this entity's distance from the ground in 1D on the Z-axis.

The distance is measured from the entity's origin to the surface below the entity (Surfaces include roofs of buildings).

(Inherited from Entity.)
Public propertyIndicatorLightsStatus
Sets the status of the indicator lights on this vehicle.
Public propertyInvincible Obsolete.
Sets a value indicating whether this instance is invincible.
(Inherited from Entity.)
Public propertyIsAlarmSounding
Gets a value indicating whether this vehicle's alarm is sounding.
Public propertyIsAlive
Gets a value indicating whether this instance is alive.
(Inherited from Entity.)
Public propertyIsAmphibious
Gets a value indicating whether this vehicle is amphibious.
Public propertyIsAmphibiousCar
Gets a value indicating whether this vehicle is an amphibious car.
Public propertyIsAmphibiousQuadBike
Gets a value indicating whether this vehicle is an amphibious quad bike.
Public propertyIsBicycle
Gets a value indicating whether this vehicle is a bicycle.
Public propertyIsBig

Gets a value indicating whether this is a big vehicle, like busses, trucks, semis, etc.

Does not return true for certain special vehicles like CUTTER.

Public propertyIsBike
Gets a value indicating whether this vehicle is a bike.
Public propertyIsBlimp
Gets a value indicating whether this vehicle is a blimp.
Public propertyIsBoat
Gets a value indicating whether this vehicle is a boat.
Public propertyIsBulletProof
Gets or sets a value indicating whether this entity can take damage from bullets.
(Inherited from Entity.)
Public propertyIsBurnoutForced
Sets a value indicating whether this vehicle is forced into a burnout.
Public propertyIsCar
Gets a value indicating whether this vehicle is a car.
Public propertyIsCollisionEnabled
Gets or sets a value indicating whether collision is enabled for this entity.
(Inherited from Entity.)
Public propertyIsCollisionProof
Gets or sets a value indicating whether this entity can take damage from collisions.
(Inherited from Entity.)
Public propertyIsConvertible
Gets a value indicating whether this vehicle is a convertible.
Public propertyIsDead
Gets a value indicating whether this instance is dead.
(Inherited from Entity.)
Public propertyIsDeformationEnabled

Gets or sets a value indicating whether deformation is enabled for this vehicle.

If deformation is disabled, the car will still take damage, but will not become deform.

Lights, fenders, etc. will still take damage.

Public propertyIsDriveable
Gets or sets whether this instance is driveable.
Public propertyIsEmpty
Gets a value indicating whether this vehicle currently has no occupants.
Public propertyIsEngineOn
Gets or sets a value indicating whether the engine of this vehicle is on.
Public propertyIsEngineStarting
Gets or sets a value indicating whether the engine of this vehicle is currently starting.
Public propertyIsExplosionProof
Gets or sets a value indicating whether this entity can take damage from explosions.
(Inherited from Entity.)
Public propertyIsFireProof
Gets or sets a value indicating whether this entity can take damage from fire.
(Inherited from Entity.)
Public propertyIsFull
Gets a value indicating whether this vehicle currently is full.
Public propertyIsGravityDisabled
Gets or sets a value indicating whether gravity is disabled for this entity.
(Inherited from Entity.)
Public propertyIsHandbrakeForced
Gets or sets a value indicating whether this handbrake on this vehicle is forced on.
Public propertyIsHelicopter
Gets a value indicating whether this vehicle is a helicopter.
Public propertyIsInAir (Inherited from Entity.)
Public propertyIsInBurnout
Gets a value indicating whether this vehicle is in a burnout.
Public propertyIsInteriorLightOn
Gets or sets a value indicating whether the interior light in this vehicle is on.
Public propertyIsInvincible
Sets a value indicating whether this instance is invincible.
(Inherited from Entity.)
Public propertyIsInWater

Gets a value indicating whether this entity is currently in water.

Returns true the moment any part of the entity is touching water.

(Inherited from Entity.)
Public propertyIsMeleeProof
Gets or sets a value indicating whether this entity can take damage from melee attacks.
(Inherited from Entity.)
Public propertyIsOnAllWheels
Gets a value indicating whether all wheels of this vehicle are touching the ground.
Public propertyIsOnFire
Gets or sets a value indicating whether this Entity is on fire.
(Inherited from Entity.)
Public propertyIsOnScreen
Gets a value indicating whether this instance is on the screen.
(Inherited from Entity.)
Public propertyIsPersistent
Gets or sets a value indicating whether this instance is persistent within the game world. Persistent instances will not be removed automatically during clean ups.
(Inherited from Entity.)
Public propertyIsPlane
Gets a value indicating whether this vehicle is a plane.
Public propertyIsPoliceVehicle
Gets a value indicating whether this vehicle is a police vehicle.
Public propertyIsPositionFrozen
Sets a value indicating whether the position of this entity is frozen.
(Inherited from Entity.)
Public propertyIsQuadBike
Gets a value indicating whether this vehicle is a quad bike.
Public propertyIsRecordingCollisions
Gets or sets a value indicating whether this entity is recording collisions.
(Inherited from Entity.)
Public propertyIsRendered
Gets a value indicating whether this instance is currently being rendered.
(Inherited from Entity.)
Public propertyIsSirenOn

Gets or sets a value indicating whether the siren is on.

If this vehicle is not an emergency vehicle, the method will have no effect.

Public propertyIsSirenSilent

Gets or sets a value indicating whether the siren is silent.

If this vehicle is not an emergency vehicle, the method will have no effect.

Public propertyIsStolen
Gets or sets a value indicating whether this vehicle is stolen.
Public propertyIsStoppedAtTrafficLights
Gets a value indicating whether this vehicle is currently stopped at traffic lights.
Public propertyIsSubmarine
Gets a value indicating whether this vehicle is a submarine.
Public propertyIsTaxiLightOn

Gets or sets a value indicating whether the taxi lights are on.

If this vehicle is not a taxi, the method will have no effect.

Public propertyIsTrailer
Gets a value indicating whether this vehicle is a trailer.
Public propertyIsTrain
Gets a value indicating whether this vehicle is a train.
Public propertyIsUpsideDown
Gets or sets a value indicating whether this entity is upside down.
(Inherited from Entity.)
Public propertyIsVisible

Gets or sets a value indicating whether this instance is currently visible within the game world.

Invisible instances will still be processed but will not be rendered.

(Inherited from Entity.)
Public propertyLeftPosition
Gets a position directly to the left of this Entity.
(Inherited from Entity.)
Public propertyLength
Gets the length of this Entity.
(Inherited from Entity.)
Public propertyLicensePlate
Gets or sets the license plate of this vehicle.
Public propertyLicensePlateStyle
Public propertyLicensePlateType
Public propertyLockStatus
Gets or sets the lock status of this vehicle.
Public propertyMaxHealth
Gets or sets the maximum health of this instance.
(Inherited from Entity.)
Public propertyMemoryAddress
Gets the memory address of this instance.
(Inherited from Entity.)
Public propertyCode exampleMetadata

Gets the metadata associated with this instance.

The value of this property can be used to store data about this instance.
Getting or setting metadata is done using the same syntax as getting or setting a property.
Internally the value is added to a dictionary with the specified property name as key.

(Inherited from Entity.)
Public propertyModel
Gets or sets the Model of this instance.
(Inherited from Entity.)
Public propertyMods
Gets an instance of VehicleModder that can be used to change mods on this vehicle.
Public propertyMustBeHotwired
Gets or sets a value indicating whether this vehicle must be hotwired before its engine can be turned on.
Public propertyNeedsCollision

Gets a value indicating whether this instance needs collision.

Entities not marked explicitly to need collision will still get collision, however, if other entities need collision, entities not marked as needing collision may lose it in favor of those.

(Inherited from Entity.)
Public propertyNumberOfGears
Gets or sets the number of gears this vehicle has.
Public propertyOccupants

Gets all peds currently in this vehicle.

Includes the driver.

Public propertyOpacity
Gets or sets the opacity of this instance.
(Inherited from Entity.)
Public propertyOrientation
Gets or sets the orientation of this instance.
(Inherited from Entity.)
Public propertyPassengerCapacity
Gets the number of passengers this vehicle has seats for. Does not include the driver seat.
Public propertyPassengerCount
Gets the number of passengers this vehicle currently has. Does not include the driver.
Public propertyPassengers

Gets the passengers of this vehicle.

Does not include the driver.

If you need a passenger at a specific seat index, using GetPedOnSeat(Int32) is more efficient.

Public propertyPearlescentColor
Gets or sets the pearlescent color of this vehicle.
Public propertyPosition
Gets or sets the position of this instance.
(Inherited from Entity.)
Public propertyPrimaryColor
Gets or sets the primary color of this vehicle.
Public propertyQuaternion Obsolete.
Gets or sets the quaternion of this instance.
(Inherited from Entity.)
Public propertyRadioStation
Gets or sets the radio station of this vehicle.
Public propertyRearPosition
Gets a position directly behind this Entity.
(Inherited from Entity.)
Public propertyRightPosition
Gets a position directly to the right of this Entity.
(Inherited from Entity.)
Public propertyRightVector
Gets the right vector of this instance.
(Inherited from Entity.)
Public propertyRimColor
Gets or sets the color of the rims on the wheels of this vehicle. The wheels must be custom.
Public propertyRotation
Gets or sets the rotation of this instance.
(Inherited from Entity.)
Public propertySecondaryColor
Gets or sets the secondary color of this vehicle.
Public propertyShouldVehiclesYieldToThisVehicle

Gets or sets whether other vehicles should yield to this vehicle.

This vehicle must be an emergency vehicle (Police, ambulance or fire truck).

Public propertySpeed

Gets the speed of this Entity in meters per second.

This is equivalent of Velocity.Length().

(Inherited from Entity.)
Public propertySteeringAngle
Gets or sets the steering angle.
Public propertySteeringScale
Gets or sets the steering scale.
Public propertySubmersionLevel
Gets a value indicating how submersed this entity is.
(Inherited from Entity.)
Public propertyTopSpeed
Gets or sets the top speed of this vehicle.
Public propertyTowedVehicle
Gets the Vehicle currently being towed by this Vehicle.
Public propertyTowingCraneRaisedAmount

Sets a value indicating how much the towing crane is raised.

This Vehicle must have a towing device.

Public propertyTrailer
Gets or sets the trailer on this vehicle.
Public propertyUpVector
Gets the up vector of this instance.
(Inherited from Entity.)
Public propertyVelocity
Gets or sets the velocity of this entity.
(Inherited from Entity.)
Public propertyVerticalFlightPhase

Gets or sets the vertical flight phase. This adjusts the thruster angle on VTOL enabled planes.

Note that the game will interppolate this property to the value of DesiredVerticalFlightPhase.

To have the plane remain at the specified value, set both properties to the same value.

Public propertyWheels
Gets the wheels of this vehicle.
Public propertyWidth
Gets the width of this Entity.
(Inherited from Entity.)
Public propertyWindows
Gets the windows of this vehicle.
Top
See Also

Reference