Scripting/Squirrel/Functions/Players/Health

From VC-MP Wiki

This instance variable returns or sets player's health.

Syntax

int player.Health

player.Health = newHealth

Example 1. Returning

This command gives player's health when someone types '/c health playername'.

function onPlayerCommand( player, cmd, text )
{
     if ( cmd == "health" )
     {
          local plr = FindPlayer( text );
          
          if ( !plr ) MessagePlayer( "Error: Player '" + text + "' is not online.", player );
          else MessagePlayer( plr.Name + "'s health: " + plr.Health, player );
     }
}

Notes

The functions MessagePlayer, FindPlayer, player.Name and call onPlayerCommand were used in in this example. More info about them in corresponding pages.

Example 2. Setting

This command heals the player who types '/c heal'.

function onPlayerCommand( player, cmd, text )
{
     if ( cmd == "heal" )
     {
          player.Health = 100;
          MessagePlayer( "Your health has been restored.", player );
     }
}

Notes

The function MessagePlayer and call onPlayerCommand were used in in this example. More info about them in corresponding pages.

Related Functions

• FindPlayer
• Player.Angle
• Player.Armour
• Player.Cash
• Player.Class
• Player.DrivebyAbility
• Player.GetSpectating
• Player.GetSyncBlockedTo
• Player.Health
• Player.ID
• Player.IP
• Player.IsAdmin
• Player.IsFrozen
• Player.IsIgnoredBy
• Player.IsMuted
• Player.IsPassenger
• Player.IsSpawned
• Player.IsSyncBlocked
• Player.IsWeaponSyncBlocked
• Player.Keys
• Player.Name
• Player.Ping
• Player.Pos
• Player.RemoveLocalMarker
• Player.RemoveMarker
• Player.ResetGameSettings
• Player.Score
• Player.Seat
• Player.SetAnim
• Player.SetDrunkLevel
• Player.SetIgnoredBy
• Player.SetInterior
• Player.SetLocalMarker
• Player.SetMarker
• Player.SetSyncBlockedTo
• Player.WantedLevel
• Player.SetWeapon
• Player.Skin
• Player.SpawnPos
• Player.Team
• Player.Vehicle
• Player.Weapon
• Player.ShootInAir
• Player.StuntMode
• Player.Spikes