V5 DocsAthena.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 ​
list ​
Usage
Athena.vehicle.despawn.list(ids): Promise<void>
Despawn a list of vehicles by identifier
Parameters ​
| Name | Type |
|---|---|
ids | number[] |
Returns ​
Promise<void>
Defined in ​
one ​
Usage
Athena.vehicle.despawn.one(id): Promise<boolean>
Returns true if the vehicle has been despawned / destroyed.
Parameters ​
| Name | Type |
|---|---|
id | number |
Returns ​
Promise<boolean>
Defined in ​
override ​
Usage
Athena.vehicle.despawn.override(functionName, callback): any
Used to override despawn vehicle functionality
Parameters ​
| Name | Type |
|---|---|
functionName | "all" |
callback | () => Promise<void> |
Returns ​
any
Defined in ​
Usage
Athena.vehicle.despawn.override(functionName, callback): any
Used to override despawn vehicle functionality
Parameters ​
| Name | Type |
|---|---|
functionName | "one" |
callback | (id: number) => Promise<boolean> |
Returns ​
any
Defined in ​
Usage
Athena.vehicle.despawn.override(functionName, callback): any
Used to override despawn vehicle functionality
Parameters ​
| Name | Type |
|---|---|
functionName | "list" |
callback | (ids: number[]) => Promise<void> |
Returns ​
any