OnClientPlayerDamage: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Undo revision 36277 by MOJRM-511 (talk))
Line 3: Line 3:
This event is triggered whenever a player is damaged.
This event is triggered whenever a player is damaged.


^_^
==Parameters==
<syntaxhighlight lang="lua">
element attacker, int weapon, int bodypart [, float loss ]
</syntaxhighlight>
 
*'''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
*'''bodypart''': An integer representing the bodypart the player was damaged
{{BodyParts}}
{{New feature/item|3|1.0||
*'''loss''': A float representing the percentage of health the player lost.
}}


==Source==
==Source==

Revision as of 00:13, 2 June 2013

This event is triggered whenever a player is damaged.

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 weapon ID the attacker used
  • 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 == MOJRM-511 ) then --if the weapon used was the MOJRM-511
		cancelEvent() --cancel the event
	end
end
addEventHandler ( "onClientPlayerDamage", getLocalPlayer(), stopMinigunDamage )

See Also

Client player events


Client event functions