OnPickupUse: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (Edited language change) |
||
| (14 intermediate revisions by 9 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
This event is triggered when a player stands on a pickup while not in a vehicle. | {{Server event}} | ||
This event is triggered when a [[player]] stands on a [[pickup]] while not in a [[vehicle]]. | |||
{{Tip|Pickups use [[colshape]]s, you can get the [[colshape]] of the [[pickup]] with [[getElementColShape]] and use [[colshape]] [[event]]s to it.}} | |||
== | ==Parameters== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
player playerWhoUsed | |||
</syntaxhighlight> | </syntaxhighlight> | ||
*'''playerWhoUsed''': a [[player]] element referring to the player who used the [[pickup]]. | |||
==Source== | |||
The [[event system#Event source|source]] of this event is the [[pickup]] that is getting used by the player. | |||
===Canceling=== | ===Canceling=== | ||
If this event is [[ | If this event is [[Event system #Canceling|canceled]], the player will not be given the item they picked up. | ||
==Example== | ==Example== | ||
This example outputs a message to the chatbox when a player uses a pickup. | |||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
function pickupUse( thePlayer ) | |||
function pickupUse ( thePlayer ) | outputChatBox( getPlayerName( thePlayer ) .. " used a pickup!" ) | ||
outputChatBox ( | |||
end | end | ||
addEventHandler( "onPickupUse", root, pickupUse ) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
{{See also/Server event|Pickup events}} | |||
[[ru:onPickupUse]] | |||
Latest revision as of 12:13, 8 June 2022
This event is triggered when a player stands on a pickup while not in a vehicle.
| Tip: Pickups use colshapes, you can get the colshape of the pickup with getElementColShape and use colshape events to it. |
Parameters
player playerWhoUsed
Source
The source of this event is the pickup that is getting used by the player.
Canceling
If this event is canceled, the player will not be given the item they picked up.
Example
This example outputs a message to the chatbox when a player uses a pickup.
function pickupUse( thePlayer )
outputChatBox( getPlayerName( thePlayer ) .. " used a pickup!" )
end
addEventHandler( "onPickupUse", root, pickupUse )
See Also
Pickup events