Class Vehicle

Hierarchy

Entity
- Vehicle

Index

Constructors

Properties

Methods

delete getLastPedInSeat getPedInSeat isExtraTurnedOn isTyreBurst fromHandle fromNetworkId

Constructors

constructor

new Vehicle(handle: number): Vehicle
Parameters
- handle: number
Returns Vehicle
Overrides Entity.constructor
- Defined in entities/Vehicle.ts:12

Properties

`Protected` handle

handle: number

`Protected` type

type: ClassTypes = ClassTypes.Vehicle

Accessors

AttachedTo

get AttachedTo(): EntityType
Returns EntityType
Inherited from Entity.AttachedTo
- Defined in entities/Entity.ts:35

BodyHealth

get BodyHealth(): number
Returns number
- Defined in entities/Vehicle.ts:35

CustomPrimaryColour

get CustomPrimaryColour(): Color
Returns Color
- Defined in entities/Vehicle.ts:43

CustomSecondaryColour

get CustomSecondaryColour(): Color
Returns Color
- Defined in entities/Vehicle.ts:47

DashboardColour

get DashboardColour(): number
Returns number
- Defined in entities/Vehicle.ts:51

DirtLevel

get DirtLevel(): number
Returns number
- Defined in entities/Vehicle.ts:55

DoorStatus

get DoorStatus(): number
Returns number
- Defined in entities/Vehicle.ts:63

DoorsLockedForPlayer

get DoorsLockedForPlayer(): number
Returns number
- Defined in entities/Vehicle.ts:67

EngineHealth

get EngineHealth(): number
Returns number
- Defined in entities/Vehicle.ts:71

Exists

get Exists(): boolean
Returns boolean
Inherited from Entity.Exists
- Defined in entities/Entity.ts:31

ExtraColours

get ExtraColours(): [number, number]
Returns [number, number]
- Defined in entities/Vehicle.ts:75

FlightNozzlePosition

get FlightNozzlePosition(): number
Returns number
- Defined in entities/Vehicle.ts:79

Handbrake

get Handbrake(): boolean
Returns boolean
- Defined in entities/Vehicle.ts:83

Handle

get Handle(): number
Returns number
Inherited from Entity.Handle
- Defined in entities/Entity.ts:27

HasBeenOwnedByPlayer

get HasBeenOwnedByPlayer(): boolean
Returns boolean
- Defined in entities/Vehicle.ts:153

Heading

get Heading(): number
Returns number
Inherited from Entity.Heading
- Defined in entities/Entity.ts:43

HeadlightsColour

get HeadlightsColour(): number
Returns number
- Defined in entities/Vehicle.ts:87

Health

get Health(): number
Returns number
Inherited from Entity.Health
- Defined in entities/Entity.ts:51

HomingLockonState

get HomingLockonState(): number
Returns number
- Defined in entities/Vehicle.ts:91

InteriorColour

get InteriorColour(): number
Returns number
- Defined in entities/Vehicle.ts:95

IsEngineRunning

get IsEngineRunning(): boolean
Returns boolean
- Defined in entities/Vehicle.ts:23

IsEngineStarting

get IsEngineStarting(): boolean
Returns boolean
- Defined in entities/Vehicle.ts:157

IsNoLongerNeeded

get IsNoLongerNeeded(): boolean
Returns boolean
Inherited from Entity.IsNoLongerNeeded
- Defined in entities/Entity.ts:113

IsPrimaryColourCustom

get IsPrimaryColourCustom(): boolean
Returns boolean
- Defined in entities/Vehicle.ts:27

IsSecondaryColourCuston

get IsSecondaryColourCuston(): boolean
Returns boolean
- Defined in entities/Vehicle.ts:31

IsSirenOn

get IsSirenOn(): boolean
Returns boolean
- Defined in entities/Vehicle.ts:161

IsVisible

get IsVisible(): boolean
Returns boolean
Inherited from Entity.IsVisible
- Defined in entities/Entity.ts:105

LightsState

get LightsState(): [boolean, boolean]
Returns [boolean, boolean]
- Defined in entities/Vehicle.ts:99

Livery

get Livery(): number
Returns number
- Defined in entities/Vehicle.ts:105

LockOnTarget

get LockOnTarget(): Vehicle
Returns Vehicle
- Defined in entities/Vehicle.ts:109

LockStatus

get LockStatus(): VehicleLockStatus
Returns VehicleLockStatus
- Defined in entities/Vehicle.ts:59

MainRotorHealth

get MainRotorHealth(): number
Returns number
- Defined in entities/Vehicle.ts:177

MaxHealth

get MaxHealth(): number
Returns number
Overrides Entity.MaxHealth
- Defined in entities/Vehicle.ts:165

Model

get Model(): number
Returns number
Inherited from Entity.Model
- Defined in entities/Entity.ts:59

NetworkId

get NetworkId(): number
Returns number
Inherited from Entity.NetworkId
- Defined in entities/Entity.ts:109

