OnClientPedHitByWaterCannon: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(Remove obsolete Requirements section)
 
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Client event}}
{{Client event}}
{{Needs Example}}
This event is fired when a ped is hit by a water cannon.
This event is fired when a ped is hit by a water cannon. Also note that this event is only triggered for ped nearby the local player's camera. This is due to elements far away being streamed out.
{{Note|This event is only triggered for peds that are streamed in}}
{{Note|This event is only triggered for peds that are streamed in}}
==Parameters==
==Parameters==
Line 19: Line 18:


==Cancel effect==
==Cancel effect==
If this event is [[Event system#Canceling|canceled]], the Ped will not be knocked down
If this event is [[Event system#Canceling|canceled]], the ped will not be knocked down


==Example==
==Example==
<section class="client" name="Client" show="true">
<section class="client" name="Client" show="true">
This example does nothing
This example says who got hit by a water cannon.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
-- todo
function outputPlayerHitByWater(thePed)
if (getElementType(thePed) ~= "player") then
return false -- This event is for peds and players but this example only wants players
end
local hitPed = getPlayerName(thePed)
outputChatBox(hitPed.." got hit by a water cannon!", 255, 0, 0)
end
addEventHandler("onClientPedHitByWaterCannon", root, outputPlayerHitByWater)
</syntaxhighlight>
</syntaxhighlight>
</section>
</section>
==Requirements==
{{Requirements|n/a|1.3.0-9.03931|}}


==See Also==
==See Also==

Latest revision as of 17:04, 7 November 2024

This event is fired when a ped is hit by a water cannon.

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

Parameters

ped pedHit
  • pedHit: the ped which got shot by the water cannon

Source

The source of this event is the vehicle who shot the water cannon.

Type

This event is a pre reaction event meaning it occurs before any game level reaction to the collision which include:

  • Peds flying off
  • Peds being knocked down

Cancel effect

If this event is canceled, the ped will not be knocked down

Example

Click to collapse [-]
Client

This example says who got hit by a water cannon.

function outputPlayerHitByWater(thePed)
	if (getElementType(thePed) ~= "player") then
		return false -- This event is for peds and players but this example only wants players
	end
	local hitPed = getPlayerName(thePed)
	outputChatBox(hitPed.." got hit by a water cannon!", 255, 0, 0)
end
addEventHandler("onClientPedHitByWaterCannon", root, outputPlayerHitByWater)
 

See Also

Client ped events


Client event functions