OnPickupHit: Difference between revisions
Jump to navigation
Jump to search
m (Added dimension function param) |
No edit summary |
||
Line 5: | Line 5: | ||
==Parameters== | ==Parameters== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
player thePlayer | player thePlayer | ||
</syntaxhighlight> | </syntaxhighlight> | ||
*'''thePlayer''': a player [[element]] referring to the player who moved over the pickup. | *'''thePlayer''': a player [[element]] referring to the player who moved over the pickup. | ||
==Source== | ==Source== |
Revision as of 11:03, 22 June 2009
This event is triggered when a player hits a pickup.
Parameters
player thePlayer
- thePlayer: a player element referring to the player who moved over the pickup.
Source
The source of this event is the pickup that was hit by the player.
Cancel effect
If this event is canceled, the pickup does not disappear and the player does not receive its bonus.
Example
This example creates a pickup and outputs a message to the chat box when a player walks over it.
local aPickup = createPickup ( 10.0, 10.0, 10.0, 2, 31, 3000, 50 ) --Create an M4 weapon pickup when script starts function pickedUpWeaponCheck ( player ) outputChatBox ( "You have picked up a M4.", player ) --Display this message in the chat box end addEventHandler ( "onPickupHit", aPickup, pickedUpWeaponCheck )
See Also
Pickup events
Event functions
- addEvent
- addEventHandler
- cancelEvent
- cancelLatentEvent
- getEventHandlers
- getLatentEventHandles
- getLatentEventStatus
- removeEventHandler
- triggerEvent
- wasEventCancelled