OnPickupHit

This event is triggered when a player hits a pickup.

Parameters

player thePlayer, bool matchingDimension

• thePlayer: a player element referring to the player who moved over the pickup.
• matchingDimension: Whether the player and the pickup he hit are in the same dimension

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

• onPickupHit
• onPickupLeave
• onPickupSpawn
• onPickupUse

Event functions

• addEvent
• addEventHandler
• cancelEvent
• cancelLatentEvent
• getEventHandlers
• getLatentEventHandles
• getLatentEventStatus
• removeEventHandler
• triggerEvent
• wasEventCancelled