summaryrefslogtreecommitdiffstats
path: root/MCServer/Plugins/APIDump
diff options
context:
space:
mode:
authormadmaxoft <github@xoft.cz>2013-10-18 09:40:18 +0200
committermadmaxoft <github@xoft.cz>2013-10-18 09:40:18 +0200
commit1f6498de22dd0404e5e74faf2e304969622a06de (patch)
treee3986e46bc410ececb7e156d1a87ce518f6d5b1c /MCServer/Plugins/APIDump
parentAPIDump: Documented HOOK_PLAYER_USED_BLOCK. (diff)
downloadcuberite-1f6498de22dd0404e5e74faf2e304969622a06de.tar
cuberite-1f6498de22dd0404e5e74faf2e304969622a06de.tar.gz
cuberite-1f6498de22dd0404e5e74faf2e304969622a06de.tar.bz2
cuberite-1f6498de22dd0404e5e74faf2e304969622a06de.tar.lz
cuberite-1f6498de22dd0404e5e74faf2e304969622a06de.tar.xz
cuberite-1f6498de22dd0404e5e74faf2e304969622a06de.tar.zst
cuberite-1f6498de22dd0404e5e74faf2e304969622a06de.zip
Diffstat (limited to '')
-rw-r--r--MCServer/Plugins/APIDump/APIDesc.lua23
1 files changed, 23 insertions, 0 deletions
diff --git a/MCServer/Plugins/APIDump/APIDesc.lua b/MCServer/Plugins/APIDump/APIDesc.lua
index 1d1d0ead9..f1f9be275 100644
--- a/MCServer/Plugins/APIDump/APIDesc.lua
+++ b/MCServer/Plugins/APIDump/APIDesc.lua
@@ -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.",