Class Vehicle

Hierarchy (View Summary)

Entity
- Vehicle

Constructors

constructor

new Vehicle(_handle: number): Vehicle
Parameters
- _handle: number
Returns Vehicle
Inherited from Entity.constructor
- Defined in client/entities/entity.ts:6

Properties

`Protected`_handle

_handle: number

Accessors

bodyHealth

get bodyHealth(): number
Returns number
- Defined in client/entities/vehicle.ts:40
set bodyHealth(v: number): void
Parameters
- v: number
Returns void
- Defined in client/entities/vehicle.ts:44

class

get class(): number
Returns number
- Defined in client/entities/vehicle.ts:16

colours

get colours(): [number, number]
Returns [number, number]
- Defined in client/entities/vehicle.ts:128

currentGear

get currentGear(): number
Returns number
- Defined in client/entities/vehicle.ts:12

dirtLevel

get dirtLevel(): number
Returns number
- Defined in client/entities/vehicle.ts:112
set dirtLevel(v: number): void
Parameters
- v: number
Returns void
- Defined in client/entities/vehicle.ts:116

driver

get driver(): number
Returns number
- Defined in client/entities/vehicle.ts:24

engineHealth

get engineHealth(): number
Returns number
- Defined in client/entities/vehicle.ts:48
set engineHealth(v: number): void
Parameters
- v: number
Returns void
- Defined in client/entities/vehicle.ts:52

engineOn

set engineOn(on: boolean): void
Parameters
- on: boolean
Returns void
- Defined in client/entities/vehicle.ts:76

engineRunning

get engineRunning(): boolean
Returns boolean
- Defined in client/entities/vehicle.ts:72

exists

get exists(): boolean
Returns boolean
Inherited from Entity.exists
- Defined in client/entities/entity.ts:12

fuelLevel

get fuelLevel(): number
Returns number
- Defined in client/entities/vehicle.ts:64
set fuelLevel(v: number): void
Parameters
- v: number
Returns void
- Defined in client/entities/vehicle.ts:68

handle

get handle(): number
Returns number
Inherited from Entity.handle
- Defined in client/entities/entity.ts:8

heading

get heading(): number
Returns number
Inherited from Entity.heading
- Defined in client/entities/entity.ts:44
set heading(v: number): void
Parameters
- v: number
Returns void
Inherited from Entity.heading
- Defined in client/entities/entity.ts:48

health

get health(): number
Returns number
Inherited from Entity.health
- Defined in client/entities/entity.ts:52
set health(v: number): void
Parameters
- v: number
Returns void
Inherited from Entity.health
- Defined in client/entities/entity.ts:56

isNetworked

get isNetworked(): boolean
Returns boolean
Inherited from Entity.isNetworked
- Defined in client/entities/entity.ts:20

livery

get livery(): number
Returns number
- Defined in client/entities/vehicle.ts:104
set livery(index: number): void
Parameters
- index: number
Returns void
- Defined in client/entities/vehicle.ts:108

locked

get locked(): boolean
Returns boolean
- Defined in client/entities/vehicle.ts:180

maxPassengers

get maxPassengers(): number
Returns number
- Defined in client/entities/vehicle.ts:36

maxSpeed

get maxSpeed(): number
Returns number
- Defined in client/entities/vehicle.ts:8

model

get model(): number
Returns number
Inherited from Entity.model
- Defined in client/entities/entity.ts:16

netId

get netId(): number
Returns number
Inherited from Entity.netId
- Defined in client/entities/entity.ts:24

numberPlate

get numberPlate(): string
Returns string
- Defined in client/entities/vehicle.ts:96
set numberPlate(text: string): void
Parameters
- text: string
Returns void
- Defined in client/entities/vehicle.ts:100

position

get position(): Vector3
Returns Vector3
Inherited from Entity.position
- Defined in client/entities/entity.ts:28
set position(v: IVector3): void
Parameters
- v: IVector3
Returns void
Inherited from Entity.position
- Defined in client/entities/entity.ts:32

rotation

get rotation(): Vector3
Returns Vector3
Inherited from Entity.rotation
- Defined in client/entities/entity.ts:36
set rotation(v: IVector3): void
Parameters
- v: IVector3
Returns void
Inherited from Entity.rotation
- Defined in client/entities/entity.ts:40

speed

get speed(): number
Returns number
- Defined in client/entities/vehicle.ts:4

tankHealth

get tankHealth(): number
Returns number
- Defined in client/entities/vehicle.ts:56
set tankHealth(v: number): void
Parameters
- v: number
Returns void
- Defined in client/entities/vehicle.ts:60

