SetElementHealth
From Multi Theft Auto: Wiki
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:
|
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 [-]
ServerThis 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 1This example setting health by a command.
function Health(player, command, amount) setElementHealth(player, tonumber(amount)) end addCommandHandler("set", Health)
See Also
- attachElements
- clearElementVisibleTo
- cloneElement
- createElement
- destroyElement
- detachElements
- getAllElementData
- getAttachedElements
- getElementAlpha
- getElementAttachedOffsets
- getElementAttachedTo
- getElementCollisionsEnabled
- getElementByID
- getElementByIndex
- getElementChild
- getElementChildren
- getElementChildrenCount
- getElementColShape
- getElementData
- getElementDimension
- getElementHealth
- getElementID
- getElementInterior
- getElementMatrix
- getElementModel
- getElementParent
- getElementPosition
- getElementRotation
- getElementSyncer
- getElementType
- getElementVelocity
- getElementZoneName
- getElementsByType
- getElementsWithinColShape
- getLowLODElement
- getRootElement
- isElement
- isElementAttached
- isElementCallPropagationEnabled
- isElementDoubleSided
- isElementFrozen
- isElementInWater
- isElementLowLOD
- isElementVisibleTo
- isElementWithinColShape
- isElementWithinMarker
- removeElementData
- setElementAlpha
- setElementAngularVelocity
- getElementAngularVelocity
- setElementAttachedOffsets
- setElementCallPropagationEnabled
- setElementCollisionsEnabled
- setElementData
- setElementDimension
- setElementDoubleSided
- setElementFrozen
- setElementHealth
- setElementID
- setElementInterior
- setElementModel
- setElementParent
- setElementPosition
- setElementRotation
- setElementSyncer
- setElementVelocity
- setElementVisibleTo
- setLowLODElement