SetPlayerHealth

From Multi Theft Auto: Wiki
Revision as of 00:47, 17 September 2007 by Jbeta (talk | contribs)
Jump to navigation Jump to search
Emblem-important.png This function is deprecated. This means that its use is discouraged and that it might not exist in future versions, but there should be a more generic way to perform what it does.


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 adds a console command that lets players "slap" each other (doing 20 damage). 

function slap ( sourcePlayer, command, targetPlayerName )
    local targetPlayer = getPlayerFromNick ( targetPlayerName )           -- look up the player to be slapped
    if targetPlayer then                                                  -- check if we found him
        setPlayerHealth ( thePlayer, getPlayerHealth(targetPlayer) - 20 ) -- if so, subtract 20 from his health
    else                                                                  -- otherwise, output an error message
        outputChatBox ( "There is no player named " .. targetPlayerName .. "!", sourcePlayer )
    end
end
addCommandHandler ( "slap", slap )

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/SetPlayerHealth?oldid=12061"