flewkey/cuberite-2a
1
0
Fork 0
Code Releases Activity

APIDump: Documented HOOK_HOPPER_PULLING_ITEM.

Browse Source
This commit is contained in:
madmaxoft 2013-10-14 21:15:55 +02:00
parent bf5f4603d9
commit 9969c19060
1 changed files with 23 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
MCServer/Plugins/APIDump/APIDesc.lua
View File

@ -2511,6 +2511,29 @@ end;
]],
}, -- HOOK_HANDSHAKE
HOOK_HOPPER_PULLING_ITEM =
{
CalledWhen = "A hopper is pulling an item from another block entity.",
DefaultFnName = "OnHopperPullingItem", -- also used as pagename
Desc = [[
This callback is called whenever a hopper transfers an item from another block item into its own
internal storage. A plugin may decide to disallow the move by returning true. Note that in such a
case, the hook may be called again for the same hopper, with different slot numbers.
]],
Params =
{
{ Name = "World", Type = "{{cWorld}}", Notes = "World where the hopper resides" },
{ Name = "Hopper", Type = "{{cHopperEntity}}", Notes = "The hopper that is pulling the item" },
{ Name = "DstSlot", Type = "number", Notes = "The destination slot in the hopper's {{cItemGrid|internal storage}}" },
{ Name = "SrcBlockEntity", Type = "{{cBlockEntityWithItems}}", Notes = "The block entity that is losing the item" },
{ Name = "SrcSlot", Type = "number", Notes = "Slot in SrcBlockEntity from which the item will be pulled" },
},
Returns = [[
If the function returns false or no value, the next plugin's callback is called. If the function
returns true, no other callback is called for this event and the hopper will not pull the item.
]],
}, -- HOOK_HOPPER_PULLING_ITEM
}, -- Hooks[]