Athena.vehicle.get ​

Functions ​

ownedVehicleByDatabaseID ​

Returns an owned vehicle by Database ID.

Export

Parameters ​

Returns ​

Promise<player>

Defined in ​

server/vehicle/get.ts:96

ownedVehicleByDocumentID ​

Returns an owned vehicle by Document ID.

Export

Parameters ​

Returns ​

Promise<player>

Defined in ​

server/vehicle/get.ts:85

ownedVehiclesByPlayer ​

Returns a list of vehicle documents owned by the player.

Export

Type parameters ​

Parameters ​

Returns ​

Promise<T[]>

Defined in ​

server/vehicle/get.ts:185

spawnedVehicleByDatabaseID ​

Returns a spawned vehicle by their database identifier.

Not to be confused with _id.

Export

Parameters ​

Returns ​

alt.Vehicle | undefined

Defined in ​

server/vehicle/get.ts:28

spawnedVehicleByDocumentID ​

Returns a spawned vehicle by their unique database _id.

Export

Parameters ​

Returns ​

alt.Vehicle | undefined

Defined in ​

server/vehicle/get.ts:61

spawnedVehicleByEntityID ​

Used the internal alt:V Identifiers to find a vehicle.

These IDs always change, and are never the same.

Export

Parameters ​

Returns ​

any

Defined in ​

server/vehicle/get.ts:15

temporaryVehicles ​

Get all temporary vehicles.

Example ​

const vehicles = Athena.vehicle.get.temporaryVehicles();

Returns ​

alt.Vehicle[]

An array of temporary vehicles.

Defined in ​

server/vehicle/get.ts:120

vehiclesSpawnedByPlayer ​

Takes a player instance, or _id and returns all spawned & owned vehicles

Example ​

function something(player: alt.Player) {
    const vehicles = Athena.vehicle.get.vehiclesSpawnedByPlayer(player);
}

Parameters ​

Returns ​

any

An array of vehicles owned and spawned by a player.

Defined in ​

server/vehicle/get.ts:157

vehiclesWithOwnership ​

Get all owned vehicles.

Example ​

const vehicles = Athena.vehicle.get.vehiclesWithOwnership();

Returns ​

alt.Vehicle[]

An array of owned vehicles.

Defined in ​

server/vehicle/get.ts:137