OnPickupHit: Difference between revisions
Jump to navigation
Jump to search
(Added new template, improved example a bit.) |
No edit summary |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Server event}} | {{Server event}} | ||
This event is triggered when a [[player]] hits a [[pickup]]. | This event is triggered when a [[player]] hits a [[pickup]]. | ||
| Line 15: | Line 14: | ||
==Cancel effect== | ==Cancel effect== | ||
If this event is [[Event system#Canceling|canceled]], the pickup does not disappear and the player | If this event is [[Event system#Canceling|canceled]], the pickup does not disappear and the player does not receive its bonus. | ||
==Example== | ==Example== | ||
Revision as of 04:58, 30 December 2007
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
- addEvent
- addEventHandler
- cancelEvent
- cancelLatentEvent
- getEventHandlers
- getLatentEventHandles
- getLatentEventStatus
- removeEventHandler
- triggerEvent
- wasEventCancelled