SetPlayerHealth: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(11 intermediate revisions by 6 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
This function allows you to set a player's health directly. It may return false if the player object is invalid, or the health argument is out of range.
{{Server client function}}
 
{{Deprecated|setElementHealth|}}
==Syntax==
<syntaxhighlight lang="lua">bool setPlayerHealth ( player thePlayer, float playerHealth )</syntaxhighlight>
 
===Required Arguments===
*'''player''': The [[player]] whose health you want to set
*'''health''': The value you want to set the health to. Valid values are from 0 to 100
 
===Returns===
Returns false if the player object is invalid, or the health argument is out of range.
 
==Example==
<syntaxhighlight lang="lua">if ( setPlayerHealth ( findPlayer ( "Someguy" ), 1 ) ) then
  outputChatBox ( "Someguy's life expectancy just got a lot less expected.", player )
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.