OnClientPlayerDamage: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
Line 1: | Line 1: | ||
__NOTOC__ | |||
{{Client event}} | |||
This event is triggered whenever a player is damaged. | |||
==Parameters== | |||
== | |||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
player attacker, int weapon, int bodypart | |||
</syntaxhighlight> | </syntaxhighlight> | ||
*'''attacker''': A [[player]] [[element]] representing the attacker. | |||
*'''weapon''': An integer representing the weapon ID the attacker used | |||
*'''bodypart''': An integer representing the bodypart the player was damaged | |||
==Source== | |||
The [[event system#Event source|source]] of this event is the [[player]] that got damaged | |||
==Cancel effect== | |||
If this event is [[Event system#Canceling|canceled]], then any damaging effects to the local player will cease. | |||
==Example== | ==Example== | ||
This example | This example prevents any damage from the minigun. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
-- | function stopMinigunDamage ( attacker, weapon, bodypart ) | ||
if ( weapon == 38 ) then --if the weapon used was the minigun | |||
cancelEvent() --cancel the event | |||
end | |||
end | |||
addEventHandler ( "onClientPlayerDamage", getLocalPlayer(), stopMinigunDamage ) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
==See Also== | |||
{{Event_functions}} |
Revision as of 13:40, 22 October 2007
This event is triggered whenever a player is damaged.
Parameters
player attacker, int weapon, int bodypart
- attacker: A player element representing the attacker.
- weapon: An integer representing the weapon ID the attacker used
- bodypart: An integer representing the bodypart the player was damaged
Source
The source of this event is the player that got damaged
Cancel effect
If this event is canceled, then any damaging effects to the local player will cease.
Example
This example prevents any damage from the minigun.
function stopMinigunDamage ( attacker, weapon, bodypart ) if ( weapon == 38 ) then --if the weapon used was the minigun cancelEvent() --cancel the event end end addEventHandler ( "onClientPlayerDamage", getLocalPlayer(), stopMinigunDamage )
See Also
- addEvent
- addEventHandler
- cancelEvent
- cancelLatentEvent
- getEventHandlers
- getLatentEventHandles
- getLatentEventStatus
- removeEventHandler
- triggerEvent
- wasEventCancelled