SetPlayerHealth

This function allows you to set a player's health.

Syntax

bool setPlayerHealth ( player thePlayer, float playerHealth )

Required Arguments

• thePlayer: The player whose health you want to set.
• playerHealth: The value you want to set the health to. Valid values are from 0 (dead) to 100 (full health).

Returns

Returns true if the player's health was set succesfully. Returns false if the player argument is invalid, or the health argument is out of range.

Example

This example finds a player called someguy and sets their health to 1 (almost dead).

-- Try to set the health of a player called 'someguy' to 1
if ( setPlayerHealth ( findPlayer ( "someguy" ), 1 ) ) then
	-- Tell everyone that someguy has lost lots of health
	outputChatBox ( "Someguy's life expectancy just got a lot less expected." )
end