Class Vehicle

A vehicle element Vehicle elements represent ingame vehicles such as cars, bikes, airplanes, etc. Vechicles are synchronised by clients, usually by the driver, but when unoccupied by a player in close vincinity.

Inheritance
object
Element
Vehicle
Inherited Members
Namespace: SlipeServer.Server.Elements
Assembly: SlipeServer.Server.dll
Syntax
public class Vehicle : Element

Constructors

| Edit this page View Source

Vehicle(VehicleModel, Vector3)

Declaration
public Vehicle(VehicleModel model, Vector3 position)
Parameters
Type Name Description
VehicleModel model
Vector3 position
| Edit this page View Source

Vehicle(ushort, Vector3)

Declaration
public Vehicle(ushort model, Vector3 position)
Parameters
Type Name Description
ushort model
Vector3 position

Fields

| Edit this page View Source

CanEnter

Declaration
public Func<Ped, Vehicle, byte, bool>? CanEnter
Field Value
Type Description
Func<Ped, Vehicle, byte, bool>
| Edit this page View Source

CanExit

Declaration
public Func<Ped, Vehicle, byte, bool>? CanExit
Field Value
Type Description
Func<Ped, Vehicle, byte, bool>
| Edit this page View Source

model

Declaration
protected ushort model
Field Value
Type Description
ushort
| Edit this page View Source

paintJob

Declaration
protected byte paintJob
Field Value
Type Description
byte

Properties

| Edit this page View Source

AdjustableProperty

Declaration
public ushort? AdjustableProperty { get; set; }
Property Value
Type Description
ushort?
| Edit this page View Source

AppliedHandling

Declaration
public VehicleHandling AppliedHandling { get; }
Property Value
Type Description
VehicleHandling
| Edit this page View Source

AreDoorsDamageProof

