Squirrel/Server/Events/Pickup/onPickupPickedUp

Latest revision as of 16:38, 4 November 2010

This is called when a player picks up a pick-up.

[edit] Syntax

function onPickupPickedUp( Player player, Pickup pickup )

[edit] Arguments

• player - The player that collected the pick-up
• pickup - The pickup which was collected

[edit] Returns

This event does not handle return values.

[edit] Example

This example will tell the player which pickup they have just hit.

 
function onPickupPickedUp( player, pickup )
{
     MessagePlayer( "You picked up pickup id " + pickup.ID + ", Model: " + pickup.Model, player );
     
     return 1;
}
 

[edit] Notes

The functions Pickup.ID, Pickup.Model and MessagePlayer were used in this example. More info about them can be found in the corresponding pages.

[edit] Related Events

• onPickupPickedUp
• onPickupRespawn