summaryrefslogtreecommitdiffstats
path: root/MCServer/Plugins/APIDump/Hooks/OnPlayerTossingItem.lua
diff options
context:
space:
mode:
Diffstat (limited to 'MCServer/Plugins/APIDump/Hooks/OnPlayerTossingItem.lua')
-rw-r--r--MCServer/Plugins/APIDump/Hooks/OnPlayerTossingItem.lua31
1 files changed, 0 insertions, 31 deletions
diff --git a/MCServer/Plugins/APIDump/Hooks/OnPlayerTossingItem.lua b/MCServer/Plugins/APIDump/Hooks/OnPlayerTossingItem.lua
deleted file mode 100644
index 880404bf8..000000000
--- a/MCServer/Plugins/APIDump/Hooks/OnPlayerTossingItem.lua
+++ /dev/null
@@ -1,31 +0,0 @@
-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.</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 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
-}
-
-
-
-
-