GetPlayerHealth

From SA-MP Wiki

Jump to: navigation, search


Description:

The function GetPlayerHealth allows you to retrieve the health of a player. Useful for cheat detection, among other things.


Parameters:
(playerid, &Float:health)
playeridThe ID of the player.
&Float:healthFloat to store health, passed by reference.


Return Values:

  • 1 - success
  • 0 - failure (i.e. player not connected).
  • The player's health is stored in the specified variable.


Image:32px-Circle-style-warning.png

Important
Notes

  • Even though the health can be set to near infinite values on the server side, the individual clients will only report values up to 255. Anything higher will wrap around; 256 becomes 0, 257 becomes 1, etc.
  • Health is obtained rounded to integers: set 50.15, but get 50.0


Example Usage:

// Sets players health to 50 if it was lower than
// 50 before, as soon as he typed /doctor
 
if(strcmp(cmdtext, "/doctor", true) == 0)
{
    new Float:health;
    GetPlayerHealth(playerid,health);
    if (health < 50.0)
    {
        SetPlayerHealth(playerid, 50.0);
    }
    return 1;
}

Related Functions

The following functions may be useful, as they are related to this function in one way or another.

Personal tools