SetPlayerHealth: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
Line 15: Line 15:


==Example==
==Example==
<section name="Server" class="server" show="true">
This example finds "player" and when "slap" is entered, their health is decreased
This example finds "player" and when "slap" is entered, their health is decreased
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
Line 21: Line 22:
  end
  end
addCommandHandler ( "slap", slap )
addCommandHandler ( "slap", slap )
</syntaxhighlight>
</syntaxhighlight></section>


==See Also==
==See Also==
{{Player functions}}
{{Player functions}}
{{Server function}}

Revision as of 23:08, 14 August 2007

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

Click to collapse [-]
Server

This example finds "player" and when "slap" is entered, their health is decreased

function slap ( player, command ) --calls the function
setPlayerHealth ( player, getPlayerHealth(player) - 20 ) --sets the player health
 end
addCommandHandler ( "slap", slap )

See Also