Owner

get Owner(): Player
Returns Player
Inherited from Entity.Owner
- Defined in entities/Entity.ts:101

PetrolTankHealth

get PetrolTankHealth(): number
Returns number
- Defined in entities/Vehicle.ts:121

Plate

get Plate(): string
Returns string
- Defined in entities/Vehicle.ts:113

PlateIndex

get PlateIndex(): number
Returns number
- Defined in entities/Vehicle.ts:117

PopulationType

get PopulationType(): PopulationType
Returns PopulationType
Inherited from Entity.PopulationType
- Defined in entities/Entity.ts:63

Position

get Position(): Vector3
Returns Vector3
Inherited from Entity.Position
- Defined in entities/Entity.ts:39

PositionAndHeading

get PositionAndHeading(): Vector4
Returns Vector4
Inherited from Entity.PositionAndHeading
- Defined in entities/Entity.ts:47

RadioStation

get RadioStation(): number
Returns number
- Defined in entities/Vehicle.ts:125

RoofLivery

get RoofLivery(): number
Returns number
- Defined in entities/Vehicle.ts:129

Rotation

get Rotation(): Vector3
Returns Vector3
Inherited from Entity.Rotation
- Defined in entities/Entity.ts:67

RotationVelocity

get RotationVelocity(): Vector3
Returns Vector3
Inherited from Entity.RotationVelocity
- Defined in entities/Entity.ts:71

RoutingBucket

get RoutingBucket(): number
Returns number
Inherited from Entity.RoutingBucket
- Defined in entities/Entity.ts:75

Script

get Script(): string
Returns
The script that made the entity

Returns string
Inherited from Entity.Script
- Defined in entities/Entity.ts:82

ScriptTaskCommand

get ScriptTaskCommand(): number
Returns number
- Defined in entities/Vehicle.ts:169

ScriptTaskStage

get ScriptTaskStage(): number
Returns number
- Defined in entities/Vehicle.ts:173

Speed

get Speed(): number
Returns number
Inherited from Entity.Speed
- Defined in entities/Entity.ts:86

State

get State(): StateBagInterface
Returns StateBagInterface
Inherited from Entity.State
- Defined in entities/Entity.ts:23

SteeringAngle

get SteeringAngle(): number
Returns number
- Defined in entities/Vehicle.ts:133

TailRotorHealth

get TailRotorHealth(): number
Returns number
- Defined in entities/Vehicle.ts:181

TrainCarriageEngine

get TrainCarriageEngine(): number
This might supposed to be TrainEngineHealth?

Returns number
- Defined in entities/Vehicle.ts:188

TrainCarriageIndex

get TrainCarriageIndex(): number
Returns number
- Defined in entities/Vehicle.ts:192

Type

get Type(): eEntityType
Returns eEntityType
Inherited from Entity.Type
- Defined in entities/Entity.ts:90

TyreSmokeColour

get TyreSmokeColour(): Color
Returns Color
- Defined in entities/Vehicle.ts:141

VehicleColours

get VehicleColours(): [number, number]
Returns [number, number]
- Defined in entities/Vehicle.ts:39

VehicleType

get VehicleType(): VehicleType
Returns VehicleType
- Defined in entities/Vehicle.ts:137

Velocity

get Velocity(): Vector3
Returns
the entitys velocity, if the entity is a ped it will return Vector3(0, 0, 0)

Returns Vector3
Inherited from Entity.Velocity
- Defined in entities/Entity.ts:97

WheelType

get WheelType(): number
Returns number
- Defined in entities/Vehicle.ts:145

WindowTint

get WindowTint(): number
Returns number
- Defined in entities/Vehicle.ts:149

Methods

delete

delete(): void
Returns void
Inherited from Entity.delete
- Defined in entities/Entity.ts:117

getLastPedInSeat

getLastPedInSeat(seatIndex: number): Ped
Parameters
- seatIndex: number
Returns Ped
- Defined in entities/Vehicle.ts:208

getPedInSeat

getPedInSeat(seatIndex: number): Ped
Parameters
- seatIndex: number
Returns Ped
- Defined in entities/Vehicle.ts:204

isExtraTurnedOn

isExtraTurnedOn(extraId: number): boolean
Parameters
- extraId: number
Returns boolean
- Defined in entities/Vehicle.ts:200

isTyreBurst

isTyreBurst(wheelId: number, completely: boolean): boolean
Parameters
- wheelId: number
- completely: boolean
Returns boolean
- Defined in entities/Vehicle.ts:196

`Static` fromHandle

fromHandle(handle: number): Entity
Parameters
- handle: number
Returns Entity
Overrides Entity.fromHandle
- Defined in entities/Vehicle.ts:19

`Static` fromNetworkId

fromNetworkId(netId: number): Vehicle
Parameters
- netId: number
Returns Vehicle
Overrides Entity.fromNetworkId
- Defined in entities/Vehicle.ts:15

Generated using TypeDoc