fivem-ts

a library to speed up the development of Fivem scripts and frameworks

---

Project maintained by Purpose-Dev Hosted on GitHub Pages — Theme by mattgraham

fivem-ts - Documentation v0.7.5 • Docs

---

fivem-ts - Documentation v0.7.5 / Client / VehicleModCollection

Class: VehicleModCollection

The VehicleModCollection class manages the mods for a Vehicle, including standard mods and toggleable mods such as neon lights, etc.

Constructors

new VehicleModCollection()

new VehicleModCollection(owner): VehicleModCollection

Parameters

• owner: Vehicle

Returns

VehicleModCollection

Defined in

client/models/VehicleModCollection.ts:22

Accessors

ColorCombination

get ColorCombination(): number

set ColorCombination(value): void

Parameters

• value: number

Returns

number

Defined in

client/models/VehicleModCollection.ts:273

---

ColorCombinationCount

get ColorCombinationCount(): number

Returns

number

Defined in

client/models/VehicleModCollection.ts:281

---

CustomPrimaryColor

get CustomPrimaryColor(): Color

set CustomPrimaryColor(color): void

Parameters

• color: Color

Returns

Color

Defined in

client/models/VehicleModCollection.ts:302

---

CustomSecondaryColor

get CustomSecondaryColor(): Color

set CustomSecondaryColor(color): void

Parameters

• color: Color

Returns

Color

Defined in

client/models/VehicleModCollection.ts:311

---

DashboardColor

set DashboardColor(color): void

Parameters

• color: VehicleColor

Defined in

client/models/VehicleModCollection.ts:269

---

HasAllNeonLights

get HasAllNeonLights(): boolean

Returns

boolean

Defined in

client/models/VehicleModCollection.ts:90

---

IsPrimaryColorCustom

get IsPrimaryColorCustom(): boolean

Returns

boolean

Defined in

client/models/VehicleModCollection.ts:320

---

IsSecondaryColorCustom

get IsSecondaryColorCustom(): boolean

Returns

boolean

Defined in

client/models/VehicleModCollection.ts:324

---

LicensePlate

get LicensePlate(): string

set LicensePlate(text): void

Parameters

• text: string

Returns

string

Defined in

client/models/VehicleModCollection.ts:363

---

LicensePlateStyle

get LicensePlateStyle(): LicensePlateStyle

set LicensePlateStyle(style): void

Parameters

• style: LicensePlateStyle

Returns

LicensePlateStyle

Defined in

client/models/VehicleModCollection.ts:351

---

LicensePlateType

get LicensePlateType(): LicensePlateType

Returns

LicensePlateType

Defined in

client/models/VehicleModCollection.ts:359

---

Livery

get Livery(): number

set Livery(index): void

Parameters

• index: number

Returns

number

Defined in

client/models/VehicleModCollection.ts:209

---

LiveryCount

get LiveryCount(): number

Returns

number

Defined in

client/models/VehicleModCollection.ts:199

---

NeonLightsColor

get NeonLightsColor(): Color

set NeonLightsColor(color): void

Parameters

• color: Color

Returns

Color

Defined in

client/models/VehicleModCollection.ts:94

---

Owner

get Owner(): Vehicle

Returns

Vehicle

Defined in

client/models/VehicleModCollection.ts:24

---

PearlescentColor

get PearlescentColor(): VehicleColor

set PearlescentColor(color): void

Parameters

• color: VehicleColor

Returns

VehicleColor

Defined in

client/models/VehicleModCollection.ts:257

---

PrimaryColor

get PrimaryColor(): VehicleColor

set PrimaryColor(color): void

Parameters

• color: VehicleColor

Returns

VehicleColor

Defined in

client/models/VehicleModCollection.ts:233

---

RimColor

get RimColor(): VehicleColor

set RimColor(color): void

Parameters

• color: VehicleColor

Returns

VehicleColor

Defined in

client/models/VehicleModCollection.ts:249

---

SecondaryColor

get SecondaryColor(): VehicleColor

set SecondaryColor(color): void

Parameters

• color: VehicleColor

Returns

VehicleColor

Defined in

client/models/VehicleModCollection.ts:241

---

TireSmokeColor

get TireSmokeColor(): Color

set TireSmokeColor(color): void

Parameters

• color: Color

Returns

Color

Defined in

client/models/VehicleModCollection.ts:285

---

TrimColor

set TrimColor(color): void

Parameters

• color: VehicleColor

Defined in

client/models/VehicleModCollection.ts:265

---

VehicleMods

get VehicleMods(): Map<VehicleMods, VehicleMod>

Returns

Map<VehicleMods, VehicleMod>

Defined in

client/models/VehicleModCollection.ts:28

---

VehicleToggleMods

