[This is preliminary documentation and is subject to change.]
RageEntity
RageVehicle
Namespace: Rage
Assembly: RagePluginHook (in RagePluginHook.dll) Version: 0.0.0.0 (0.56.1131.11510)
The Vehicle type exposes the following members.
Name | Description | |
---|---|---|
Vehicle |
Initializes a new instance of the Vehicle class.
| |
Vehicle(PredicateModel) |
Initializes a new instance of the Vehicle class.
| |
Vehicle(PoolHandle) |
Initializes a new instance of the Vehicle class.
| |
Vehicle(Vector3) |
Initializes a new instance of the Vehicle class.
| |
Vehicle(Model, Vector3) |
Initializes a new instance of the Vehicle class.
| |
Vehicle(PredicateModel, Vector3) |
Initializes a new instance of the Vehicle class.
| |
Vehicle(Vector3, Single) |
Initializes a new instance of the Vehicle class.
| |
Vehicle(Model, Vector3, Single) |
Initializes a new instance of the Vehicle class.
| |
Vehicle(PredicateModel, Vector3, Single) |
Initializes a new instance of the Vehicle class.
|
Name | Description | |
---|---|---|
AbovePosition |
Gets a position directly above this Entity.
(Inherited from Entity.) | |
AccelerationScale |
Gets the acceleration scale.
| |
AlarmTimeLeft | Gets or sets time left before the vehicle alarm stops. If greater than zero, the vehicle alarm will be sounding. | |
AngularVelocity |
Gets or sets the rotational velocity of this entity.
(Inherited from Entity.) | |
BelowPosition |
Gets a position directly below this Entity.
(Inherited from Entity.) | |
CanBeDamaged |
Gets or sets a value indicating whether this entity can be damaged.
(Inherited from Entity.) | |
CanTiresBurst |
Gets or sets a value indicating whether the tired of this vehicle can be burst.
| |
Class | ||
CollisionIgnoredEntity |
Gets or sets the Entity this entity currently ignores collisions from.
(Inherited from Entity.) | |
ConvertibleRoofState | ||
CreatedByTheCallingPlugin |
Gets a value indicating whether this instance was created by the calling plugin.
(Inherited from Entity.) | |
CurrentGear |
Gets the current gear of this vehicle.
| |
DefaultEmergencyLighting |
Gets the default emergency lighting settings for this type of vehicle.
| |
DesiredVerticalFlightPhase | 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. | |
Direction |
Gets or sets the direction of this instance.
(Inherited from Entity.) | |
DirtLevel |
Gets or sets the dirt level of this vehicle.
| |
Doors |
Gets the doors of this vehicle.
| |
DriveForce |
Gets or sets the drive force of this vehicle.
| |
Driver |
Gets the Ped on the driver's seat of this vehicle.
| |
EmergencyLighting |
Gets the emergency lighting settings currently assigned to this vehicle.
| |
EmergencyLightingOverride |
Gets or sets the overriden emergency lighting settings for this vehicle.
| |
EngineHealth | 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. | |
EngineRevolutionsRatio |
Gets the current engine revolutions ratio.
| |
ForwardVector |
Gets the forward vector of this instance.
(Inherited from Entity.) | |
FreePassengerSeatsCount | Gets the number of free passenger seats in this vehicle. Does not include the driver's seat. | |
FreeSeatsCount | Gets the number of free seats in this vehicle. Includes the driver's seat. | |
FrontPosition |
Gets a position directly in front of this Entity.
(Inherited from Entity.) | |
FuelLevel | Gets or sets the amount of fuel in this vehicle. | |
FuelTankHealth | 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. | |
Handle |
Gets the handle of this instance. Used to identify the instance within its pool.
(Inherited from Entity.) | |
HandlingData | 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. | |
HasBeenDamagedByAnyObject |
Gets or sets a value indicating whether this entity has been damaged by any Object.
(Inherited from Entity.) | |
HasBeenDamagedByAnyPed |
Gets or sets a value indicating whether this entity has been damaged by any Ped.
(Inherited from Entity.) | |
HasBeenDamagedByAnyVehicle |
Gets or sets a value indicating whether this entity has been damaged by any Vehicle.
(Inherited from Entity.) | |
HasBeenDisabledByWater |
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.
| |
HasBombBay |
Gets a value indicating whether this vehicle has a bomb bay.
| |
HasDiggerArm |
Gets a value indicating whether this vehicle has a digger arm.
| |
HasDriver |
Gets a value indicating whether this vehicle has a driver.
| |
HasForks |
Gets a value indicating whether this vehicle has forks.
| |
HasOccupants | Gets a value indicating whether this vehicle has one or more occupants. Includes the driver. | |
HasPassengers | Gets a value indicating whether this vehicle has one or more passengers. Does not include the driver. | |
HasRoof | Gets a value indicating whether this vehicle has a roof. Returns true for convertibles, even when their roof is down. | |
HasSiren |
Gets a value indicating whether this vehicle has a siren.
| |
HasTowArm |
Gets a value indicating whether this vehicle has a tow arm.
| |
HasTracks |
Gets a value indicating whether this vehicle has tracks.
| |
HasTrailer |
Gets a value indicating whether this vehicle has a trailer attached.
| |
HasTrailerHitch |
Gets a value indicating whether this vehicle has a trailer hitch.
| |
Heading |
Gets or sets the heading of this instance in degrees.
(Inherited from Entity.) | |
Health |
Gets or sets the health of this instance.
(Inherited from Entity.) | |
Height |
Gets the height of this Entity.
(Inherited from Entity.) | |
HeightAboveGround | 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). | |
IndicatorLightsStatus |
Sets the status of the indicator lights on this vehicle.
| |
Invincible | Obsolete.
Sets a value indicating whether this instance is invincible.
(Inherited from Entity.) | |
IsAlarmSounding |
Gets a value indicating whether this vehicle's alarm is sounding.
| |
IsAlive |
Gets a value indicating whether this instance is alive.
(Inherited from Entity.) | |
IsAmphibious |
Gets a value indicating whether this vehicle is amphibious.
| |
IsAmphibiousCar |
Gets a value indicating whether this vehicle is an amphibious car.
| |
IsAmphibiousQuadBike |
Gets a value indicating whether this vehicle is an amphibious quad bike.
| |
IsBicycle |
Gets a value indicating whether this vehicle is a bicycle.
| |
IsBig | 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. | |
IsBike |
Gets a value indicating whether this vehicle is a bike.
| |
IsBlimp |
Gets a value indicating whether this vehicle is a blimp.
| |
IsBoat |
Gets a value indicating whether this vehicle is a boat.
| |
IsBulletProof |
Gets or sets a value indicating whether this entity can take damage from bullets.
(Inherited from Entity.) | |
IsBurnoutForced |
Sets a value indicating whether this vehicle is forced into a burnout.
| |
IsCar |
Gets a value indicating whether this vehicle is a car.
| |
IsCollisionEnabled |
Gets or sets a value indicating whether collision is enabled for this entity.
(Inherited from Entity.) | |
IsCollisionProof |
Gets or sets a value indicating whether this entity can take damage from collisions.
(Inherited from Entity.) | |
IsConvertible |
Gets a value indicating whether this vehicle is a convertible.
| |
IsDead |
Gets a value indicating whether this instance is dead.
(Inherited from Entity.) | |
IsDeformationEnabled | 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. | |
IsDriveable |
Gets or sets whether this instance is driveable.
| |
IsEmpty |
Gets a value indicating whether this vehicle currently has no occupants.
| |
IsEngineOn |
Gets or sets a value indicating whether the engine of this vehicle is on.
| |
IsEngineStarting |
Gets or sets a value indicating whether the engine of this vehicle is currently starting.
| |
IsExplosionProof |
Gets or sets a value indicating whether this entity can take damage from explosions.
(Inherited from Entity.) | |
IsFireProof |
Gets or sets a value indicating whether this entity can take damage from fire.
(Inherited from Entity.) | |
IsFull |
Gets a value indicating whether this vehicle currently is full.
| |
IsGravityDisabled |
Gets or sets a value indicating whether gravity is disabled for this entity.
(Inherited from Entity.) | |
IsHandbrakeForced |
Gets or sets a value indicating whether this handbrake on this vehicle is forced on.
| |
IsHelicopter |
Gets a value indicating whether this vehicle is a helicopter.
| |
IsInAir | (Inherited from Entity.) | |
IsInBurnout |
Gets a value indicating whether this vehicle is in a burnout.
| |
IsInteriorLightOn |
Gets or sets a value indicating whether the interior light in this vehicle is on.
| |
IsInvincible |
Sets a value indicating whether this instance is invincible.
(Inherited from Entity.) | |
IsInWater | Gets a value indicating whether this entity is currently in water. Returns true the moment any part of the entity is touching water. | |
IsMeleeProof |
Gets or sets a value indicating whether this entity can take damage from melee attacks.
(Inherited from Entity.) | |
IsOnAllWheels |
Gets a value indicating whether all wheels of this vehicle are touching the ground.
| |
IsOnFire |
Gets or sets a value indicating whether this Entity is on fire.
(Inherited from Entity.) | |
IsOnScreen |
Gets a value indicating whether this instance is on the screen.
(Inherited from Entity.) | |
IsPersistent |
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.) | |
IsPlane |
Gets a value indicating whether this vehicle is a plane.
| |
IsPoliceVehicle |
Gets a value indicating whether this vehicle is a police vehicle.
| |
IsPositionFrozen |
Sets a value indicating whether the position of this entity is frozen.
(Inherited from Entity.) | |
IsQuadBike |
Gets a value indicating whether this vehicle is a quad bike.
| |
IsRecordingCollisions |
Gets or sets a value indicating whether this entity is recording collisions.
(Inherited from Entity.) | |
IsRendered |
Gets a value indicating whether this instance is currently being rendered.
(Inherited from Entity.) | |
IsSirenOn | 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. | |
IsSirenSilent | 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. | |
IsStolen |
Gets or sets a value indicating whether this vehicle is stolen.
| |
IsStoppedAtTrafficLights |
Gets a value indicating whether this vehicle is currently stopped at traffic lights.
| |
IsSubmarine |
Gets a value indicating whether this vehicle is a submarine.
| |
IsTaxiLightOn | 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. | |
IsTrailer |
Gets a value indicating whether this vehicle is a trailer.
| |
IsTrain |
Gets a value indicating whether this vehicle is a train.
| |
IsUpsideDown |
Gets or sets a value indicating whether this entity is upside down.
(Inherited from Entity.) | |
IsVisible | 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. | |
LeftPosition |
Gets a position directly to the left of this Entity.
(Inherited from Entity.) | |
Length |
Gets the length of this Entity.
(Inherited from Entity.) | |
LicensePlate |
Gets or sets the license plate of this vehicle.
| |
LicensePlateStyle | ||
LicensePlateType | ||
LockStatus |
Gets or sets the lock status of this vehicle.
| |
MaxHealth |
Gets or sets the maximum health of this instance.
(Inherited from Entity.) | |
MemoryAddress |
Gets the memory address of this instance.
(Inherited from Entity.) | |
Metadata | Gets the metadata associated with this instance.
The value of this property can be used to store data about this instance. | |
Model |
Gets or sets the Model of this instance.
(Inherited from Entity.) | |
Mods |
Gets an instance of VehicleModder that can be used to change mods on this vehicle.
| |
MustBeHotwired |
Gets or sets a value indicating whether this vehicle must be hotwired before its engine can be turned on.
| |
NeedsCollision | 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. | |
NumberOfGears |
Gets or sets the number of gears this vehicle has.
| |
Occupants | Gets all peds currently in this vehicle. Includes the driver. | |
Opacity |
Gets or sets the opacity of this instance.
(Inherited from Entity.) | |
Orientation |
Gets or sets the orientation of this instance.
(Inherited from Entity.) | |
PassengerCapacity |
Gets the number of passengers this vehicle has seats for. Does not include the driver seat.
| |
PassengerCount |
Gets the number of passengers this vehicle currently has. Does not include the driver.
| |
Passengers | 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. | |
PearlescentColor |
Gets or sets the pearlescent color of this vehicle.
| |
Position |
Gets or sets the position of this instance.
(Inherited from Entity.) | |
PrimaryColor |
Gets or sets the primary color of this vehicle.
| |
Quaternion | Obsolete.
Gets or sets the quaternion of this instance.
(Inherited from Entity.) | |
RadioStation |
Gets or sets the radio station of this vehicle.
| |
RearPosition |
Gets a position directly behind this Entity.
(Inherited from Entity.) | |
RightPosition |
Gets a position directly to the right of this Entity.
(Inherited from Entity.) | |
RightVector |
Gets the right vector of this instance.
(Inherited from Entity.) | |
RimColor |
Gets or sets the color of the rims on the wheels of this vehicle. The wheels must be custom.
| |
Rotation |
Gets or sets the rotation of this instance.
(Inherited from Entity.) | |
SecondaryColor |
Gets or sets the secondary color of this vehicle.
| |
ShouldVehiclesYieldToThisVehicle | Gets or sets whether other vehicles should yield to this vehicle. This vehicle must be an emergency vehicle (Police, ambulance or fire truck). | |
Speed | (Inherited from Entity.) | |
SteeringAngle |
Gets or sets the steering angle.
| |
SteeringScale |
Gets or sets the steering scale.
| |
SubmersionLevel |
Gets a value indicating how submersed this entity is.
(Inherited from Entity.) | |
TopSpeed |
Gets or sets the top speed of this vehicle.
| |
TowedVehicle |
Gets the Vehicle currently being towed by this Vehicle.
| |
TowingCraneRaisedAmount | Sets a value indicating how much the towing crane is raised. This Vehicle must have a towing device. | |
Trailer |
Gets or sets the trailer on this vehicle.
| |
UpVector |
Gets the up vector of this instance.
(Inherited from Entity.) | |
Velocity |
Gets or sets the velocity of this entity.
(Inherited from Entity.) | |
VerticalFlightPhase | 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. | |
Wheels |
Gets the wheels of this vehicle.
| |
Width |
Gets the width of this Entity.
(Inherited from Entity.) | |
Windows |
Gets the windows of this vehicle.
|
Name | Description | |
---|---|---|
ApplyForce |
Applies force to this instance.
(Inherited from Entity.) | |
ApplySirenSettingsFrom | ||
AreAllComponentsBroken | ||
AreAnyComponentsBroken | ||
AttachBlip |
Creates a new Blip and attaches it to this instance.
(Inherited from Entity.) | |
AttachTo | (Inherited from Entity.) | |
BlipSiren | Blips the siren. This is identical to the blip that is played when the siren is briefly turned on and off, but does not turn on the light. | |
CreateRandomDriver |
Creates a new Ped with a random model in the driver's seat.
| |
Deform |
Applies deformation to this vehicle.
| |
Delete | Deletes this instance. Any call to a non-existent instance is invalid and will cause an exception. | |
Detach | (Inherited from Entity.) | |
DetachFromTowTruck | Detaches this Vehicle from the tow truck it's currently being towed by, if any. | |
DetachTowedVehicle | Detaches the Vehicle currently being towed by this Vehicle. This Vehicle must have a towing device. | |
DetachWindscreen |
Detaches the windscreen of this instance.
| |
Dismiss | If this instance is marked as persistent, makes the entity non-persistent. Non-persistent entities will be deleted from the game world during clean ups. This is equivalent to setting IsPersistent to false. | |
DistanceTo(ISpatial) |
Gets the distance from this instance to the specified ISpatial instance.
(Inherited from Entity.) | |
DistanceTo(Vector3) |
Gets the distance from this instance to the specified position.
(Inherited from Entity.) | |
DistanceTo2D(ISpatial) |
Gets the distance from this instance to the specified ISpatial instance.
(Inherited from Entity.) | |
DistanceTo2D(Vector3) |
Gets the distance from this instance to the specified position.
(Inherited from Entity.) | |
Equals(Entity) |
Indicates whether the current instance is equal to another instance of the same type.
(Inherited from Entity.) | |
Equals(IHandleable) |
Indicates whether the current IHandleable is equal to another IHandleable.
(Inherited from Entity.) | |
Explode |
Explodes this instance.
| |
Explode(Boolean) |
Explodes this instance.
| |
Face(ISpatial) |
Sets the orientation of this instance to face the specified ISpatial.
(Inherited from Entity.) | |
Face(Vector3) |
Sets the orientation of this instance to face the specified position.
(Inherited from Entity.) | |
FindTowTruck |
Finds the tow truck currently towing this Vehicle.
| |
GetAttachedBlip |
Gets the first Blip attached to this instance.
(Inherited from Entity.) | |
GetAttachedBlips |
Gets all Blips attached to this instance.
(Inherited from Entity.) | |
GetBoneAxes(Int32, Vector3, Vector3, Vector3) |
Gets the axes of the specified bone. That is, three vectors pointing right, forward and up, relative to the bone's orientation.
(Inherited from Entity.) | |
GetBoneAxes(String, Vector3, Vector3, Vector3) |
Gets the axes of the specified bone. That is, three vectors pointing right, forward and up, relative to the bone's orientation.
(Inherited from Entity.) | |
GetBoneIndex |
Gets the index of a bone of this Entity, given the bone's name.
(Inherited from Entity.) | |
GetBoneOrientation(Int32) |
Gets the orientation of the specified bone.
(Inherited from Entity.) | |
GetBoneOrientation(String) |
Gets the orientation of the specified bone.
(Inherited from Entity.) | |
GetBonePosition(Int32) |
Gets the position of the specified bone, in world space.
(Inherited from Entity.) | |
GetBonePosition(String) |
Gets the position of the specified bone, in world space.
(Inherited from Entity.) | |
GetBoneRotation(Int32) |
Gets the rotation of the specified bone.
(Inherited from Entity.) | |
GetBoneRotation(String) |
Gets the rotation of the specified bone.
(Inherited from Entity.) | |
GetDoors |
Gets all doors of this Vehicle.
| |
GetFreePassengerSeatIndex | Gets the first free index seat of this vehicle. Does not include the driver's seat. | |
GetFreeSeatIndex | Gets the first free index seat of this vehicle. Includes the driver's seat. | |
GetFreeSeatIndex(Int32, Int32) | Gets the first free index seat of this vehicle between the specified indices, both inclusive. | |
GetLastCollision(Vector3) |
Gets the last collision of this entity.
(Inherited from Entity.) | |
GetLastCollision(Vector3, Vector3) |
Gets the last collision of this entity.
(Inherited from Entity.) | |
GetLastCollision(Vector3, Vector3, String) |
Gets the last collision of this entity.
(Inherited from Entity.) | |
GetOffsetPosition |
Gets a position offset relative to this instance, based on the instance's position and direction.
(Inherited from Entity.) | |
GetOffsetPositionFront |
Gets a position that is the specified offset towards the entity's front.
(Inherited from Entity.) | |
GetOffsetPositionRight |
Gets a position that is the specified offset towards the entity's right.
(Inherited from Entity.) | |
GetOffsetPositionUp |
Gets a position that is the specified offset towards the entity's top.
(Inherited from Entity.) | |
GetPedOnSeat |
Gets the Ped on the seat at the specified index.
| |
GetPositionOffset | Gets the offset to the specified world position, relative to this Entity. This is essentially the opposite of GetOffsetPosition(Vector3) | |
GetPreviousPedOnSeat | ||
HasBeenDamagedBy |
Determines whether this entity has been damaged by the specified entity.
(Inherited from Entity.) | |
HasBone(Int32) |
Determines whether this Entity has the specified bone.
(Inherited from Entity.) | |
HasBone(String) |
Determines whether this Entity has the specified bone.
(Inherited from Entity.) | |
IsLockedForPlayer |
Determines whether this vehicle is locked for the specified Player.
| |
IsSeatFree |
Determines whether the seat at the specified index is free.
| |
IsTouching |
Determines whether this entity is touching the specified entity.
(Inherited from Entity.) | |
IsValid |
Determines whether this instance still represents an existing entity within the game world. Calls to an invalid instance is illegal and will result in an exception.
(Inherited from Entity.) | |
MakePersistent |
Makes this vehicle and attached trailer persistent.
(Overrides EntityMakePersistent.) | |
PunctureFuelTank |
Punctures the fuel tank.
| |
Repair |
Repairs this instance.
| |
RepairComponents | ||
SetLockedForPlayer |
Sets whether this vehicle is locked for the specified Player | |
SetPositionWithSnap | Sets the position of this Entity to the specified value. Unlike Position, if the specified position is in the ground, the position will be adjusted to place the entity above it. | |
SetPositionX |
Sets X-component of the Position of this entity.
(Inherited from Entity.) | |
SetPositionY |
Sets Y-component of the Position of this entity.
(Inherited from Entity.) | |
SetPositionZ |
Sets Z-component of the Position of this entity.
(Inherited from Entity.) | |
SetQuaternionW |
Sets W-component of the Quaternion of this entity.
(Inherited from Entity.) | |
SetQuaternionX |
Sets X-component of the Quaternion of this entity.
(Inherited from Entity.) | |
SetQuaternionY |
Sets Y-component of the Quaternion of this entity.
(Inherited from Entity.) | |
SetQuaternionZ |
Sets Z-component of the Quaternion of this entity.
(Inherited from Entity.) | |
SetRotationPitch |
Sets Pitch-component of the Rotation of this entity.
(Inherited from Entity.) | |
SetRotationRoll |
Sets Roll-component of the Rotation of this entity.
(Inherited from Entity.) | |
SetRotationYaw |
Sets Yaw-component of the Rotation of this entity.
(Inherited from Entity.) | |
TowVehicle | Attaches a Vehicle to the towing device of this Vehicle. This Vehicle must have a towing device. | |
TravelDistanceTo(ISpatial) |
Gets the distance from this instance to the specified ISpatial instance, if using the road system.
(Inherited from Entity.) | |
TravelDistanceTo(Vector3) |
Gets the distance from this instance to the specified position, if using the road system.
(Inherited from Entity.) | |
Wash |
Washes this instance.
|