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.5Docs


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

Class: VehicleWindowCollection

Represents a collection of windows for a specific vehicle.

Constructors

new VehicleWindowCollection()

new VehicleWindowCollection(owner): VehicleWindowCollection

Parameters

owner: Vehicle

Returns

VehicleWindowCollection

Defined in

client/models/VehicleWindowCollection.ts:14

Accessors

AreAllWindowsIntact

get AreAllWindowsIntact(): boolean

Returns

boolean

Defined in

client/models/VehicleWindowCollection.ts:26


Owner

get Owner(): Vehicle

Returns

Vehicle

Defined in

client/models/VehicleWindowCollection.ts:18


VehicleWindows

get VehicleWindows(): Map<VehicleWindowIndex, VehicleWindow>

Returns

Map<VehicleWindowIndex, VehicleWindow>

Defined in

client/models/VehicleWindowCollection.ts:22

Methods

getAllWindows()

getAllWindows(): VehicleWindow[]

Retrieves all window objects in the vehicle.

Returns

VehicleWindow[]

An array of VehicleWindow objects that exist in the vehicle.

Defined in

client/models/VehicleWindowCollection.ts:49


getWindow()

getWindow(index): VehicleWindow

Retrieves the window object associated with a specific index in the vehicle.

Parameters

index: VehicleWindowIndex

The index of the window to retrieve.

Returns

VehicleWindow

The window object associated with the specified index.

Defined in

client/models/VehicleWindowCollection.ts:36


hasWindow()

hasWindow(windowIndex): boolean

Checks if a window of the vehicle exists based on the given window index.

Parameters

windowIndex: VehicleWindowIndex

The index of the window to check.

Returns

boolean

True if the window exists, false otherwise.

Defined in

client/models/VehicleWindowCollection.ts:90


rollDownAllWindows()

rollDownAllWindows(): void

Rolls down all the windows of the vehicle.

Returns

void

No return value

Defined in

client/models/VehicleWindowCollection.ts:67


rollUpAllWindows()

rollUpAllWindows(): void

Rolls up all windows in the vehicle.

Returns

void

Defined in

client/models/VehicleWindowCollection.ts:78