SetElementHealth: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
m (→‎Syntax: OOP)
Line 7: Line 7:
bool setElementHealth ( element theElement, float newHealth )
bool setElementHealth ( element theElement, float newHealth )
</syntaxhighlight>
</syntaxhighlight>
{{OOP|This function is also a static function underneath the Element class.|[[element]]:setHealth|health|}}


===Required Arguments===
===Required Arguments===

Revision as of 16:39, 16 August 2014

This function sets the health for the specified element. This can be a ped, object or a vehicle.

Syntax

bool setElementHealth ( element theElement, float newHealth )

OOP Syntax Help! I don't understand this!

Note: This function is also a static function underneath the Element class.
Method: element:setHealth(...)
Variable: .health


Required Arguments

  • theElement: The ped, vehicle or object whose health you want to set.
  • newHealth: A float indicating the new health to set for the element.

Returns

Returns true if the new health was set successfully, or false if invalid arguments were passed.

Example

Click to collapse [-]
Server

This example adds a 'hpslap' console command that lets players "slap" others (doing 20 damage). 

function hpSlap ( sourcePlayer, command, targetPlayerName )
    -- check if the user has access to it first
    if not hasObjectPermissionTo(sourcePlayer, "command.slap", false) then
        outputChatBox ( "You cannot use this command.", sourcePlayer )
        return false
    end
    -- look up the player to be slapped
    local targetPlayer = getPlayerFromName ( targetPlayerName )
    -- if there's a player with such name,
    if targetPlayer then
        -- subtract 20 from his health
        setElementHealth ( targetPlayer, getElementHealth(targetPlayer) - 20 )
    else
        -- otherwise, output an error message
        outputChatBox ( "There is no player named " .. targetPlayerName .. "!", sourcePlayer )
    end
end
-- add our function as a handler for "hpslap"
addCommandHandler ( "hpslap", hpSlap )

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/SetElementHealth?oldid=41483"