OnPlayerPickupUse: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(6 intermediate revisions by 6 users not shown)
Line 1: Line 1:
[[Category:Incomplete Event]]
__NOTOC__
{{Server event}}
This event is triggered when a player is standing on a pickup while not being in a vehicle.


__NOTOC__
==Parameters==
This event is triggered when a player uses a pickup.
 
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
void onPlayerPickupUse ( pickup usedpickup ) 
pickup thePickupToUse
</syntaxhighlight>  
</syntaxhighlight>  
*'''thePickupToUse''': the [[pickup]] the [[player]] is standing on and is about to pick up.
==Source==
The [[event system#Event source|source]] of this event is the [[player]] that is standing on a 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==  
==Example==  
This example does...
This example outputs to the player that's using the pick that the pickup is either available/unavailable.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">addEventHandler("onPlayerPickupUse",root,function(pickup)
--This line does...
if(isPickupSpawned(pickup))then
blabhalbalhb --abababa
outputChatBox("The pickup your using is now available to use pick up again.",source)
--This line does this...
else
mooo
outputChatBox("This pickup might be the last pickup to use ever again.",source)
end
end)
</syntaxhighlight>
</syntaxhighlight>
{{See also/Server event|Player events}}

Latest revision as of 03:02, 27 September 2018

This event is triggered when a player is standing on a pickup while not being in a vehicle.

Parameters

pickup thePickupToUse
  • thePickupToUse: the pickup the player is standing on and is about to pick up.

Source

The source of this event is the player that is standing on a pickup.

Cancel effect

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

Example

This example outputs to the player that's using the pick that the pickup is either available/unavailable. 

addEventHandler("onPlayerPickupUse",root,function(pickup)
	if(isPickupSpawned(pickup))then
		outputChatBox("The pickup your using is now available to use pick up again.",source)
	else
		outputChatBox("This pickup might be the last pickup to use ever again.",source)
	end
end)

See Also

Player events


Event functions


Retrieved from "https://wiki.multitheftauto.com/wiki/OnPlayerPickupUse?oldid=59496"