OnPlayerPickupHit: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(7 intermediate revisions by 5 users not shown)
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==
The [[event system#Event source|source]] of this event is the [[player]] that hit the pickup.
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==
==Cancel effect==
If this event is [[Event system#Canceling|canceled]], the player will not be able to pick up this pickup.
If this event is [[Event system#Canceling|canceled]], the player will not be able to pick up this pickup.


==Example==  
==Example==  
<!-- Explain what the example is in a single sentance -->
This example disables the use of armour pickups.
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">
<syntaxhighlight lang="lua">
--This line does...
function armourBlock(pickup)
blah()
if (getPickupType(pickup) == 1) then -- If it's an armour pickup
--This line does this...
cancelEvent() -- Cancel the event
mooo
outputChatBox("Armour pickups are disabled.", source, 255, 0, 0)
end
end
addEventHandler("onPlayerPickupHit", root, armourBlock)
</syntaxhighlight>
</syntaxhighlight>


==See Also==
{{See also/Server event|Player events}}
{{Event_functions}}
[[Category:Needs Example]]

Latest revision as of 03:02, 27 September 2018

This event is triggered when a player hits a pickup.

Parameters

pickup pickupHit

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", root, armourBlock)

See Also

Player events


Event functions


Retrieved from "https://wiki.multitheftauto.com/wiki/OnPlayerPickupHit?oldid=59494"