OnClientPlayerHitByWaterCannon: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (→Cancel effect) |
||
| (9 intermediate revisions by 6 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Client event}} | {{Client event}} | ||
This event is fired when a player is hit by a water cannon. | This event is fired when a player is hit by a water cannon. | ||
{{Note|This event is only triggered for players that are streamed in}} | |||
==Parameters== | ==Parameters== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
| Line 10: | Line 11: | ||
==Source== | ==Source== | ||
The source of this event is the vehicle who shot the water cannon. | 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: | |||
* Players flying off | |||
* Players being knocked down | |||
==Cancel effect== | |||
If this event is [[Event system#Canceling|canceled]], the [[player]] will not be knocked down. | |||
==Example== | ==Example== | ||
| Line 15: | Line 24: | ||
This example outputs a message when you are hit by a water cannon | This example outputs a message when you are hit by a water cannon | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
addEventHandler("onClientPlayerHitByWaterCannon",getRootElement(), | |||
function(player) | |||
local driver = getVehicleOccupant(source) | |||
if isElement(driver) then | |||
outputChatBox(getPlayerName(player).." is hit by the cannon of "..getPlayerName(driver).."'s vehicle.") | |||
end | |||
end | |||
) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
</section> | </section> | ||
Latest revision as of 01:57, 7 April 2018
This event is fired when a player is hit by a water cannon.
| Note: This event is only triggered for players that are streamed in |
Parameters
player playerHit
- playerHit: the player 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:
- Players flying off
- Players being knocked down
Cancel effect
If this event is canceled, the player will not be knocked down.
Example
Click to collapse [-]
ClientThis example outputs a message when you are hit by a water cannon
addEventHandler("onClientPlayerHitByWaterCannon",getRootElement(),
function(player)
local driver = getVehicleOccupant(source)
if isElement(driver) then
outputChatBox(getPlayerName(player).." is hit by the cannon of "..getPlayerName(driver).."'s vehicle.")
end
end
)
Requirements
| Minimum server version | n/a |
|---|---|
| Minimum client version | 1.3.0-9.03931 |
Note: Using this feature requires the resource to have the above minimum version declared in the meta.xml <min_mta_version> section. e.g. <min_mta_version client="1.3.0-9.03931" />
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
- addEvent
- addEventHandler
- cancelEvent
- cancelLatentEvent
- getEventHandlers
- getLatentEventHandles
- getLatentEventStatus
- removeEventHandler
- triggerEvent
- triggerLatentServerEvent
- triggerServerEvent
- wasEventCancelled