GetVehicleHealth: Difference between revisions

From Onset Developer Wiki
← Older edit
No edit summary
No edit summary
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Info|Function|Server & Client|1.0}}
{{Info|Function|Server & Client|1.0}}


{{FuncDescription|__EDIT_ME__}}
{{FuncDescription|Returns the specified vehicle health in float.}}


{{FuncSyntax|GetVehicleHealth(vehicle)}}
{{FuncSyntax|GetVehicleHealth(vehicle)}}


{{FuncParameters}}
{{FuncParameters}}
{{FuncParam|vehicle|__EDIT_ME__}}
{{FuncParam|vehicle|The vehicle identifier}}


{{FuncReturnValue|__EDIT_ME__}}
{{FuncReturnValue|Vehicle health in float value between 0 to 10000}}


== Example ==
== Example ==
__EDIT_ME__
<syntaxhighlight lang="Lua">
print("Vehicle Health: " .. GetVehicleHealth(vehicle)/10000 .. "%"
</syntaxhighlight>


{{RelatedFunctions}}
{{RelatedFunctions}}
__EDIT_ME__
{{VehicleFunctions}}

Latest revision as of 14:52, 26 June 2021

GetVehicleHealth

Type: Function
Context: Server & Client
Introduced: v1.0

Description

Returns the specified vehicle health in float.

Syntax

GetVehicleHealth(vehicle)

Parameters

  • vehicle
    The vehicle identifier

Return Value

  • Vehicle health in float value between 0 to 10000

Example

print("Vehicle Health: " .. GetVehicleHealth(vehicle)/10000 .. "%"

See also

Retrieved from "https://dev.playonset.com/index.php?title=GetVehicleHealth&oldid=4862"