OnPlayerPickupUse: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (See Also for server events)
No edit summary
 
(3 intermediate revisions by 3 users not shown)
Line 8: Line 8:
</syntaxhighlight>  
</syntaxhighlight>  


*'''thePickupToUse''': The pickup the player is standing on and is about to pick up.
*'''thePickupToUse''': the [[pickup]] the [[player]] is standing on and is about to pick up.


<!-- Add the event's source in the section below -->
==Source==
==Source==
The [[event system#Event source|source]] of this event is the [[player]] that is standing on a pickup.
The [[event system#Event source|source]] of this event is the [[player]] that is standing on a pickup.
Line 19: Line 18:


==Example==  
==Example==  
<!-- Explain what the example is in a single sentance -->
This example outputs to the player that's using the pick that the pickup is either available/unavailable.
This example does...
<syntaxhighlight lang="lua">addEventHandler("onPlayerPickupUse",root,function(pickup)
<!-- 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 -->
if(isPickupSpawned(pickup))then
<syntaxhighlight lang="lua">
outputChatBox("The pickup your using is now available to use pick up again.",source)
--This line does...
else
blah()
outputChatBox("This pickup might be the last pickup to use ever again.",source)
--This line does this...
end
mooo
end)
</syntaxhighlight>
</syntaxhighlight>


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

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"