V5 DocsAthena.vehicle.add ​
Interfaces ​
Functions ​
override ​
Usage
Athena.vehicle.add.override(functionName, callback): any
Used to override add owned vehicle functionality
Parameters ​
| Name | Type |
|---|---|
functionName | "toDatabase" |
callback | (owner: string, model: string, pos: IVector3, options: AddOptions) => Promise<boolean> |
Returns ​
any
Defined in ​
Usage
Athena.vehicle.add.override(functionName, callback): any
Used to override add owned vehicle functionality
Parameters ​
| Name | Type |
|---|---|
functionName | "toPlayer" |
callback | (player: Player, model: string, pos: IVector3, options: Omit<AddOptions, "doNotDespawn">) => Promise<boolean> |
Returns ​
any
Defined in ​
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 ​
| Name | Type | Default value | Description |
|---|---|---|---|
owner | string | undefined | - |
model | string | undefined | |
pos | IVector3 | undefined | A position in the world. |
options | AddOptions | undefined | - |
Returns ​
Promise<boolean>
Defined in ​
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 ​
| Name | Type | Default value | Description |
|---|---|---|---|
player | Player | undefined | An alt:V Player Entity |
model | string | undefined | |
pos | IVector3 | undefined | A position in the world. |
options | Omit<AddOptions, "doNotDespawn"> | undefined | - |
Returns ​
Promise<boolean>