get VehicleToggleMods(): Map<VehicleToggleModType, VehicleToggleMod>

Returns

Map<VehicleToggleModType, VehicleToggleMod>

Defined in

client/models/VehicleModCollection.ts:32

---

WheelType

get WheelType(): VehicleWheelType

set WheelType(type): void

Parameters

• type: VehicleWheelType

Returns

VehicleWheelType

Defined in

client/models/VehicleModCollection.ts:191

---

WindowTint

get WindowTint(): VehicleWindowTint

set WindowTint(tint): void

Parameters

• tint: VehicleWindowTint

Returns

VehicleWindowTint

Defined in

client/models/VehicleModCollection.ts:225

Methods

areAllNeonLightsOn()

areAllNeonLightsOn(): boolean

Checks if all neon lights on the vehicle are turned on.

Returns

boolean

True if all neon lights are on, false otherwise.

Defined in

client/models/VehicleModCollection.ts:108

---

clearCustomPrimaryColor()

clearCustomPrimaryColor(): void

Clears the custom primary color of the vehicle.

This method resets the vehicle’s primary color to the default value, removing any custom color that might have been set previously.

Returns

void

Defined in

client/models/VehicleModCollection.ts:336

---

clearCustomSecondaryColor()

clearCustomSecondaryColor(): void

Clears the custom secondary color of the vehicle.

This method will reset the custom secondary color of the vehicle associated with the owner Handle to its default state.

Returns

void

Defined in

client/models/VehicleModCollection.ts:347

---

getAllMods()

getAllMods(): VehicleMod[]

Retrieves all the vehicle modifications.

Returns

VehicleMod[]

An array of VehicleMod objects representing all the vehicle modifications.

Defined in

client/models/VehicleModCollection.ts:77

---

getMod()

getMod(modType): VehicleMod

Retrieves or initializes a VehicleMod based on the specified modType.

Parameters

• modType: VehicleMods

The type of vehicle modification to retrieve.

Returns

VehicleMod

The instance of VehicleMod corresponding to the provided modType.

Defined in

client/models/VehicleModCollection.ts:52

---

getToggleMod()

getToggleMod(modType): VehicleToggleMod

Retrieves or creates a toggle modification for the vehicle based on the specified modification type.

Parameters

• modType: VehicleToggleModType

The type of toggle modification to retrieve or create.

Returns

VehicleToggleMod

The toggle modification for the specified type.

Defined in

client/models/VehicleModCollection.ts:65

---

hasNeonLight()

hasNeonLight(light): boolean

Checks if the vehicle has the specified neon light.

Parameters

• light: VehicleNeonLight

The neon light position to check (Back, Front, Left, Right).

Returns

boolean

True if the vehicle has the specified neon light, false otherwise.

Defined in

client/models/VehicleModCollection.ts:131

---

hasVehicleMod()

hasVehicleMod(type): boolean

Checks if the vehicle has the specified modification type.

Parameters

• type: VehicleMods

The type of vehicle modification to check for.

Returns

boolean

• True if the vehicle has the specified modification, false otherwise.

Defined in

client/models/VehicleModCollection.ts:42

---

isNeonLightOn()

isNeonLightOn(light): boolean

Checks if the specified neon light on the vehicle is turned on.

Parameters

• light: VehicleNeonLight

The neon light to check the status of.

Returns

boolean

• Returns true if the neon light is on, false otherwise.

Defined in

client/models/VehicleModCollection.ts:152

---

setAllNeonLightsOff()

setAllNeonLightsOff(): void

Turns off all neon lights on the vehicle by iterating over each type of neon light and setting its state to off.

Returns

void

No return value.

Defined in

client/models/VehicleModCollection.ts:174

---

setAllNeonLightsOn()

setAllNeonLightsOn(): void

Turns on all neon lights of the vehicle by iterating over all available neon light types and setting each one to ‘on’ state.

Returns

void

This method does not return any value.

Defined in

client/models/VehicleModCollection.ts:162

---

setModColor1()

setModColor1(paintType, color): void

Parameters

• paintType: VehiclePaintType

• color: VehicleColor

Returns

void

Defined in

client/models/VehicleModCollection.ts:294

---

setModColor2()

setModColor2(paintType, color): void

Parameters

• paintType: VehiclePaintType

• color: VehicleColor

Returns

void

Defined in

client/models/VehicleModCollection.ts:298

---

setNeonLightOn()

setNeonLightOn(light, toggle): void

Sets the state of the specified neon light on the vehicle.

Parameters

• light: VehicleNeonLight

The specific neon light to be toggled.

• toggle: boolean

The desired state of the neon light; true to turn it on, false to turn it off.

Returns

void

Defined in

client/models/VehicleModCollection.ts:187