SetPlayerHealth: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
(9 intermediate revisions by 5 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
This function allows you to set a player's health.
{{Server client function}}
 
{{Deprecated|setElementHealth|}}
==Syntax==
<syntaxhighlight lang="lua">
bool setPlayerHealth ( player thePlayer, float playerHealth )
</syntaxhighlight>
 
===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).
<syntaxhighlight lang="lua">
-- 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
</syntaxhighlight>

Latest revision as of 22:24, 1 July 2019

Emblem-important.png This function is deprecated. This means that its use is discouraged and that it might not exist in future versions.

Please use setElementHealth instead.