From dac97826f7d0c9b9135c1a08c4d5f16b61494bd1 Mon Sep 17 00:00:00 2001 From: Mattes D Date: Wed, 26 Aug 2015 10:58:51 +0200 Subject: Renamed output directory to Server --- .../Plugins/APIDump/Hooks/OnPlayerTossingItem.lua | 31 ++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 Server/Plugins/APIDump/Hooks/OnPlayerTossingItem.lua (limited to 'Server/Plugins/APIDump/Hooks/OnPlayerTossingItem.lua') diff --git a/Server/Plugins/APIDump/Hooks/OnPlayerTossingItem.lua b/Server/Plugins/APIDump/Hooks/OnPlayerTossingItem.lua new file mode 100644 index 000000000..880404bf8 --- /dev/null +++ b/Server/Plugins/APIDump/Hooks/OnPlayerTossingItem.lua @@ -0,0 +1,31 @@ +return +{ + 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. 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.

+

+ 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 Cuberite + creates the pickup for the item and tosses it, using {{cPlayer}}:TossHeldItem, {{cPlayer}}:TossEquippedItem, + or {{cPlayer}}:TossPickup. If the function returns true, no other callbacks are called for this event + and Cuberite doesn't toss the item. + ]], + }, -- HOOK_PLAYER_TOSSING_ITEM +} + + + + + -- cgit v1.2.3