V5 DocsAthena.vehicle.tuning ​
Functions ​
applyMods ​
Usage
Athena.vehicle.tuning.applyMods(vehicle, modkit, mods): any
Apply mods to a vehicle.
Automatically saves data if vehicle is non-temporary.
Export
Parameters ​
| Name | Type |
|---|---|
vehicle | Vehicle |
modkit | number |
mods | IVehicleMod[] |
Returns ​
any
Defined in ​
applyState ​
Usage
Athena.vehicle.tuning.applyState(vehicle, state): any
Applies specified properties to a vehicle in bulk. These match the alt:V API, and can be pulled from a database.
Parameters ​
| Name | Type | Description |
|---|---|---|
vehicle | Vehicle | An alt:V Vehicle Entity |
state | any | - |
Returns ​
any
Defined in ​
applyTuning ​
Usage
Athena.vehicle.tuning.applyTuning(vehicle, tuning): any
Apply tuning to the specified vehicle.
Parameters ​
| Name | Type | Description |
|---|---|---|
vehicle | Vehicle | An alt:V Vehicle Entity |
tuning | any |
Returns ​
any
Defined in ​
getExtras ​
Usage
Athena.vehicle.tuning.getExtras(vehicle): player[]
Get all mods of the specified vehicle.
Parameters ​
| Name | Type | Description |
|---|---|---|
vehicle | Vehicle | An alt:V Vehicle Entity |
Returns ​
player[]
Defined in ​
getMods ​
Usage
Athena.vehicle.tuning.getMods(vehicle): player[]
Return all mods that are currently applied to a vehicle.
Export
Parameters ​
| Name | Type |
|---|---|
vehicle | Vehicle |
Returns ​
player[]
Defined in ​
getTuning ​
Usage
Athena.vehicle.tuning.getTuning(vehicle): player
Get all mods of the specified vehicle.
Parameters ​
| Name | Type | Description |
|---|---|---|
vehicle | Vehicle | An alt:V Vehicle Entity |
Returns ​
Defined in ​
override ​
Usage
Athena.vehicle.tuning.override(functionName, callback): any
Used to override vehicle tuning functionality
Parameters ​
| Name | Type |
|---|---|
functionName | "applyState" |
callback | (vehicle: Vehicle, state: any) => any |
Returns ​
any
Defined in ​
Usage
Athena.vehicle.tuning.override(functionName, callback): any
Used to override vehicle tuning functionality
Parameters ​
| Name | Type |
|---|---|
functionName | "setExtra" |
callback | (vehicle: Vehicle, extras: VehicleExtra[]) => any |
Returns ​
any
Defined in ​
Usage
Athena.vehicle.tuning.override(functionName, callback): any
Used to override vehicle tuning functionality
Parameters ​
| Name | Type |
|---|---|
functionName | "getExtras" |
callback | (vehicle: Vehicle) => player[] |
Returns ​
any
Defined in ​
Usage
Athena.vehicle.tuning.override(functionName, callback): any
Used to override vehicle tuning functionality
Parameters ​
| Name | Type |
|---|---|
functionName | "applyTuning" |
callback | (vehicle: Vehicle, tuning: any) => any |
Returns ​
any
Defined in ​
Usage
Athena.vehicle.tuning.override(functionName, callback): any
Used to override vehicle tuning functionality
Parameters ​
| Name | Type |
|---|---|
functionName | "getTuning" |
callback | (vehicle: Vehicle) => player |
Returns ​
any
Defined in ​
Usage
Athena.vehicle.tuning.override(functionName, callback): any
Used to override vehicle tuning functionality
Parameters ​
| Name | Type |
|---|---|
functionName | "applyMods" |
callback | (vehicle: Vehicle, modkit: number, mods: IVehicleMod[]) => any |
Returns ​
any
Defined in ​
Usage
Athena.vehicle.tuning.override(functionName, callback): any
Used to override vehicle tuning functionality
Parameters ​
| Name | Type |
|---|---|
functionName | "getMods" |
callback | (vehicle: Vehicle) => player[] |
Returns ​
any
Defined in ​
setExtra ​
Usage
Athena.vehicle.tuning.setExtra(vehicle, extras): any
Applies specified properties to a vehicle in bulk. These match the alt:V API, and can be pulled from a database.
Parameters ​
| Name | Type | Description |
|---|---|---|
vehicle | Vehicle | An alt:V Vehicle Entity |
extras | VehicleExtra[] |
Returns ​
any