Skip to content
On this page

Athena.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

NameType
vehicleVehicle
modkitnumber
modsIVehicleMod[]

Returns

any

Defined in

server/vehicle/tuning.ts:139


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

NameTypeDescription
vehicleVehicleAn alt:V Vehicle Entity
stateany-

Returns

any

Defined in

server/vehicle/tuning.ts:17


applyTuning

Usage

Athena.vehicle.tuning.applyTuning(vehicle, tuning): any

Apply tuning to the specified vehicle.

Parameters

NameTypeDescription
vehicleVehicleAn alt:V Vehicle Entity
tuningany

Returns

any

Defined in

server/vehicle/tuning.ts:74


getExtras

Usage

Athena.vehicle.tuning.getExtras(vehicle): player[]

Get all mods of the specified vehicle.

Parameters

NameTypeDescription
vehicleVehicleAn alt:V Vehicle Entity

Returns

player[]

Defined in

server/vehicle/tuning.ts:34


getMods

Usage

Athena.vehicle.tuning.getMods(vehicle): player[]

Return all mods that are currently applied to a vehicle.

Export

Parameters

NameType
vehicleVehicle

Returns

player[]

Defined in

server/vehicle/tuning.ts:176


getTuning

Usage

Athena.vehicle.tuning.getTuning(vehicle): player

Get all mods of the specified vehicle.

Parameters

NameTypeDescription
vehicleVehicleAn alt:V Vehicle Entity

Returns

player

Defined in

server/vehicle/tuning.ts:107


override

Usage

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

Used to override vehicle tuning functionality

Parameters

NameType
functionName"applyState"
callback(vehicle: Vehicle, state: any) => any

Returns

any

Defined in

server/vehicle/tuning.ts:207

Usage

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

Used to override vehicle tuning functionality

Parameters

NameType
functionName"setExtra"
callback(vehicle: Vehicle, extras: VehicleExtra[]) => any

Returns

any

Defined in

server/vehicle/tuning.ts:208

Usage

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

Used to override vehicle tuning functionality

Parameters

NameType
functionName"getExtras"
callback(vehicle: Vehicle) => player[]

Returns

any

Defined in

server/vehicle/tuning.ts:209

Usage

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

Used to override vehicle tuning functionality

Parameters

NameType
functionName"applyTuning"
callback(vehicle: Vehicle, tuning: any) => any

Returns

any

Defined in

server/vehicle/tuning.ts:210

Usage

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

Used to override vehicle tuning functionality

Parameters

NameType
functionName"getTuning"
callback(vehicle: Vehicle) => player

Returns

any

Defined in

server/vehicle/tuning.ts:211

Usage

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

Used to override vehicle tuning functionality

Parameters

NameType
functionName"applyMods"
callback(vehicle: Vehicle, modkit: number, mods: IVehicleMod[]) => any

Returns

any

Defined in

server/vehicle/tuning.ts:212

Usage

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

Used to override vehicle tuning functionality

Parameters

NameType
functionName"getMods"
callback(vehicle: Vehicle) => player[]

Returns

any

Defined in

server/vehicle/tuning.ts:213


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

NameTypeDescription
vehicleVehicleAn alt:V Vehicle Entity
extrasVehicleExtra[]

Returns

any

Defined in

server/vehicle/tuning.ts:57

Created by Stuyk | Est. 2020