GetVehicleHealth: Difference between revisions

From NPC for VCMP 0.4 Servers
Jump to navigation Jump to search
(Created page with "{{Welcome|desc=Returns the health of the vehicle as float| params=<source>(vehicleid)</source> <poem>vehicleid : The ID of the vehicle whose health is to be found</poem>| retvals=The health of the vehicle on success, 0.0 on failure (invalid/not streamedin vehicle)}}")
 
No edit summary
Line 1: Line 1:
<poem style="border: 2px solid #d6d2c5; background-color: #f9f4e6; padding: 1em;">
This function was added in v1.7 (not released yet) and will not work on previous versions.
</poem>
{{Welcome|desc=Returns the health of the vehicle as float|
{{Welcome|desc=Returns the health of the vehicle as float|
params=<source>(vehicleid)</source>
params=<source>(vehicleid)</source>
<poem>vehicleid : The ID of the vehicle whose health is to be found</poem>|
<poem>vehicleid : The ID of the vehicle whose health is to be found</poem>|
retvals=The health of the vehicle on success, 0.0 on failure (invalid/not streamedin vehicle)}}
retvals=The health of the vehicle on success, 0.0 on failure (invalid/not streamedin vehicle)|
relfuncs=*[[GetVehicleDamage]]
*[[GetMyHealth]]}}

Revision as of 17:08, 21 August 2023

This function was added in v1.7 (not released yet) and will not work on previous versions.


Description:
Returns the health of the vehicle as float


Parameters:

(vehicleid)

vehicleid : The ID of the vehicle whose health is to be found


Return Values:
The health of the vehicle on success, 0.0 on failure (invalid/not streamedin vehicle)



Related Functions

The following functions may be helpful as they relate to this function in one way or another.