AthenaShared.interfaces.vehicleBase.BaseVehicle ​

shared/interfaces/vehicleBase.BaseVehicle

Used as the main describer of a stored vehicle.

Interface

BaseVehicle

Hierarchy ​

• BaseVehicle

  ↳ OwnedVehicle

Properties ​

_id ​

• Optional _id: unknown

The vehicle identifier for the database. Also used to save to the database.

Defined in ​

shared/interfaces/vehicleBase.ts:16

dimension ​

• dimension: number

Used to control what dimension this vehicle should spawn in / be found in

Defined in ​

shared/interfaces/vehicleBase.ts:61

doNotDespawn ​

• Optional doNotDespawn: boolean

Flag this value to prevent this vehicle from ever being despawned

Defined in ​

shared/interfaces/vehicleBase.ts:110

fuel ​

• fuel: number

The fuel level for this vehicle.

Defined in ​

shared/interfaces/vehicleBase.ts:93

garageInfo ​

• Optional garageInfo: number

Set this value to an indexable garage. If this value is set it means it will not be spawned when a player joins.

Defined in ​

shared/interfaces/vehicleBase.ts:102

groups ​

• Optional groups: Object

A key value pair of a group, and what permissions they have in that group.

Memberof

BaseVehicle

Index signature ​

▪ [key: string]: string[]

Defined in ​

shared/interfaces/vehicleBase.ts:126

id ​

• Optional id: number

The vehicle id for lookups.

Defined in ​

shared/interfaces/vehicleBase.ts:23

keys ​

• keys: string[]

A list of character ids that have access to this vehicle

Defined in ​

shared/interfaces/vehicleBase.ts:77

lastUsed ​

• Optional lastUsed: number

The last known timestamp when this vehicle was used.

Defined in ​

shared/interfaces/vehicleBase.ts:118

model ​

• model: string

The model of this vehicle.

Defined in ​

shared/interfaces/vehicleBase.ts:40

owner ​

• owner: string

The player who is the owner of this vehicle. Corresponds with character._id or null if it belongs to anything else Obviously permissions and keys should be used if no owner is set.

Defined in ​

shared/interfaces/vehicleBase.ts:33

permissions ​

• permissions: string[]

A list of character permissions that have access to this vehicle

Defined in ​

shared/interfaces/vehicleBase.ts:85

plate ​

• plate: string

A unique identifier for this specific vehicle. Usually automatically generated.

Defined in ​

shared/interfaces/vehicleBase.ts:69

pos ​

• pos: IVector3

The last position where this vehicle was last left.

Defined in ​

shared/interfaces/vehicleBase.ts:47

rot ​

• rot: IVector3

The last rotation where this vehicle was last left.

Defined in ​

shared/interfaces/vehicleBase.ts:54