SetElementHealth: Difference between revisions

Latest revision as of 15:41, 24 July 2023

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

[[{{{image}}}\|link=\|]]	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

Syntax

bool setElementHealth ( element theElement, float newHealth )

OOP Syntax Help! I don't understand this!

Method: element:setHealth(...)

Variable: .health

Counterpart: getElementHealth

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 )

Click to collapse [-]

Example 1

This example setting health by a command.

function Health(player, command, amount)
    setElementHealth(player, tonumber(amount))
end
addCommandHandler("set", Health)

Issues

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

@@ Line 1: / Line 1: @@
 {{Server client function}}
 __NOTOC__
-This function sets the health for the specified [[element]]. This can be a [[player]] or a [[vehicle]].
+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
+}}
 ==Syntax==
@@ Line 7: / Line 13: @@
 bool setElementHealth ( element theElement, float newHealth )
 </syntaxhighlight>
+{{OOP||[[element]]:setHealth|health|getElementHealth}}
 ===Required Arguments===
-*'''theElement:''' The [[player]] or [[vehicle]] whose health you want to set.
+*'''theElement:''' The [[ped]], [[vehicle]] or [[object]] whose health you want to set.
 *'''newHealth:''' A float indicating the new health to set for the element.
@@ Line 40: / Line 47: @@
 </syntaxhighlight>
 </section>
+<section name="Example 1" class="server" show="true">
+This example setting health by a command.
+<syntaxhighlight lang="lua">
+function Health(player, command, amount)
+    setElementHealth(player, tonumber(amount))
+end
+addCommandHandler("set", Health)
+</syntaxhighlight>
+</section>
+==Issues==
+{{Issues|
+{{Issue|414|Using setElementHealth on a dead ped makes it invincible}}
+}}
 ==See Also==
 {{Element functions}}