setElementHealth | Multi Theft Auto: Wiki Skip to content
Multi Theft Auto: Wiki

setElementHealth

Client-side
Server-side
Shared

Pair: getElementHealth

Manual Review Required

Please finish this page using the corresponding Old Wiki article. Go to Contribution guidelines for more information.

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

Note

In the case of the vehicle element, the following effects appear, depending on the health value: 650: white steam 0%, black smoke 0% 450: white steam 100%, black smoke 50% 250: white steam 0%, black smoke 100% 249: fire with big black smoke

OOP Syntax Help! I don't understand this!

  • Method:element:setHealth(...)
  • Variable: .health

Syntax 

bool setElementHealth ( element theElement, float newHealth )
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

  • bool: value

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

Code Examples

shared

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 )

Issues

ID Description
414 Using setElementHealth on a dead ped makes it invincible

See Also

Element Functions
Element Events
Reference