OnPlayerPickupHit: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
No edit summary
 
(9 intermediate revisions by 7 users not shown)
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 blahblah and is used for blahblah.
 
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
void onPlayerPickupHit ( pickup hitpickup, bool matchingDimension )     
pickup pickupHit
</syntaxhighlight>  
</syntaxhighlight>  
*'''pickupHit''': the [[pickup]] the [[player]] hit.
==Source==
The [[event system#Event source|source]] of this event is the [[player]] that hit the pickup.
==Cancel effect==
If this event is [[Event system#Canceling|canceled]], the player will not be able to pick up this pickup.


==Example==  
==Example==  
This example does...
This example disables the use of armour pickups.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--This line does...
function armourBlock(pickup)
blabhalbalhb --abababa
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/Server event|Player events}}

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