Interface IVehicle
Inherited Members
Namespace: AltV.Net.Elements.Entities
Assembly: AltV.Net.dll
Syntax
public interface IVehicle : ISharedVehicle, IEntity, ISharedEntity, IWorldObject, ISharedWorldObject, IBaseObject, ISharedBaseObject, INative
Properties
| Improve this Doc View SourceAccelerationLevel
Declaration
float AccelerationLevel { get; }
Property Value
| Type | Description |
|---|---|
| System.Single |
AppearanceData
Declaration
string AppearanceData { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Attached
Gets the vehicle that is attached on this vehicle
Declaration
IVehicle Attached { get; }
Property Value
| Type | Description |
|---|---|
| IVehicle |
AttachedTo
Gets the vehicle that this vehicle is attached to
Declaration
IVehicle AttachedTo { get; }
Property Value
| Type | Description |
|---|---|
| IVehicle |
BoatAnchor
Get or set boat anchor of the vehicle
Declaration
bool BoatAnchor { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
BodyAdditionalHealth
The additional body health
Declaration
uint BodyAdditionalHealth { get; set; }
Property Value
| Type | Description |
|---|---|
| System.UInt32 |
BodyHealth
The body health
Declaration
uint BodyHealth { get; set; }
Property Value
| Type | Description |
|---|---|
| System.UInt32 |
BrakeLevel
Declaration
float BrakeLevel { get; }
Property Value
| Type | Description |
|---|---|
| System.Single |
CounterMeasureCount
Gets or sets the vehicle counter measure count
Declaration
uint CounterMeasureCount { get; set; }
Property Value
| Type | Description |
|---|---|
| System.UInt32 |
CustomTires
Sets custom tires on the vehicle
Declaration
bool CustomTires { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
DamageData
Returns the damage data
Declaration
string DamageData { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
DashboardColor
Dashboard Color
Declaration
byte DashboardColor { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Byte |
DirtLevel
The dirt level
Declaration
byte DirtLevel { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Byte |
DriftMode
Get or set drift mode of the vehicle
Declaration
bool DriftMode { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
Driver
Get the current driver of the
Declaration
IPlayer Driver { get; }
Property Value
| Type | Description |
|---|---|
| IPlayer |
Exceptions
| Type | Condition |
|---|---|
| EntityRemovedException | This entity was removed |
EngineHealth
Engine Health
Declaration
int EngineHealth { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Int32 |
EngineOn
Sets or Returns the status of the Engine
Declaration
bool EngineOn { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
HasArmoredWindows
Returns true if has armored windows
Declaration
bool HasArmoredWindows { get; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
HeadlightColor
The current headlight color
Declaration
byte HeadlightColor { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Byte |
HealthData
Health Data
Declaration
string HealthData { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
HybridExtraActive
Gets or sets the hybrid extra
Declaration
bool HybridExtraActive { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
HybridExtraState
Gets or sets the hybrid extra state
Declaration
byte HybridExtraState { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Byte |
InteriorColor
Interior Color
Declaration
byte InteriorColor { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Byte |
IsDaylightOn
Is the day lights on
Declaration
bool IsDaylightOn { get; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
IsDestroyed
Gets if the vehicle is destroyed.
Declaration
bool IsDestroyed { get; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
IsFlamethrowerActive
If the flamethrower is active
Declaration
bool IsFlamethrowerActive { get; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
IsHandbrakeActive
Returns the status of the handbrake
Declaration
bool IsHandbrakeActive { get; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
IsHornActive
Declaration
bool IsHornActive { get; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
IsMissionTrain
Gets or sets if the vehicle is a train
Declaration
bool IsMissionTrain { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
IsNeonActive
Is the neon active - True = Active
Declaration
bool IsNeonActive { get; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
IsNightlightOn
Is the night light on
Declaration
bool IsNightlightOn { get; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
IsPrimaryColorRgb
If the primary color is RGBA
Declaration
bool IsPrimaryColorRgb { get; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
IsRoofClosed
Sets the Roof closed
Declaration
bool IsRoofClosed { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
IsSecondaryColorRgb
If the secondary color is RGBA
Declaration
bool IsSecondaryColorRgb { get; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
IsTireSmokeColorCustom
If the tyre smoke is RGBA
Declaration
bool IsTireSmokeColorCustom { get; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
IsTowingDisabled
Gets or sets to disable the towing
Declaration
bool IsTowingDisabled { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
IsTrainCaboose
Gets or sets if the vehicle is caboose
Declaration
bool IsTrainCaboose { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
IsTrainEngine
Gets or sets if the vehicle is the trains engine
Declaration
bool IsTrainEngine { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
LightsMultiplier
Multiplier for the lights
Declaration
float LightsMultiplier { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Single |
LightState
Declaration
byte LightState { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Byte |
Livery
The livery
Declaration
byte Livery { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Byte |
LockState
Returns or Sets the LockState of the vehicle
Declaration
VehicleLockState LockState { get; set; }
Property Value
| Type | Description |
|---|---|
| VehicleLockState |
ManualEngineControl
Enables or Disables automatic engine start when a player enters the drivers seat
Declaration
bool ManualEngineControl { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
ModKit
Get or set mod kit of the
Declaration
byte ModKit { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Byte |
Exceptions
| Type | Condition |
|---|---|
| EntityRemovedException | This entity was removed |
ModKitsCount
The amount of Modkits
Declaration
byte ModKitsCount { get; }
Property Value
| Type | Description |
|---|---|
| System.Byte |
NeonColor
Neon Color in RGBA
Declaration
Rgba NeonColor { get; set; }
Property Value
| Type | Description |
|---|---|
| Rgba |
NumberplateIndex
Get or set number plate index of the vehicle
Declaration
uint NumberplateIndex { get; set; }
Property Value
| Type | Description |
|---|---|
| System.UInt32 |
Exceptions
| Type | Condition |
|---|---|
| EntityRemovedException | This entity was removed |
NumberplateText
Get or set number plate text of the vehicle
Declaration
string NumberplateText { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Exceptions
| Type | Condition |
|---|---|
| EntityRemovedException | This entity was removed |
Passengers
Declaration
List<PlayerSeat> Passengers { get; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.List<PlayerSeat> |
PearlColor
Pearl Color
Declaration
byte PearlColor { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Byte |
PetrolTankHealth
Fuel Tank Health
Declaration
int PetrolTankHealth { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Int32 |
PrimaryColor
Get or set primary color of the
Declaration
byte PrimaryColor { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Byte |
Exceptions
| Type | Condition |
|---|---|
| EntityRemovedException | This entity was removed |
PrimaryColorRgb
The primary color in RGBA
Declaration
Rgba PrimaryColorRgb { get; set; }
Property Value
| Type | Description |
|---|---|
| Rgba |
Quaternion
Declaration
Quaternion Quaternion { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Numerics.Quaternion |
RadioStation
Sets or Gets the current radio station
Declaration
uint RadioStation { get; set; }
Property Value
| Type | Description |
|---|---|
| System.UInt32 |
RearWheel
Rear wheel variation.
Declaration
byte RearWheel { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Byte |
RepairsCount
The amount of repairs
Declaration
byte RepairsCount { get; }
Property Value
| Type | Description |
|---|---|
| System.Byte |
RocketRefuelSpeed
Gets or sets the rocket refuel speed
Declaration
float RocketRefuelSpeed { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Single |
RoofLivery
The roof livery
Declaration
byte RoofLivery { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Byte |
ScriptData
Script Data
Declaration
string ScriptData { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
ScriptMaxSpeed
Gets or sets the script max speed
Declaration
float ScriptMaxSpeed { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Single |
SecondaryColor
The secondary color
Declaration
byte SecondaryColor { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Byte |
SecondaryColorRgb
The secondary color in RGBA
Declaration
Rgba SecondaryColorRgb { get; set; }
Property Value
| Type | Description |
|---|---|
| Rgba |
SirenActive
Sets or Gets if the siren is active. True = active
Declaration
bool SirenActive { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
SpecialDarkness
Declaration
byte SpecialDarkness { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Byte |
State
Vehicle state
Declaration
string State { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
TimedExplosion
Declaration
bool TimedExplosion { get; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
TimedExplosionCulprit
Declaration
IPlayer TimedExplosionCulprit { get; }
Property Value
| Type | Description |
|---|---|
| IPlayer |
TimedExplosionTime
Declaration
uint TimedExplosionTime { get; }
Property Value
| Type | Description |
|---|---|
| System.UInt32 |
TireSmokeColor
The RGBA of the tyre smoke
Declaration
Rgba TireSmokeColor { get; set; }
Property Value
| Type | Description |
|---|---|
| Rgba |
TrainCarriageConfigIndex
Gets or sets the trains carriage config index
Declaration
sbyte TrainCarriageConfigIndex { get; set; }
Property Value
| Type | Description |
|---|---|
| System.SByte |
TrainConfigIndex
Gets or sets the trains config index
Declaration
sbyte TrainConfigIndex { get; set; }
Property Value
| Type | Description |
|---|---|
| System.SByte |
TrainCruiseSpeed
Gets or sets the trains cruise speed
Declaration
float TrainCruiseSpeed { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Single |
TrainDirection
Gets or sets the trains direction
Declaration
bool TrainDirection { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
TrainDistanceFromEngine
Gets or sets the trains distance from the engine
Declaration
float TrainDistanceFromEngine { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Single |
TrainEngine
Gets or sets the trains engine
Declaration
IVehicle TrainEngine { get; set; }
Property Value
| Type | Description |
|---|---|
| IVehicle |
TrainForceDoorsOpen
Gets or sets if the trains doors should be forced open
Declaration
bool TrainForceDoorsOpen { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
TrainLinkedToBackward
Gets or sets the trains vehicle linked backward vehicle
Declaration
IVehicle TrainLinkedToBackward { get; set; }
Property Value
| Type | Description |
|---|---|
| IVehicle |
TrainLinkedToForward
Gets or sets the trains vehicle linked forward vehicle
Declaration
IVehicle TrainLinkedToForward { get; set; }
Property Value
| Type | Description |
|---|---|
| IVehicle |
TrainPassengerCarriages
Gets or sets if the train has passenger carriages
Declaration
bool TrainPassengerCarriages { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
TrainRenderDerailed
Gets or sets if the train should be rendered derailed
Declaration
bool TrainRenderDerailed { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
TrainTrackId
Gets or sets the trains track id
Declaration
sbyte TrainTrackId { get; set; }
Property Value
| Type | Description |
|---|---|
| System.SByte |
Velocity
Gets the vehicles velocity
Declaration
Position Velocity { get; }
Property Value
| Type | Description |
|---|---|
| Position |
WheelColor
Wheel Color
Declaration
byte WheelColor { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Byte |
WheelType
The wheel type
Declaration
byte WheelType { get; }
Property Value
| Type | Description |
|---|---|
| System.Byte |
WheelVariation
The wheel variation, for e.g. bikes only this getter works, RearWheel won't. For most other vehicles this is the FrontWheel variation getter.
Declaration
byte WheelVariation { get; }
Property Value
| Type | Description |
|---|---|
| System.Byte |
WindowTint
The window tint level
Declaration
byte WindowTint { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Byte |
Methods
| Improve this Doc View SourceDoesWheelHasTire(Byte)
Returns if the wheel has a tyre
Declaration
bool DoesWheelHasTire(byte wheelId)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Byte | wheelId | Wheel Id |
Returns
| Type | Description |
|---|---|
| System.Boolean | True = Has tyre |
GetArmoredWindowHealth(Byte)
Returns health of an armored window
Declaration
float GetArmoredWindowHealth(byte windowId)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Byte | windowId | Window Id |
Returns
| Type | Description |
|---|---|
| System.Single | Health level |
GetArmoredWindowShootCount(Byte)
Gets the amount of bullets that has hit the window
Declaration
byte GetArmoredWindowShootCount(byte windowId)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Byte | windowId | Window Id |
Returns
| Type | Description |
|---|---|
| System.Byte | Bullet Count |
GetBumperDamageLevel(Byte)
Gets the damage level for a bumper
Declaration
byte GetBumperDamageLevel(byte bumperId)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Byte | bumperId | 0 - Front, 1 - Rear |
Returns
| Type | Description |
|---|---|
| System.Byte | 0 - Not Damaged / 1 - Damaged / 2 - None |
GetBumperDamageLevelExt(VehicleBumper)
Gets the vehicles bumper damage level
Declaration
virtual VehicleBumperDamage GetBumperDamageLevelExt(VehicleBumper bumper)
Parameters
| Type | Name | Description |
|---|---|---|
| VehicleBumper | bumper | The bumper |
Returns
| Type | Description |
|---|---|
| VehicleBumperDamage | Enum of VehicleBumperDamage |
GetDoorState(Byte)
Returns the state of the door
Declaration
byte GetDoorState(byte doorId)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Byte | doorId | Door Id |
Returns
| Type | Description |
|---|---|
| System.Byte | Door State |
GetDoorStateExt(VehicleDoor)
Returns the current door state of a vehicles door
Declaration
virtual VehicleDoorState GetDoorStateExt(VehicleDoor door)
Parameters
| Type | Name | Description |
|---|---|---|
| VehicleDoor | door | The door |
Returns
| Type | Description |
|---|---|
| VehicleDoorState | The door state |
GetMod(Byte)
Current mod in category
Declaration
byte GetMod(byte category)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Byte | category | Mod Category |
Returns
| Type | Description |
|---|---|
| System.Byte | Current mod |
GetModExt(VehicleModType)
Returns the current mod of the vehicle in the category
Declaration
virtual byte GetModExt(VehicleModType category)
Parameters
| Type | Name | Description |
|---|---|---|
| VehicleModType | category | Mod category |
Returns
| Type | Description |
|---|---|
| System.Byte |
GetModsCount(Byte)
Mod count in Category
Declaration
byte GetModsCount(byte category)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Byte | category | Mod Category |
Returns
| Type | Description |
|---|---|
| System.Byte | Mod count |
GetModsCountExt(VehicleModType)
Returns the amount of mods available in a category
Declaration
virtual byte GetModsCountExt(VehicleModType category)
Parameters
| Type | Name | Description |
|---|---|---|
| VehicleModType | category | The mod type |
Returns
| Type | Description |
|---|---|
| System.Byte |
GetNeonActive(ref Boolean, ref Boolean, ref Boolean, ref Boolean)
Gets the neon active for each area
Declaration
void GetNeonActive(ref bool left, ref bool right, ref bool top, ref bool back)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | left | Left Side |
| System.Boolean | right | Right Side |
| System.Boolean | top | Front Side |
| System.Boolean | back | Rear Side |
GetNumberPlateStyleExt()
Gets the current number plate style
Declaration
virtual NumberPlateStyle GetNumberPlateStyleExt()
Returns
| Type | Description |
|---|---|
| NumberPlateStyle | The number plate style |
GetPartBulletHoles(Byte)
Get the amount of bullet holes for the current part id
Declaration
byte GetPartBulletHoles(byte partId)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Byte | partId | The current part od between 0 and 5 |
Returns
| Type | Description |
|---|---|
| System.Byte | The bullet holes count between 0 and 15 |
GetPartBulletHolesExt(VehiclePart)
Get the amount of bullet holes in a part
Declaration
virtual byte GetPartBulletHolesExt(VehiclePart part)
Parameters
| Type | Name | Description |
|---|---|---|
| VehiclePart | part | The vehicle part |
Returns
| Type | Description |
|---|---|
| System.Byte | Amount of bullet holes |
GetPartDamageLevel(Byte)
Damage level by part
Declaration
byte GetPartDamageLevel(byte partId)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Byte | partId | Part Id |
Returns
| Type | Description |
|---|---|
| System.Byte | Damage Level |
GetPartDamageLevelExt(VehiclePart)
Gets the damage level of a vehicle part
Declaration
virtual VehiclePartDamage GetPartDamageLevelExt(VehiclePart part)
Parameters
| Type | Name | Description |
|---|---|---|
| VehiclePart | part | The part |
Returns
| Type | Description |
|---|---|
| VehiclePartDamage | The VehiclePart damage level |
GetRadioStationExt()
Gets the current radio station
Declaration
virtual RadioStation GetRadioStationExt()
Returns
| Type | Description |
|---|---|
| RadioStation | The radio station |
GetWeaponCapacity(Byte)
Gets the weapon capacity
Declaration
int GetWeaponCapacity(byte index)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Byte | index | Index of weapon |
Returns
| Type | Description |
|---|---|
| System.Int32 |
GetWheelHealth(Byte)
Gets the wheels health
Declaration
float GetWheelHealth(byte wheelId)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Byte | wheelId | Wheel Id |
Returns
| Type | Description |
|---|---|
| System.Single | Wheel health |
GetWindowTintExt()
Gets the current window tint
Declaration
virtual WindowTint GetWindowTintExt()
Returns
| Type | Description |
|---|---|
| WindowTint | The window tint |
IsExtraOn(Byte)
If the vehicle extra is on
Declaration
bool IsExtraOn(byte extraId)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Byte | extraId |
Returns
| Type | Description |
|---|---|
| System.Boolean |
IsLightDamaged(Byte)
Is the light damaged
Declaration
bool IsLightDamaged(byte lightId)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Byte | lightId | Light Id |
Returns
| Type | Description |
|---|---|
| System.Boolean | True = Damaged |
IsSpecialLightDamaged(Byte)
Returns if the special light is damaged
Declaration
bool IsSpecialLightDamaged(byte specialLightId)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Byte | specialLightId | Special light Id |
Returns
| Type | Description |
|---|---|
| System.Boolean | True = Damaged |
IsWheelBurst(Byte)
Is the type burst
Declaration
bool IsWheelBurst(byte wheelId)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Byte | wheelId | Wheel Id |
Returns
| Type | Description |
|---|---|
| System.Boolean | True = Burst |
IsWheelDetached(Byte)
Returns if the wheel is detached
Declaration
bool IsWheelDetached(byte wheelId)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Byte | wheelId | Wheel Id |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if the wheel is detached |
IsWheelOnFire(Byte)
Returns if the wheel is on fire
Declaration
bool IsWheelOnFire(byte wheelId)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Byte | wheelId | Wheel Id |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if the wheel is on fire |
IsWindowDamaged(Byte)
Returns if the window is damaged
Declaration
bool IsWindowDamaged(byte windowId)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Byte | windowId | Window Id |
Returns
| Type | Description |
|---|---|
| System.Boolean | True = Damaged |
IsWindowOpened(Byte)
Returns if the window is opened
Declaration
bool IsWindowOpened(byte windowId)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Byte | windowId | Window Id |
Returns
| Type | Description |
|---|---|
| System.Boolean | True = Open |
Repair()
Repairs the vehicle
Declaration
void Repair()
SetArmoredWindowHealth(Byte, Single)
Sets the armored window health state
Declaration
void SetArmoredWindowHealth(byte windowId, float health)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Byte | windowId | Window Id |
| System.Single | health | State |
SetArmoredWindowShootCount(Byte, Byte)
Sets the amount of bullets that has hit the window
Declaration
void SetArmoredWindowShootCount(byte windowId, byte count)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Byte | windowId | Window Id |
| System.Byte | count | Amount of bullets |
SetBadge(String, String, VehicleBadgePosition[])
Set badges to vehicle
Declaration
void SetBadge(string textureDictionary, string texture, VehicleBadgePosition[] vehicleBadgePosition)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | textureDictionary | The hash of textureDictionary |
| System.String | texture | The hash of texture |
| VehicleBadgePosition[] | vehicleBadgePosition | The array of badge position. Maximum is 4 |
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentOutOfRangeException | When badge postion is more the 4 |
SetBadge(UInt32, UInt32, VehicleBadgePosition[])
Set badges to vehicle
Declaration
void SetBadge(uint textureDictionary, uint texture, VehicleBadgePosition[] vehicleBadgePosition)
Parameters
| Type | Name | Description |
|---|---|---|
| System.UInt32 | textureDictionary | The hash of textureDictionary |
| System.UInt32 | texture | The hash of texture |
| VehicleBadgePosition[] | vehicleBadgePosition | The array of badge position. Maximum is 4 |
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentOutOfRangeException | When badge postion is more the 4 |
SetBumperDamageLevel(Byte, Byte)
Sets the damage level of a bumper
Declaration
void SetBumperDamageLevel(byte bumperId, byte damageLevel)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Byte | bumperId | 0 - Front, 1 - Rear |
| System.Byte | damageLevel | 0 - Not Damaged / 1 - Damaged / 2 - None |
SetBumperDamageLevelExt(VehicleBumper, VehicleBumperDamage)
Sets the vehicles bumper damage level
Declaration
virtual void SetBumperDamageLevelExt(VehicleBumper bumper, VehicleBumperDamage damageLevel)
Parameters
| Type | Name | Description |
|---|---|---|
| VehicleBumper | bumper | The bumper (Front/Rear) |
| VehicleBumperDamage | damageLevel | The Bumper damage level |
SetDoorState(Byte, Byte)
Sets the door state
Declaration
void SetDoorState(byte doorId, byte state)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Byte | doorId | The Door |
| System.Byte | state | The state |
SetDoorStateExt(VehicleDoor, VehicleDoorState)
Sets a vehicles door to a state
Declaration
virtual void SetDoorStateExt(VehicleDoor door, VehicleDoorState state)
Parameters
| Type | Name | Description |
|---|---|---|
| VehicleDoor | door | The door |
| VehicleDoorState | state | The state |
SetLightDamaged(Byte, Boolean)
Sets the light damage state
Declaration
void SetLightDamaged(byte lightId, bool isDamaged)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Byte | lightId | Light Id |
| System.Boolean | isDamaged | True = Damaged |
SetMod(Byte, Byte)
Set Mod
Declaration
bool SetMod(byte category, byte id)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Byte | category | The mod category (slot) |
| System.Byte | id | The mod id |
Returns
| Type | Description |
|---|---|
| System.Boolean | True - Mod was set |
SetModExt(VehicleModType, Byte)
Sets a vehicles mod into a category
Declaration
virtual bool SetModExt(VehicleModType category, byte id)
Parameters
| Type | Name | Description |
|---|---|---|
| VehicleModType | category | The mod category |
| System.Byte | id | The mod id |
Returns
| Type | Description |
|---|---|
| System.Boolean |
SetNeonActive(Boolean, Boolean, Boolean, Boolean)
Sets neon active by side
Declaration
void SetNeonActive(bool left, bool right, bool top, bool back)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | left | Left side |
| System.Boolean | right | Right Side |
| System.Boolean | top | Top Side |
| System.Boolean | back | Back Side |
SetNumberPlateStyleExt(NumberPlateStyle)
Sets the current number plate style
Declaration
virtual void SetNumberPlateStyleExt(NumberPlateStyle numberPlateStyle)
Parameters
| Type | Name | Description |
|---|---|---|
| NumberPlateStyle | numberPlateStyle | The number plate style |
SetPartBulletHoles(Byte, Byte)
Set the amount of bullet holes for the current part id
Declaration
void SetPartBulletHoles(byte partId, byte shootsCount)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Byte | partId | The current part id between 0 and 5 |
| System.Byte | shootsCount | The bullet holes count between 0 and 15 |
SetPartBulletHolesExt(VehiclePart, Byte)
Sets the amount of bullet holes in a vehicles part
Declaration
virtual void SetPartBulletHolesExt(VehiclePart part, byte shootsCount)
Parameters
| Type | Name | Description |
|---|---|---|
| VehiclePart | part | The part |
| System.Byte | shootsCount | The amount of bullets |
SetPartDamageLevel(Byte, Byte)
Sets the damage level of a part
Declaration
void SetPartDamageLevel(byte partId, byte damage)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Byte | partId | Part Id |
| System.Byte | damage | Damage Level |
SetPartDamageLevelExt(VehiclePart, VehiclePartDamage)
Sets the damage level of a vehicle part
Declaration
virtual void SetPartDamageLevelExt(VehiclePart part, VehiclePartDamage damage)
Parameters
| Type | Name | Description |
|---|---|---|
| VehiclePart | part | The vehicle part |
| VehiclePartDamage | damage | The damage level |
SetPartDamageLevelExt(VehiclePart, Byte)
Sets a vehicles part damage
Declaration
virtual void SetPartDamageLevelExt(VehiclePart part, byte damage)
Parameters
| Type | Name | Description |
|---|---|---|
| VehiclePart | part | The vehicle part |
| System.Byte | damage | The damage |
SetRadioStationExt(RadioStation)
Sets the current radio station
Declaration
virtual void SetRadioStationExt(RadioStation radioStation)
Parameters
| Type | Name | Description |
|---|---|---|
| RadioStation | radioStation | The radio station |
SetSearchLight(Boolean, IEntity)
Sets the searchlight to given entity
Declaration
bool SetSearchLight(bool state, IEntity spottedEntity)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | state | |
| IEntity | spottedEntity |
Returns
| Type | Description |
|---|---|
| System.Boolean |
SetSpecialLightDamaged(Byte, Boolean)
Sets the state of the special light damage
Declaration
void SetSpecialLightDamaged(byte specialLightId, bool isDamaged)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Byte | specialLightId | Special Light |
| System.Boolean | isDamaged | Damage |
SetTimedExplosion(Boolean, IPlayer, UInt32)
Declaration
void SetTimedExplosion(bool state, IPlayer culprit, uint time)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | state | |
| IPlayer | culprit | |
| System.UInt32 | time |
SetWeaponCapacity(Byte, Int32)
Sets the weapon capacity
Declaration
void SetWeaponCapacity(byte index, int capacity)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Byte | index | Index of weapon |
| System.Int32 | capacity | Capacity to set |
SetWheelBurst(Byte, Boolean)
Sets a wheels burst state
Declaration
void SetWheelBurst(byte wheelId, bool state)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Byte | wheelId | Wheel Id |
| System.Boolean | state | True = Burst |
SetWheelDetached(Byte, Boolean)
Sets the detached state of the given wheel
Declaration
void SetWheelDetached(byte wheelId, bool state)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Byte | wheelId | Wheel Id |
| System.Boolean | state | True when it should be detached, False when it should be attached |
SetWheelFixed(Byte)
Fix the wheel
Declaration
void SetWheelFixed(byte wheelId)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Byte | wheelId | Wheel Id |
SetWheelHasTire(Byte, Boolean)
Sets if the wheel has a tyre
Declaration
void SetWheelHasTire(byte wheelId, bool state)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Byte | wheelId | Wheel Id |
| System.Boolean | state | True = Has tyre |
SetWheelHealth(Byte, Single)
Sets the wheels healthy
Declaration
void SetWheelHealth(byte wheelId, float health)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Byte | wheelId | Wheel Id |
| System.Single | health | Health |
SetWheelOnFire(Byte, Boolean)
Sets the fire state of the given wheel
Declaration
void SetWheelOnFire(byte wheelId, bool state)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Byte | wheelId | Wheel Id |
| System.Boolean | state | True when it should be on fire, False when it should not be on fire |
SetWheels(Byte, Byte)
Sets the wheels type and variation
Declaration
void SetWheels(byte type, byte variation)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Byte | type | Wheel Type |
| System.Byte | variation | Wheel variation |
SetWindowDamaged(Byte, Boolean)
Sets the window damage state
Declaration
void SetWindowDamaged(byte windowId, bool isDamaged)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Byte | windowId | Window Id |
| System.Boolean | isDamaged | True = Damaged |
SetWindowOpened(Byte, Boolean)
Sets the window status
Declaration
void SetWindowOpened(byte windowId, bool state)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Byte | windowId | Window Id |
| System.Boolean | state | True = Open |
SetWindowTintExt(WindowTint)
Sets the current window tint
Declaration
virtual void SetWindowTintExt(WindowTint windowTint)
Parameters
| Type | Name | Description |
|---|---|---|
| WindowTint | windowTint | The window tint |
ToggleExtra(Byte, Boolean)
Toggles the vehicle extra
Declaration
void ToggleExtra(byte extraId, bool state)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Byte | extraId | Extra Id |
| System.Boolean | state | True - Enabled |