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

APIDump: Documented HOOK_HOPPER_PUSHING_ITEM.

Browse Source
This commit is contained in:
madmaxoft 2013-10-14 21:45:08 +02:00
parent 9969c19060
commit 315af4450d
1 changed files with 28 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -2516,9 +2516,10 @@ end;
CalledWhen = "A hopper is pulling an item from another block entity.", CalledWhen = "A hopper is pulling an item from another block entity.",
DefaultFnName = "OnHopperPullingItem", -- also used as pagename DefaultFnName = "OnHopperPullingItem", -- also used as pagename
Desc = [[ Desc = [[
This callback is called whenever a hopper transfers an item from another block item into its own This callback is called whenever a {{cHopperEntity|hopper}} transfers an {{cItem|item}} from another
internal storage. A plugin may decide to disallow the move by returning true. Note that in such a block entity into its own internal storage. A plugin may decide to disallow the move by returning
case, the hook may be called again for the same hopper, with different slot numbers. true. Note that in such a case, the hook may be called again for the same hopper, with different
slot numbers.
]], ]],
Params = Params =
{ {
@ -2534,6 +2535,30 @@ end;
]], ]],
}, -- HOOK_HOPPER_PULLING_ITEM }, -- HOOK_HOPPER_PULLING_ITEM
HOOK_HOPPER_PUSHING_ITEM =
{
CalledWhen = "A hopper is pushing an item into another block entity. ",
DefaultFnName = "OnHopperPushingItem", -- also used as pagename
Desc = [[
This hook is called whenever a {{cHopperEntity|hopper}} transfers an {{cItem|item}} from its own
internal storage into another block entity. 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 and block, with
different slot numbers.
]],
Params =
{
{ Name = "World", Type = "{{cWorld}}", Notes = "World where the hopper resides" },
{ Name = "Hopper", Type = "{{cHopperEntity}}", Notes = "The hopper that is pushing the item" },
{ Name = "SrcSlot", Type = "number", Notes = "Slot in the hopper that will lose the item" },
{ Name = "DstBlockEntity", Type = "{{cBlockEntityWithItems}}", Notes = " The block entity that will receive the item" },
{ Name = "DstSlot", Type = "number", Notes = " Slot in DstBlockEntity's internal storage where the item will be stored" },
},
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 push the item.
]],
}, -- HOOK_HOPPER_PUSHING_ITEM
}, -- Hooks[] }, -- Hooks[]