Skip to content
On this page

Athena.vehicle.add

Interfaces

Functions

override

Usage

Athena.vehicle.add.override(functionName, callback): any

Used to override add owned vehicle functionality

Parameters

NameType
functionName"toDatabase"
callback(owner: string, model: string, pos: IVector3, options: AddOptions) => Promise<boolean>

Returns

any

Defined in

server/vehicle/add.ts:197

Usage

Athena.vehicle.add.override(functionName, callback): any

Used to override add owned vehicle functionality

Parameters

NameType
functionName"toPlayer"
callback(player: Player, model: string, pos: IVector3, options: Omit<AddOptions, "doNotDespawn">) => Promise<boolean>

Returns

any

Defined in

server/vehicle/add.ts:198


toDatabase

Usage

Athena.vehicle.add.toDatabase(owner, model, pos, options?): Promise<boolean>

Add a vehicle to the database.

Owner can be an identifier, group, etc.

Parameters

NameTypeDefault valueDescription
ownerstringundefined-
modelstringundefined
posIVector3undefinedA position in the world.
optionsAddOptionsundefined-

Returns

Promise<boolean>

Defined in

server/vehicle/add.ts:135


toPlayer

Usage

Athena.vehicle.add.toPlayer(player, model, pos, options?): Promise<boolean>

Add a vehicle to a player. The position specified is where the vehicle can be found.

Parameters

NameTypeDefault valueDescription
playerPlayerundefinedAn alt:V Player Entity
modelstringundefined
posIVector3undefinedA position in the world.
optionsOmit<AddOptions, "doNotDespawn">undefined-

Returns

Promise<boolean>

Defined in

server/vehicle/add.ts:64

Created by Stuyk | Est. 2020