Latest revision as of 11:03, 2 November 2024

Client-Side
Function

JavaScript

JavaScript Syntax

The `getVehicleClass` function retrieves the class of a specified vehicle. Vehicle classes in GTA V are predefined categories, such as "Sports," "SUV," or "Motorcycle," that determine vehicle behavior, sound, and handling characteristics.

Required Params

vehicle: number – The handle or reference ID of the vehicle whose class is being retrieved.

Return Value

'number' – The class ID of the vehicle, which corresponds to a specific class category (e.g., 0 for compacts, 1 for sedans).

Syntax

mp.game.vehicle.getVehicleClass(vehicle);

Example

let vehicle = mp.players.local.vehicle;
if (vehicle) {
    let vehicleClass = mp.game.vehicle.getVehicleClass(vehicle.handle);
    mp.gui.chat.push("Vehicle Class: " + vehicleClass);
}

@@ Line 1: / Line 1: @@
 {{ClientsideJsFunction}}
 {{JSContainer|
+The `getVehicleClass` function retrieves the class of a specified vehicle. Vehicle classes in GTA V are predefined categories, such as "Sports," "SUV," or "Motorcycle," that determine vehicle behavior, sound, and handling characteristics.
-===Required Params===
+=== Required Params ===
-*'''vehicle:''' {{RageType|number}}
+* '''vehicle:''' {{RageType|number}} – The handle or reference ID of the vehicle whose class is being retrieved.
-===Return value===
+=== Return Value ===
-*''' {{RageType|number}} '''
+* '''{{RageType|number}}''' – The class ID of the vehicle, which corresponds to a specific class category (e.g., 0 for compacts, 1 for sedans).
-==Syntax==
+== Syntax ==
 <syntaxhighlight lang="javascript">
-mp.game.vehicle.getVehicleClass(vehicle)
+mp.game.vehicle.getVehicleClass(vehicle);
 </syntaxhighlight>
-==Example==
+== Example ==
 <syntaxhighlight lang="javascript">
-//todo
+let vehicle = mp.players.local.vehicle;
+if (vehicle) {
+    let vehicleClass = mp.game.vehicle.getVehicleClass(vehicle.handle);
+    mp.gui.chat.push("Vehicle Class: " + vehicleClass);
+}
 </syntaxhighlight>
-}}
-==See also==
+== See Also ==
 {{Vehicle_functions_c}}
 [[Category:Clientside API]]
-[[Category:TODO: Example]]
+[[Category:Vehicle API]]
+}}