OnClientPedDamage: Difference between revisions
Jump to navigation
Jump to search
Cazomino05 (talk | contribs) (Added a Compatability notice.) |
Zangomangu (talk | contribs) (Removed fixed issue) |
||
| (6 intermediate revisions by 6 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Client event}} | {{Client event}} | ||
This event is triggered whenever a [[ped]] is damaged. | This event is triggered whenever a [[ped]] is damaged. | ||
{{Note|This event is only triggered for peds that are streamed in}} | |||
==Parameters== | ==Parameters== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
| Line 11: | Line 9: | ||
*'''attacker''': A [[player]] [[element]] representing the attacker or [[vehicle]] [[element]] (when a ped falls of a bike). | *'''attacker''': A [[player]] [[element]] representing the attacker or [[vehicle]] [[element]] (when a ped falls of a bike). | ||
*'''weapon''': An integer representing the weapon ID the attacker used | *'''weapon''': An integer representing the [[Weapons|weapon ID]] the attacker used | ||
*'''bodypart''': An integer representing the bodypart the ped was damaged | *'''bodypart''': An integer representing the bodypart the ped was damaged | ||
{{BodyParts}} | {{BodyParts}} | ||
| Line 23: | Line 21: | ||
==Example== | ==Example== | ||
This example cancels any damage done to peds | |||
<syntaxhighlight lang="lua"> | |||
function cancelPedDamage ( attacker ) | |||
cancelEvent() -- cancel any damage done to peds | |||
end | |||
addEventHandler ( "onClientPedDamage", getRootElement(), cancelPedDamage ) | |||
</syntaxhighlight> | |||
==See Also== | ==See Also== | ||
Latest revision as of 10:32, 30 January 2022
This event is triggered whenever a ped is damaged.
Parameters
element attacker, int weapon, int bodypart [, float loss ]
- attacker: A player element representing the attacker or vehicle element (when a ped falls of a bike).
- weapon: An integer representing the weapon ID the attacker used
- bodypart: An integer representing the bodypart the ped was damaged
- 3: Torso
- 4: Ass
- 5: Left Arm
- 6: Right Arm
- 7: Left Leg
- 8: Right Leg
- 9: Head
- loss: A float representing the percentage of health the ped lost.
Source
The source of this event is the ped that got damaged
Cancel effect
If this event is canceled, then any damaging effects to the ped will cease.
Example
This example cancels any damage done to peds
function cancelPedDamage ( attacker ) cancelEvent() -- cancel any damage done to peds end addEventHandler ( "onClientPedDamage", getRootElement(), cancelPedDamage )
See Also
Client ped events
- onClientPedDamage
- onClientPedHeliKilled
- onClientPedHitByWaterCannon
- onClientPedVehicleEnter
- onClientPedVehicleExit
- onClientPedWasted
- onClientPedWeaponFire
- onClientPedStep
Client event functions
- triggerLatentServerEvent
- triggerServerEvent
- Shared
- addEvent
- addEventHandler
- cancelEvent
- cancelLatentEvent
- getEventHandlers
- getLatentEventHandles
- getLatentEventStatus
- removeEventHandler
- triggerEvent
- wasEventCancelled