OnClientPlayerDamage: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (Enhanced argument readability) |
||
(21 intermediate revisions by 15 users not shown) | |||
Line 2: | Line 2: | ||
{{Client event}} | {{Client event}} | ||
This event is triggered whenever a player is damaged. | 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"> | ||
element attacker, int damage_causing, int bodypart [, float loss ] | |||
</syntaxhighlight> | </syntaxhighlight> | ||
*'''attacker''': A [[player]] [[element]] representing the attacker. | *'''attacker''': A [[player]] [[element]] representing the attacker or [[vehicle]] [[element]] (when being run over or falling off a bike). | ||
*''' | *'''damage_causing''': An [[int]] representing the cause of damage, either a [[Weapons|attacker weapon]], or some other [[Damage Types|types of damage]]. | ||
*'''bodypart''': An integer representing the bodypart the player was damaged | *'''bodypart''': An integer representing the bodypart the player was damaged. | ||
{{BodyParts}} | {{BodyParts}} | ||
{{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 [[player]] that got damaged | The [[event system#Event source|source]] of this event is the [[player]] that got damaged. (Streamed in players only) | ||
==Cancel effect== | ==Cancel effect== | ||
Line 29: | Line 32: | ||
addEventHandler ( "onClientPlayerDamage", getLocalPlayer(), stopMinigunDamage ) | addEventHandler ( "onClientPlayerDamage", getLocalPlayer(), stopMinigunDamage ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
==Issues== | |||
{{Issues| | |||
{{Issue|8082|(Fixed in r9762) Custom weapons don't fully work with onClientPlayerDamage}} | |||
}} | |||
==See Also== | ==See Also== | ||
{{ | ===Client player events=== | ||
{{Client_player_events}} | |||
===Client event functions=== | |||
{{Client_event_functions}} |
Revision as of 04:12, 13 June 2020
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 damage_causing, int bodypart [, float loss ]
- attacker: A player element representing the attacker or vehicle element (when being run over or falling off a bike).
- damage_causing: An int representing the cause of damage, either a attacker weapon, or some other types of damage.
- 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
Shared
- addEvent
- addEventHandler
- cancelEvent
- cancelLatentEvent
- getEventHandlers
- getLatentEventHandles
- getLatentEventStatus
- removeEventHandler
- triggerEvent
- wasEventCancelled