OnClientPlayerDamage: Difference between revisions
Jump to navigation
Jump to search
LordAzamath (talk | contribs) (onClientPedDamage) |
No edit summary |
||
| (15 intermediate revisions by 11 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Client event}} | {{Client event}} | ||
This event is triggered whenever a | This event is triggered whenever a player is damaged. | ||
{{Note|This event is only triggered for players that are streamed in}} | |||
==Parameters== | ==Parameters== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
| Line 8: | Line 8: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
*'''attacker''': A [[player]] [[element]] representing the attacker or [[vehicle]] [[element]] (when | *'''attacker''': A [[player]] [[element]] representing the attacker or [[vehicle]] [[element]] (when being run over or falling off a bike). | ||
*'''weapon''': An integer representing the weapon | *'''weapon''': An integer representing the [[Weapons|attacker weapon]] or the [[Damage Types|damage type]]. | ||
*'''bodypart''': An integer representing the bodypart the | *'''bodypart''': An integer representing the bodypart the player was damaged. | ||
{{BodyParts}} | {{BodyParts}} | ||
*'''loss''': A float representing the percentage of health the | {{New feature/item|3|1.0|| | ||
*'''loss''': A float representing the percentage of health the player lost. | |||
}} | |||
==Source== | ==Source== | ||
The [[event system#Event source|source]] of this event is the [[ | The [[event system#Event source|source]] of this event is the [[player]] that got damaged. (Streamed in players only) | ||
==Cancel effect== | ==Cancel effect== | ||
If this event is [[Event system#Canceling|canceled]], then any damaging effects to the | If this event is [[Event system#Canceling|canceled]], then any damaging effects to the local player will cease. | ||
==Example== | ==Example== | ||
This example prevents any damage from the minigun. | |||
<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> | |||
==Issues== | |||
{{Issues| | |||
{{Issue|8082|(Fixed in r9762) Custom weapons don't fully work with onClientPlayerDamage}} | |||
}} | |||
==See Also== | ==See Also== | ||
===Client | ===Client player events=== | ||
{{ | {{Client_player_events}} | ||
===Client event functions=== | ===Client event functions=== | ||
{{Client_event_functions}} | {{Client_event_functions}} | ||
Revision as of 23:01, 16 January 2019
This event is triggered whenever a player is damaged.
| Note: This event is only triggered for players that are streamed in |
Parameters
element attacker, int weapon, int bodypart [, float loss ]
- attacker: A player element representing the attacker or vehicle element (when being run over or falling off a bike).
- weapon: An integer representing the attacker weapon or the damage type.
- bodypart: An integer representing the bodypart the player 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 player lost.
Source
The source of this event is the player that got damaged. (Streamed in players only)
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 )
Issues
| Issue ID | Description |
|---|---|
| #8082 | (Fixed in r9762) Custom weapons don't fully work with onClientPlayerDamage |
See Also
Client player events
- onClientPlayerChangeNick
- onClientPlayerChoke
- onClientPlayerDamage
- onClientPlayerHeliKilled
- onClientPlayerHitByWaterCannon
- onClientPlayerJoin
- onClientPlayerPickupHit
- onClientPlayerPickupLeave
- onClientPlayerQuit
- onClientPlayerRadioSwitch
- onClientPlayerSpawn
- onClientPlayerStealthKill
- onClientPlayerStuntFinish
- onClientPlayerStuntStart
- onClientPlayerTarget
- onClientPlayerVehicleEnter
- onClientPlayerVehicleExit
- onClientPlayerVoicePause
- onClientPlayerVoiceResumed
- onClientPlayerVoiceStart
- onClientPlayerVoiceStop
- onClientPlayerWasted
- onClientPlayerWeaponFire
- onClientPlayerWeaponSwitch
Client event functions
- addEvent
- addEventHandler
- cancelEvent
- cancelLatentEvent
- getEventHandlers
- getLatentEventHandles
- getLatentEventStatus
- removeEventHandler
- triggerEvent
- triggerLatentServerEvent
- triggerServerEvent
- wasEventCancelled