APIDump: Documented HOOK_PLAYER_TOSSING_ITEM.
This commit is contained in:
parent
fd7c1754d0
commit
1f6498de22
@ -2894,6 +2894,29 @@ end;
|
||||
]],
|
||||
}, -- HOOK_PLAYER_RIGHT_CLICK
|
||||
|
||||
HOOK_PLAYER_TOSSING_ITEM =
|
||||
{
|
||||
CalledWhen = "A player is tossing an item. Plugin may override / refuse.",
|
||||
DefaultFnName = "OnPlayerTossingItem", -- also used as pagename
|
||||
Desc = [[
|
||||
This hook is called when a {{cPlayer|player}} has tossed an item (Q keypress). The
|
||||
{{cPickup|pickup}} has not been spawned yet. Plugins may disallow the tossing, but in that case they
|
||||
need to clean up - the player's client already thinks the item has been tossed so the
|
||||
{{cInventory|inventory}} needs to be re-sent to the player.</p>
|
||||
<p>
|
||||
To get the item that is about to be tossed, call the {{cPlayer}}:GetEquippedItem() function.
|
||||
]],
|
||||
Params =
|
||||
{
|
||||
{ Name = "Player", Type = "{{cPlayer}}", Notes = "The player tossing an item" },
|
||||
},
|
||||
Returns = [[
|
||||
If the function returns false or no value, other plugins' callbacks are called and finally MCServer
|
||||
creates the pickup for the item and tosses it, using {{cPlayer}}:TossItem. If the function returns
|
||||
true, no other callbacks are called for this event and MCServer doesn't toss the item.
|
||||
]],
|
||||
}, -- HOOK_PLAYER_TOSSING_ITEM
|
||||
|
||||
HOOK_PLAYER_USED_BLOCK =
|
||||
{
|
||||
CalledWhen = "A player has just used a block (chest, furnace…). Notification only.",
|
||||
|
Loading…
Reference in New Issue
Block a user