Declaration
public bool AreDoorsDamageProof { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

BlownState

Declaration
public VehicleBlownState BlownState { get; set; }
Property Value
Type Description
VehicleBlownState
| Edit this page View Source

Colors

Declaration
public Colors Colors { get; }
Property Value
Type Description
Colors
| Edit this page View Source

Damage

Declaration
public VehicleDamage Damage { get; init; }
Property Value
Type Description
VehicleDamage
| Edit this page View Source

DefaultHandling

Declaration
public VehicleHandling DefaultHandling { get; }
Property Value
Type Description
VehicleHandling
| Edit this page View Source

DoorRatios

Declaration
public float[] DoorRatios { get; set; }
Property Value
Type Description
float[]
| Edit this page View Source

Driver

Declaration
public Ped? Driver { get; set; }
Property Value
Type Description
Ped
| Edit this page View Source

ElementType

The element type as per MTA's specifications. Multiple C# types can share the same MTA element type.

Declaration
public override ElementType ElementType { get; }
Property Value
Type Description
ElementType
Overrides
| Edit this page View Source

Handling

Declaration
public VehicleHandling? Handling { get; set; }
Property Value
Type Description
VehicleHandling?
| Edit this page View Source

HeadlightColor

Declaration
public Color HeadlightColor { get; set; }
Property Value
Type Description
Color
| Edit this page View Source

Health

Declaration
public float Health { get; set; }
Property Value
Type Description
float
| Edit this page View Source

IsDamageProof

Declaration
public bool IsDamageProof { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

IsDerailable

Declaration
public bool IsDerailable { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

IsDerailed

Declaration
public bool IsDerailed { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

IsEngineOn

Declaration
public bool IsEngineOn { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

IsFuelTankExplodable

Declaration
public bool IsFuelTankExplodable { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

IsInWater

Declaration
public bool IsInWater { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

IsLandingGearDown

Declaration
public bool IsLandingGearDown { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

IsLocked

Declaration
public bool IsLocked { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

IsSirenActive

Declaration
public bool IsSirenActive { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

IsTaxiLightOn

Declaration
public bool IsTaxiLightOn { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

IsTrailer

Declaration
public bool IsTrailer { get; }
Property Value
Type Description
bool
| Edit this page View Source

JackingPed

Declaration
public Ped? JackingPed { get; set; }
Property Value
Type Description
Ped
| Edit this page View Source

Model

Declaration
public ushort Model { get; set; }
Property Value
Type Description
ushort
| Edit this page View Source

Occupants

Declaration
public IReadOnlyDictionary<byte, Ped> Occupants { get; }
Property Value
Type Description
IReadOnlyDictionary<byte, Ped>
| Edit this page View Source

OverrideLights

Declaration
public VehicleOverrideLights OverrideLights { get; set; }
Property Value
Type Description
VehicleOverrideLights
| Edit this page View Source

PaintJob

Declaration
public byte PaintJob { get; set; }
Property Value
Type Description
byte
| Edit this page View Source

PlateText

Declaration
public string PlateText { get; set; }
Property Value
Type Description
string
| Edit this page View Source

RespawnHealth

Declaration
public float RespawnHealth { get; set; }
Property Value
Type Description
float
| Edit this page View Source

RespawnPosition

Declaration
public Vector3 RespawnPosition { get; set; }
Property Value
Type Description
Vector3
| Edit this page View Source

RespawnRotation

Declaration
public Vector3 RespawnRotation { get; set; }
Property Value
Type Description
Vector3
| Edit this page View Source

Sirens

Declaration
public VehicleSirenSet? Sirens { get; set; }
Property Value
Type Description
VehicleSirenSet?
| Edit this page View Source

Syncer

Declaration
public Player? Syncer { get; set; }
Property Value
Type Description
Player
| Edit this page View Source

TowedVehicle

Vehicle that is being towed by this vehicle

Declaration
public Vehicle? TowedVehicle { get; }
Property Value
Type Description
Vehicle
| Edit this page View Source

TowingChainHead

Vehicle at the very front of a chain of towing vehicles

Declaration
public Vehicle? TowingChainHead { get; }
Property Value
Type Description
Vehicle
| Edit this page View Source

TowingVehicle

Vehicle that is towing this vehicle

Declaration
public Vehicle? TowingVehicle { get; }
Property Value
Type Description
Vehicle
| Edit this page View Source

TrainDirection

Declaration
public TrainDirection TrainDirection { get; set; }
Property Value
Type Description
TrainDirection
| Edit this page View Source

TurretRotation

Declaration
public Vector2? TurretRotation { get; set; }
Property Value
Type Description
Vector2?
| Edit this page View Source

Upgrades

Declaration
public VehicleUpgrades Upgrades { get; }
Property Value
Type Description
VehicleUpgrades
| Edit this page View Source

Variants

Declaration
public VehicleVariants Variants { get; set; }
Property Value
Type Description
VehicleVariants
| Edit this page View Source

VehicleType

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

Methods

| Edit this page View Source

AddPassenger(byte, Ped, bool)

Declaration
public void AddPassenger(byte seat, Ped ped, bool warpsIn = true)
Parameters
Type Name Description
byte seat
Ped ped
bool warpsIn
| Edit this page View Source

AssociateWith(MtaServer)

Declaration
public Vehicle AssociateWith(MtaServer server)
Parameters
Type Name Description
MtaServer server
Returns
Type Description
Vehicle
| Edit this page View Source

AttachToTower(Vehicle?, bool)

Declaration
public void AttachToTower(Vehicle? tower, bool updateCounterpart = true)
Parameters
Type Name Description
Vehicle tower
bool updateCounterpart
| Edit this page View Source

AttachTrailer(Vehicle?, bool)

Declaration
public void AttachTrailer(Vehicle? trailer, bool updateCounterpart = true)
Parameters
Type Name Description
Vehicle trailer
bool updateCounterpart
| Edit this page View Source

BlowUp(bool)

Declaration
public void BlowUp(bool createExplosion = true)
Parameters
Type Name Description
bool createExplosion
| Edit this page View Source

Destroy()

Destroys the element, triggering the Destroyed event.

Declaration
public override bool Destroy()
Returns
Type Description
bool

A bool indicating whether the element is destroyed, false if it was already destroyed prior to this call.
Overrides
| Edit this page View Source

DetachFromTower(bool)

Declaration
public void DetachFromTower(bool updateCounterpart = true)
Parameters
Type Name Description
bool updateCounterpart
| Edit this page View Source

DetachTrailer(bool)

Declaration
public void DetachTrailer(bool updateCounterpart = true)
Parameters
Type Name Description
bool updateCounterpart
| Edit this page View Source

Fix()

Declaration
public void Fix()
| Edit this page View Source

GetDoorOpenRatio(VehicleDoor)

Declaration
public float GetDoorOpenRatio(VehicleDoor door)
Parameters
Type Name Description
VehicleDoor door
Returns
Type Description
float
| Edit this page View Source

GetDoorState(VehicleDoor)

Declaration
public VehicleDoorState GetDoorState(VehicleDoor door)
Parameters
Type Name Description
VehicleDoor door
Returns
Type Description
VehicleDoorState
| Edit this page View Source

GetFreePassengerSeat()

Declaration
public byte? GetFreePassengerSeat()
Returns
Type Description
byte?
| Edit this page View Source

GetLightState(VehicleLight)

Declaration
public VehicleLightState GetLightState(VehicleLight light)
Parameters
Type Name Description
VehicleLight light
Returns
Type Description
VehicleLightState
| Edit this page View Source

GetMaxPassengers()

Declaration
public byte GetMaxPassengers()
Returns
Type Description
byte
| Edit this page View Source

GetOccupantInSeat(byte)

Declaration
public Ped? GetOccupantInSeat(byte seat)
Parameters
Type Name Description
byte seat
Returns
Type Description
Ped
| Edit this page View Source

GetPanelState(VehiclePanel)

Declaration
public VehiclePanelState GetPanelState(VehiclePanel panel)
Parameters
Type Name Description
VehiclePanel panel
Returns
Type Description
VehiclePanelState
| Edit this page View Source

GetWheelState(VehicleWheel)

Declaration
public VehicleWheelState GetWheelState(VehicleWheel wheel)
Parameters
Type Name Description
VehicleWheel wheel
Returns
Type Description
VehicleWheelState
| Edit this page View Source

Jack(Ped, Ped)

Declaration
public void Jack(Ped previousDriver, Ped newDriver)
Parameters
Type Name Description
Ped previousDriver
Ped newDriver
| Edit this page View Source

RemovePassenger(Ped, bool)

Declaration
public void RemovePassenger(Ped ped, bool warpsOut = true)
Parameters
Type Name Description
Ped ped
bool warpsOut
| Edit this page View Source

ResetDoorsWheelsPanelsLights()

Declaration
public void ResetDoorsWheelsPanelsLights()
| Edit this page View Source

Respawn()

Declaration
public void Respawn()
| Edit this page View Source

SetDoorOpenRatio(VehicleDoor, float, uint)

Declaration
public void SetDoorOpenRatio(VehicleDoor door, float ratio, uint time = 0)
Parameters
Type Name Description
VehicleDoor door
float ratio
uint time
| Edit this page View Source

SetDoorState(VehicleDoor, VehicleDoorState, bool)

Declaration
public void SetDoorState(VehicleDoor door, VehicleDoorState state, bool spawnFlyingComponent = false)
Parameters
Type Name Description
VehicleDoor door
VehicleDoorState state
bool spawnFlyingComponent
| Edit this page View Source

SetLightState(VehicleLight, VehicleLightState)

Declaration
public void SetLightState(VehicleLight light, VehicleLightState state)
Parameters
Type Name Description
VehicleLight light
VehicleLightState state
| Edit this page View Source

SetPanelState(VehiclePanel, VehiclePanelState)

Declaration
public void SetPanelState(VehiclePanel panel, VehiclePanelState state)
Parameters
Type Name Description
VehiclePanel panel
VehiclePanelState state
| Edit this page View Source

SetWheelState(VehicleWheel, VehicleWheelState)

Declaration
public void SetWheelState(VehicleWheel wheel, VehicleWheelState state)
Parameters
Type Name Description
VehicleWheel wheel
VehicleWheelState state
| Edit this page View Source

Spawn(Vector3, Vector3)

Declaration
public void Spawn(Vector3 position, Vector3 rotation)
Parameters
Type Name Description
Vector3 position
Vector3 rotation
| Edit this page View Source

TriggerPushed(Player)

Declaration
public void TriggerPushed(Player player)
Parameters
Type Name Description
Player player

Events

| Edit this page View Source

AreDoorsDamageProofChanged

Declaration
public event ElementChangedEventHandler<Vehicle, bool>? AreDoorsDamageProofChanged
Event Type
Type Description
ElementChangedEventHandler<Vehicle, bool>
| Edit this page View Source

AreSirensOnChanged

Declaration
public event ElementChangedEventHandler<Vehicle, bool>? AreSirensOnChanged
Event Type
Type Description
ElementChangedEventHandler<Vehicle, bool>
| Edit this page View Source

Blown

Declaration
public event ElementEventHandler<VehicleBlownEventArgs>? Blown
Event Type
Type Description
ElementEventHandler<VehicleBlownEventArgs>
| Edit this page View Source

ColorChanged

Declaration
public event ElementEventHandler<Vehicle, VehicleColorChangedEventsArgs>? ColorChanged
Event Type
Type Description
ElementEventHandler<Vehicle, VehicleColorChangedEventsArgs>
| Edit this page View Source

DoorOpenRatioChanged

Declaration
public event ElementEventHandler<VehicleDoorOpenRatioChangedArgs>? DoorOpenRatioChanged
Event Type
Type Description
ElementEventHandler<VehicleDoorOpenRatioChangedArgs>
| Edit this page View Source

DoorStateChanged

Declaration
public event ElementEventHandler<VehicleDoorStateChangedArgs>? DoorStateChanged
Event Type
Type Description
ElementEventHandler<VehicleDoorStateChangedArgs>
| Edit this page View Source

EngineStateChanged

Declaration
public event ElementChangedEventHandler<Vehicle, bool>? EngineStateChanged
Event Type
Type Description
ElementChangedEventHandler<Vehicle, bool>
| Edit this page View Source

Fixed

Declaration
public event ElementEventHandler<VehicleFixedEventArgs>? Fixed
Event Type
Type Description
ElementEventHandler<VehicleFixedEventArgs>
| Edit this page View Source

FuelTankExplodableChanged

Declaration
public event ElementChangedEventHandler<Vehicle, bool>? FuelTankExplodableChanged
Event Type
Type Description
ElementChangedEventHandler<Vehicle, bool>
| Edit this page View Source

HandlingChanged

Declaration
public event ElementChangedEventHandler<Vehicle, VehicleHandling?>? HandlingChanged
Event Type
Type Description
ElementChangedEventHandler<Vehicle, VehicleHandling?>
| Edit this page View Source

HeadlightColorChanged

Declaration
public event ElementChangedEventHandler<Vehicle, Color>? HeadlightColorChanged
Event Type
Type Description
ElementChangedEventHandler<Vehicle, Color>
| Edit this page View Source

HealthChanged

Declaration
public event ElementChangedEventHandler<Vehicle, float>? HealthChanged
Event Type
Type Description
ElementChangedEventHandler<Vehicle, float>
| Edit this page View Source

IsDamageProofChanged

Declaration
public event ElementChangedEventHandler<Vehicle, bool>? IsDamageProofChanged
Event Type
Type Description
ElementChangedEventHandler<Vehicle, bool>
| Edit this page View Source

IsDerailableChanged

Declaration
public event ElementChangedEventHandler<Vehicle, bool>? IsDerailableChanged
Event Type
Type Description
ElementChangedEventHandler<Vehicle, bool>
| Edit this page View Source

IsDerailedChanged

Declaration
public event ElementChangedEventHandler<Vehicle, bool>? IsDerailedChanged
Event Type
Type Description
ElementChangedEventHandler<Vehicle, bool>
| Edit this page View Source

IsInWaterChanged

Declaration
public event ElementChangedEventHandler<Vehicle, bool>? IsInWaterChanged
Event Type
Type Description
ElementChangedEventHandler<Vehicle, bool>
| Edit this page View Source

Jacked

Declaration
public event ElementEventHandler<Vehicle, VehicleJackedEventArgs>? Jacked
Event Type
Type Description
ElementEventHandler<Vehicle, VehicleJackedEventArgs>
| Edit this page View Source

LandingGearChanged

Declaration
public event ElementChangedEventHandler<Vehicle, bool>? LandingGearChanged
Event Type
Type Description
ElementChangedEventHandler<Vehicle, bool>
| Edit this page View Source

LightStateChanged

Declaration
public event ElementEventHandler<VehicleLightStateChangedArgs>? LightStateChanged
Event Type
Type Description
ElementEventHandler<VehicleLightStateChangedArgs>
| Edit this page View Source

LockedStateChanged

Declaration
public event ElementChangedEventHandler<Vehicle, bool>? LockedStateChanged
Event Type
Type Description
ElementChangedEventHandler<Vehicle, bool>
| Edit this page View Source

ModelChanged

Declaration
public event ElementChangedEventHandler<Vehicle, ushort>? ModelChanged
Event Type
Type Description
ElementChangedEventHandler<Vehicle, ushort>
| Edit this page View Source

OverrideLightsChanged

Declaration
public event ElementChangedEventHandler<Vehicle, VehicleOverrideLights>? OverrideLightsChanged
Event Type
Type Description
ElementChangedEventHandler<Vehicle, VehicleOverrideLights>
| Edit this page View Source

PaintJobChanged

Declaration
public event ElementChangedEventHandler<Vehicle, byte>? PaintJobChanged
Event Type
Type Description
ElementChangedEventHandler<Vehicle, byte>
| Edit this page View Source

PanelStateChanged

Declaration
public event ElementEventHandler<VehiclePanelStateChangedArgs>? PanelStateChanged
Event Type
Type Description
ElementEventHandler<VehiclePanelStateChangedArgs>
| Edit this page View Source

PedEntered

Declaration
public event ElementEventHandler<VehicleEnteredEventsArgs>? PedEntered
Event Type
Type Description
ElementEventHandler<VehicleEnteredEventsArgs>
| Edit this page View Source

PedLeft

Declaration
public event ElementEventHandler<VehicleLeftEventArgs>? PedLeft
Event Type
Type Description
ElementEventHandler<VehicleLeftEventArgs>
| Edit this page View Source

PlateTextChanged

Declaration
public event ElementChangedEventHandler<Vehicle, string>? PlateTextChanged
Event Type
Type Description
ElementChangedEventHandler<Vehicle, string>
| Edit this page View Source

Pushed

Declaration
public event ElementEventHandler<Vehicle, VehiclePushedEventArgs>? Pushed
Event Type
Type Description
ElementEventHandler<Vehicle, VehiclePushedEventArgs>
| Edit this page View Source

Respawned

Declaration
public event ElementEventHandler<VehicleRespawnEventArgs>? Respawned
Event Type
Type Description
ElementEventHandler<VehicleRespawnEventArgs>
| Edit this page View Source

SirenUpdated

Declaration
public event ElementEventHandler<Vehicle, VehicleSirenUpdatedEventArgs>? SirenUpdated
Event Type
Type Description
ElementEventHandler<Vehicle, VehicleSirenUpdatedEventArgs>
| Edit this page View Source

SirensChanged

Declaration
public event ElementChangedEventHandler<Vehicle, VehicleSirenSet?>? SirensChanged
Event Type
Type Description
ElementChangedEventHandler<Vehicle, VehicleSirenSet?>
| Edit this page View Source

SyncerChanged

Declaration
public event ElementChangedEventHandler<Vehicle, Player?>? SyncerChanged
Event Type
Type Description
ElementChangedEventHandler<Vehicle, Player>
| Edit this page View Source

TaxiLightStateChanged

Declaration
public event ElementChangedEventHandler<Vehicle, bool>? TaxiLightStateChanged
Event Type
Type Description
ElementChangedEventHandler<Vehicle, bool>
| Edit this page View Source

TowedVehicleChanged

Declaration
public event ElementChangedEventHandler<Vehicle, Vehicle?>? TowedVehicleChanged
Event Type
Type Description
ElementChangedEventHandler<Vehicle, Vehicle>
| Edit this page View Source

TowingVehicleChanged

Declaration
public event ElementChangedEventHandler<Vehicle, Vehicle?>? TowingVehicleChanged
Event Type
Type Description
ElementChangedEventHandler<Vehicle, Vehicle>
| Edit this page View Source

TrainDirectionChanged

Declaration
public event ElementChangedEventHandler<Vehicle, TrainDirection>? TrainDirectionChanged
Event Type
Type Description
ElementChangedEventHandler<Vehicle, TrainDirection>
| Edit this page View Source

TurretRotationChanged

Declaration
public event ElementChangedEventHandler<Vehicle, Vector2?>? TurretRotationChanged
Event Type
Type Description
ElementChangedEventHandler<Vehicle, Vector2?>
| Edit this page View Source

UpgradeChanged

Declaration
public event ElementEventHandler<Vehicle, VehicleUpgradeChanged>? UpgradeChanged
Event Type
Type Description
ElementEventHandler<Vehicle, VehicleUpgradeChanged>
| Edit this page View Source

VariantsChanged

Declaration
public event ElementChangedEventHandler<Vehicle, VehicleVariants>? VariantsChanged
Event Type
Type Description
ElementChangedEventHandler<Vehicle, VehicleVariants>
| Edit this page View Source

WheelStateChanged

Declaration
public event ElementEventHandler<VehicleWheelStateChangedArgs>? WheelStateChanged
Event Type
Type Description
ElementEventHandler<VehicleWheelStateChangedArgs>

Extension Methods