OnPlayerPickupHit: Difference between revisions
Jump to navigation
Jump to search
m (See Also for server events) |
|||
| Line 20: | Line 20: | ||
==Example== | ==Example== | ||
<!-- Explain what the example is in a single sentance --> | <!-- Explain what the example is in a single sentance --> | ||
This example | This example disables the use of armour pickups. | ||
<!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized --> | <!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized --> | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
-- | function armourBlock(pickup,dimension) | ||
if (getPickupType(pickup) == 1) then -- If it's an armour pickup | |||
-- | cancelEvent() -- Cancel the event | ||
outputChatBox("Armour pickups are disabled.",source,255,0,0) | |||
end | |||
end | |||
addEventHandler("onPlayerPickupHit",getRootElement(),armourBlock) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
{{See also/Server event|Player events}} | {{See also/Server event|Player events}} | ||
Revision as of 04:16, 19 August 2010
This event is triggered when a player hits a pickup.
Parameters
pickup pickupHit, bool matchingDimension
- pickupHit: The pickup the player hit
- matchingDimension: Whether the player and the pickup he hit are in the same dimension
Source
The source of this event is the player that hit the pickup.
Cancel effect
If this event is canceled, the player will not be able to pick up this pickup.
Example
This example disables the use of armour pickups.
function armourBlock(pickup,dimension)
if (getPickupType(pickup) == 1) then -- If it's an armour pickup
cancelEvent() -- Cancel the event
outputChatBox("Armour pickups are disabled.",source,255,0,0)
end
end
addEventHandler("onPlayerPickupHit",getRootElement(),armourBlock)
See Also
Player events
- onPlayerACInfo
- onPlayerBan
- onPlayerChangeNick
- onPlayerChat
- onPlayerClick
- onPlayerCommand
- onPlayerConnect
- onPlayerContact
- onPlayerDamage
- onPlayerJoin
- onPlayerLogin
- onPlayerLogout
- onPlayerMarkerHit
- onPlayerMarkerLeave
- onPlayerModInfo
- onPlayerMute
- onPlayerNetworkStatus
- onPlayerPickupHit
- onPlayerPickupLeave
- onPlayerPickupUse
- onPlayerPrivateMessage
- onPlayerQuit
- onPlayerScreenShot
- onPlayerSpawn
- onPlayerStealthKill
- onPlayerTarget
- onPlayerUnmute
- onPlayerVehicleEnter
- onPlayerVehicleExit
- onPlayerVoiceStart
- onPlayerVoiceStop
- onPlayerWasted
- onPlayerWeaponFire
- onPlayerWeaponSwitch
Event functions
- addEvent
- addEventHandler
- cancelEvent
- cancelLatentEvent
- getCancelReason
- getEventHandlers
- getLatentEventHandles
- getLatentEventStatus
- removeEventHandler
- triggerEvent
- triggerClientEvent
- triggerLatentClientEvent
- wasEventCancelled