Latest revision as of 12:29, 2 November 2024

Client-Side
Function

JavaScript

JavaScript Syntax

Function

This function sets the ceiling height for a vehicle, which determines how close the vehicle can get to a ceiling or roof above it. The parameter `p1` sets this height, typically in meters.

Required Params

vehicle: number - The vehicle handle to set ceiling height.
height: float - The ceiling height for the vehicle.

Return value

void

Syntax

mp.game.vehicle.setCeilingHeight(vehicleHandle, height);

Example

// Example: Set a ceiling height of 420.0 for the player's vehicle.
const playerVehicle = mp.players.local.vehicle;
const ceilingHeight = 420.0;

if (playerVehicle) {
    mp.game.vehicle.setCeilingHeight(playerVehicle.handle, ceilingHeight);
}

@@ Line 1: / Line 1: @@
-Previously named GET_VEHICLE_DEFORMATION_GET_TREE (hash collision)<br><br>from Decrypted Scripts I found<br>VEHICLE::SET_VEHICLE_CEILING_HEIGHT(l_BD9[2/*2*/], 420.0);
+{{ClientsideJsFunction}}
+{{JSContainer|
+==Function==
+This function sets the ceiling height for a vehicle, which determines how close the vehicle can get to a ceiling or roof above it. The parameter `p1` sets this height, typically in meters.
+===Required Params===
+*'''vehicle:''' {{RageType|number}} - The vehicle handle to set ceiling height.
+*'''height:''' {{RageType|float}} - The ceiling height for the vehicle.
+===Return value===
+*{{RageType|void}}
 ==Syntax==
-<syntaxhighlight lang="javascript">vehicle.setCeilingHeight(p1);</syntaxhighlight>
+<syntaxhighlight lang="javascript">
-=== Required Arguments ===
+mp.game.vehicle.setCeilingHeight(vehicleHandle, height);
-*'''p1:''' float
+</syntaxhighlight>
-===Return value===
-*'''Undefined'''
 ==Example==
 <syntaxhighlight lang="javascript">
-// todo
+// Example: Set a ceiling height of 420.0 for the player's vehicle.
+const playerVehicle = mp.players.local.vehicle;
+const ceilingHeight = 420.0;
+if (playerVehicle) {
+    mp.game.vehicle.setCeilingHeight(playerVehicle.handle, ceilingHeight);
+}
 </syntaxhighlight>
+}}
 ==See also==
 {{Vehicle_function_c}}
 [[Category:Clientside API]]
 [[Category:TODO: Example]]

Latest revision as of 12:29, 2 November 2024

Client-Side Function

JavaScript Syntax

Function

Required Params

Return value

Syntax

Example

See also

Client-Side
Function