OnClientPlayerDamage: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(onClientPedDamage)
(Undo revision 19372 by LordAzamath (Talk) edited wrong page)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Client event}}
{{Client event}}
This event is triggered whenever a [[ped]] is damaged.
This event is triggered whenever a player is damaged.


==Parameters==
==Parameters==
Line 8: Line 8:
</syntaxhighlight>  
</syntaxhighlight>  


*'''attacker''': A [[player]] [[element]] representing the attacker or [[vehicle]] [[element]] (when a ped falls of a bike).
*'''attacker''': A [[player]] [[element]] representing the attacker or [[vehicle]] [[element]] (when you fall of a bike).
*'''weapon''': An integer representing the weapon ID the attacker used
*'''weapon''': An integer representing the weapon ID the attacker used
*'''bodypart''': An integer representing the bodypart the ped was damaged
*'''bodypart''': An integer representing the bodypart the player was damaged
{{BodyParts}}
{{BodyParts}}
*'''loss''': A float representing the percentage of health the ped lost.
*'''loss''': A float representing the percentage of health the player lost. ('''from DP3''')


==Source==
==Source==
The [[event system#Event source|source]] of this event is the [[ped]] that got damaged
The [[event system#Event source|source]] of this event is the [[player]] that got damaged


==Cancel effect==
==Cancel effect==
If this event is [[Event system#Canceling|canceled]], then any damaging effects to the ped will cease.
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>


==See Also==
==See Also==
===Client ped events===
===Client player events===
{{Client_ped_events}}
{{Client_player_events}}
===Client event functions===
===Client event functions===
{{Client_event_functions}}
{{Client_event_functions}}

Revision as of 15:05, 2 May 2009

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 you fall of 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. (from DP3)

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

Client player events


Client event functions