Squirrel/Server/Functions/Players/Health

Latest revision as of 11:45, 15 October 2010

This function sets/returns the players health.

float player.Health

player.Health = float value

 
function onPlayerCommand( player, cmd, text )
{
	if ( cmd== "health" )
	{
		MessagePlayer( "Your health is " + player.Health + ".", player);	
	}
}

This will tell the player what their health value currently is.

 
function onPlayerCommand( player, cmd, text )
{
	if ( cmd== "heal" )
	{
		player.Health = 100;	
	}
}

This will heal the player whenever they use /heal.

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

@@ Line 4: / Line 4: @@
 == Syntax ==
-<code>float Player.Health( int Value )</code>
+<code>float player.Health</code>
+<code>player.Health = float value</code>
 == Arguments ==
-* '''Value''' - What you can set the health value to.
+* '''value''' - What you can set the health value to.
 == Example 1. Returning ==