Vehicle::getEngineHealth: Difference between revisions

Latest revision as of 11:37, 9 May 2024

Engine Health	Status
1000	Perfect - Undamaged
< 1000	Damaged
< 400	Engine is smoking and losing functionality
0	Engine stops working and car is not drivable
< 0	Engine catches fire, health rapidly declines and blows up seconds later

Maximum: 1000
Minimum: -4000
Note*: Returns 1000.0 if the function is unable to get the address of the specified vehicle or if it's not a vehicle.

Syntax

vehicle.getEngineHealth();

Required Arguments

Return value

float

Example

Client-Side

function getEngineHealth() {
    let vehicle = mp.players.local.vehicle;
    let engineHealth = vehicle.getEngineHealth();
    mp.gui.chat.push(`engine health: ${engineHealth}`);

    return engineHealth; // returns the value of the engine health as a float
}

@@ Line 24: / Line 24: @@
 Note*: Returns 1000.0 if the function is unable to get the address of the specified vehicle or if it's not a vehicle.<br>
 ==Syntax==
-<syntaxhighlight lang="javascript">vehicle.getEngineHealth();</syntaxhighlight>
+<pre>vehicle.getEngineHealth();</pre>
 === Required Arguments ===
 ===Return value===
 *'''float'''
 ==Example==
-<syntaxhighlight lang="javascript">
-let engineHealth = vehicle.getEngineHealth();
-mp.gui.chat.push(`engine health: ${engineHealth}`);
+{{ClientsideCode|
-</syntaxhighlight>
+<pre>
+function getEngineHealth() {
+    let vehicle = mp.players.local.vehicle;
+    let engineHealth = vehicle.getEngineHealth();
+    mp.gui.chat.push(`engine health: ${engineHealth}`);
+    return engineHealth; // returns the value of the engine health as a float
+}
+</pre>
+}}
 ==See also==
-{{Vehicle_function_c}}
+{{Vehicle_definition_c}}
 [[Category:Clientside API]]
 [[Category:TODO: Example]]