Skip to content
On this page

Athena.vehicle.despawn

Functions

all

Usage

Athena.vehicle.despawn.all(): Promise<void>

Despawns all vehicles, except for vehicles flagged to prevent despawning.

May take some time to despawn, and save all vehicle data.

Wait for this function to finish before attempting to respawn.

Returns

Promise<void>

Defined in

server/vehicle/despawn.ts:13


list

Usage

Athena.vehicle.despawn.list(ids): Promise<void>

Despawn a list of vehicles by identifier

Parameters

NameType
idsnumber[]

Returns

Promise<void>

Defined in

server/vehicle/despawn.ts:100


one

Usage

Athena.vehicle.despawn.one(id): Promise<boolean>

Returns true if the vehicle has been despawned / destroyed.

Parameters

NameType
idnumber

Returns

Promise<boolean>

Defined in

server/vehicle/despawn.ts:63


override

Usage

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

Used to override despawn vehicle functionality

Parameters

NameType
functionName"all"
callback() => Promise<void>

Returns

any

Defined in

server/vehicle/despawn.ts:122

Usage

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

Used to override despawn vehicle functionality

Parameters

NameType
functionName"one"
callback(id: number) => Promise<boolean>

Returns

any

Defined in

server/vehicle/despawn.ts:123

Usage

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

Used to override despawn vehicle functionality

Parameters

NameType
functionName"list"
callback(ids: number[]) => Promise<void>

Returns

any

Defined in

server/vehicle/despawn.ts:124

Created by Stuyk | Est. 2020