OnPlayerPickupHit: Difference between revisions

Revision as of 05:37, 30 December 2007

This event is triggered when a player hits a pickup.

pickup pickupHit, bool matchingDimension

pickupHit: The pickup the player hit
matchingDimension: Whether the player and the pickup he hit are in the same dimension

The source of this event is the player that hit the pickup.

If this event is canceled, the player will not be able to pick up this pickup.

This example does...

--This line does...
blah()
--This line does this...
mooo

@@ Line 1: / Line 1: @@
-[[Category:Incomplete Event]]
+__NOTOC__
+{{Server event}}
+This event is triggered when a [[player]] hits a [[pickup]].
-__NOTOC__
+==Parameters==
-This event is triggered when a player hits a pickup.
-==Syntax==
 <syntaxhighlight lang="lua">
-void onPlayerPickupHit ( pickup hitpickup, bool matchingDimension )
+pickup pickupHit, bool matchingDimension
 </syntaxhighlight>
+*'''pickupHit''': The pickup the player hit
+*'''matchingDimension''': Whether the player and the pickup he hit are in the same dimension
+==Source==
+The [[event system#Event source|source]] of this event is the [[player]] that hit the pickup.
+<!-- Only include this section below if cancelling the event has any effect. If you don't know if it does, ask a dev! -->
+==Cancel effect==
+If this event is [[Event system#Canceling|canceled]], the player will not be able to pick up this pickup.
 ==Example==
+<!-- Explain what the example is in a single sentance -->
 This example does...
+<!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized -->
 <syntaxhighlight lang="lua">
 --This line does...
-blabhalbalhb --abababa
+blah()
 --This line does this...
 mooo
 </syntaxhighlight>
+==See Also==
+{{Event_functions}}
+[[Category:Needs Example]]