Squirrel/Server/Events/Pickup/onPickupPickedUp
From Liberty Unleashed Wiki
(Difference between revisions)
m |
|||
| Line 1: | Line 1: | ||
| − | + | {{Squirrel/Title|oonPickupPickedUp}} | |
| − | This is called when a player | + | This is called when a player picks up a pick-up. |
== Syntax == | == Syntax == | ||
| − | <code>function onPickupPickedUp( player, pickup )</code> | + | <code>function onPickupPickedUp( Player player, Pickup pickup )</code> |
| − | == | + | === Arguments === |
| − | * '''player''' - The player that collected the pick-up | + | * '''player''' - The player that collected the pick-up |
| − | * '''pickup''' - The pickup which was collected | + | * '''pickup''' - The pickup which was collected |
| + | === Returns === | ||
| + | |||
| + | This event does not handle return values. | ||
== Example == | == Example == | ||
| Line 20: | Line 23: | ||
{ | { | ||
MessagePlayer( "You picked up pickup id " + pickup.ID + ", Model: " + pickup.Model, player ); | MessagePlayer( "You picked up pickup id " + pickup.ID + ", Model: " + pickup.Model, player ); | ||
| + | |||
| + | return 1; | ||
} | } | ||
</code> | </code> | ||
| Line 25: | Line 30: | ||
=== Notes === | === Notes === | ||
| − | The | + | The functions [[Squirrel/Server/Functions/Pickups/ID|Pickup.ID]], [[Squirrel/Server/Functions/Pickups/Model|Pickup.Model]] and [[Squirrel/Server/Functions/Messages/MessagePlayer|MessagePlayer]] were used in in this example. More info about them can be found in the corresponding pages. |
== Related Events == | == Related Events == | ||
{{Squirrel/Server/Events/Pickup}} | {{Squirrel/Server/Events/Pickup}} | ||
Revision as of 16:33, 4 November 2010
This is called when a player picks up a pick-up.
Syntax
Arguments
- player - The player that collected the pick-up
- pickup - The pickup which was collected
Returns
This event does not handle return values.
Example
This example will tell the player which pickup they have just hit.
Notes
The functions Pickup.ID, Pickup.Model and MessagePlayer were used in in this example. More info about them can be found in the corresponding pages.
Related Events
- onPickupPickedUp
- onPickupRespawn
