OnClientPlayerDamage: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
(20 intermediate revisions by 14 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">
player attacker, int weapon, int bodypart
element attacker, int weapon, 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).
*'''weapon''': An integer representing the weapon ID the attacker used
*'''weapon''': An integer representing the [[Weapons|attacker weapon]] or the [[Damage Types|damage type]].
*'''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==
{{Event_functions}}
===Client player events===
{{Client_player_events}}
===Client event functions===
{{Client_event_functions}}

Revision as of 23:01, 16 January 2019

This event is triggered whenever a player is damaged.

[[{{{image}}}|link=|]] Note: This event is only triggered for players that are streamed in

Parameters

element attacker, int weapon, int bodypart [, float loss ]
  • 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


Client event functions