vehicleType

get vehicleType(): string
Returns string
- Defined in client/entities/vehicle.ts:20

wheelType

get wheelType(): number
Returns number
- Defined in client/entities/vehicle.ts:144
set wheelType(type: number): void
Parameters
- type: number
Returns void
- Defined in client/entities/vehicle.ts:148

windowTint

get windowTint(): number
Returns number
- Defined in client/entities/vehicle.ts:120
set windowTint(tint: number): void
Parameters
- tint: number
Returns void
- Defined in client/entities/vehicle.ts:124

Methods

delete

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

distanceTo

distanceTo(other: IVector3 | Entity): number
Parameters
- other: IVector3 | Entity
Returns number
Inherited from Entity.distanceTo
- Defined in client/entities/entity.ts:76

freeze

freeze(toggle: boolean): void
Parameters
- toggle: boolean
Returns void
Inherited from Entity.freeze
- Defined in client/entities/entity.ts:60

getMod

getMod(modType: number): number
Parameters
- modType: number
Returns number
- Defined in client/entities/vehicle.ts:156

getPedInSeat

getPedInSeat(seat: number): number
Parameters
- seat: number
Returns number
- Defined in client/entities/vehicle.ts:28

isSeatFree

isSeatFree(seat: number): boolean
Parameters
- seat: number
Returns boolean
- Defined in client/entities/vehicle.ts:32

placeOnGround

placeOnGround(): void
Returns void
- Defined in client/entities/vehicle.ts:92

repair

repair(): void
Returns void
- Defined in client/entities/vehicle.ts:80

resetAlpha

resetAlpha(): void
Returns void
Inherited from Entity.resetAlpha
- Defined in client/entities/entity.ts:72

setAlarm

setAlarm(active: boolean): void
Parameters
- active: boolean
Returns void
- Defined in client/entities/vehicle.ts:192

setAlpha

setAlpha(alpha: number): void
Parameters
- alpha: number
Returns void
Inherited from Entity.setAlpha
- Defined in client/entities/entity.ts:68

setCollision

setCollision(toggle: boolean): void
Parameters
- toggle: boolean
Returns void
Inherited from Entity.setCollision
- Defined in client/entities/entity.ts:64

setColours

setColours(primary: number, secondary: number): void
Parameters
- primary: number
- secondary: number
Returns void
- Defined in client/entities/vehicle.ts:132

setCustomPrimaryColour

setCustomPrimaryColour(r: number, g: number, b: number): void
Parameters
- r: number
- g: number
- b: number
Returns void
- Defined in client/entities/vehicle.ts:136

setCustomSecondaryColour

setCustomSecondaryColour(r: number, g: number, b: number): void
Parameters
- r: number
- g: number
- b: number
Returns void
- Defined in client/entities/vehicle.ts:140

setDoorsLocked

setDoorsLocked(locked: boolean): void
Parameters
- locked: boolean
Returns void
- Defined in client/entities/vehicle.ts:184

setDoorsLockedForAllPlayers

setDoorsLockedForAllPlayers(locked: boolean): void
Parameters
- locked: boolean
Returns void
- Defined in client/entities/vehicle.ts:188

setHandbrake

setHandbrake(toggle: boolean): void
Parameters
- toggle: boolean
Returns void
- Defined in client/entities/vehicle.ts:88

setMod

setMod(modType: number, modIndex: number, customTires?: boolean): void
Parameters
- modType: number
- modIndex: number
- customTires: boolean = false
Returns void
- Defined in client/entities/vehicle.ts:160

setModKit

setModKit(kit: number): void
Parameters
- kit: number
Returns void
- Defined in client/entities/vehicle.ts:152

setNeonColour

setNeonColour(r: number, g: number, b: number): void
Parameters
- r: number
- g: number
- b: number
Returns void
- Defined in client/entities/vehicle.ts:172

setNeonEnabled

setNeonEnabled(index: number, toggle: boolean): void
Parameters
- index: number
- toggle: boolean
Returns void
- Defined in client/entities/vehicle.ts:168

setTyreSmokeColour

setTyreSmokeColour(r: number, g: number, b: number): void
Parameters
- r: number
- g: number
- b: number
Returns void
- Defined in client/entities/vehicle.ts:176

setUndriveable

setUndriveable(toggle: boolean): void
Parameters
- toggle: boolean
Returns void
- Defined in client/entities/vehicle.ts:84

toggleMod

toggleMod(modType: number, toggle: boolean): void
Parameters
- modType: number
- toggle: boolean
Returns void
- Defined in client/entities/vehicle.ts:164