Difference between revisions of "OnPlayerPickupHit"

From Multi Theft Auto: Wiki
(Example)
m (There is no "matchingDimension" in onPlayerPickupHit!)
Line 5: Line 5:
 
==Parameters==
 
==Parameters==
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
pickup pickupHit, bool matchingDimension
+
pickup pickupHit
 
</syntaxhighlight>  
 
</syntaxhighlight>  
  
 
*'''pickupHit''': The pickup the player hit
 
*'''pickupHit''': The pickup the player hit
*'''matchingDimension''': Whether the player and the pickup he hit are in the same dimension
 
  
 
==Source==
 
==Source==
Line 23: Line 22:
 
<!-- 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 -->
 
<!-- 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">
 
<syntaxhighlight lang="lua">
function armourBlock(pickup,dimension)
+
function armourBlock(pickup)
 
if (getPickupType(pickup) == 1) then -- If it's an armour pickup
 
if (getPickupType(pickup) == 1) then -- If it's an armour pickup
 
cancelEvent() -- Cancel the event
 
cancelEvent() -- Cancel the event

Revision as of 15:21, 29 November 2017

This event is triggered when a player hits a pickup.

Parameters

pickup pickupHit
  • pickupHit: The pickup the player hit

Source

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

Cancel effect

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

Example

This example disables the use of armour pickups.

function armourBlock(pickup)
	if (getPickupType(pickup) == 1) then -- If it's an armour pickup
		cancelEvent() -- Cancel the event
		outputChatBox("Armour pickups are disabled.",source,255,0,0)
	end
end
addEventHandler("onPlayerPickupHit",getRootElement(),armourBlock)

See Also

Player events

Event functions