APIDump: Documented HOOK_HOPPER_PUSHING_ITEM.
This commit is contained in:
parent
9969c19060
commit
315af4450d
@ -2516,9 +2516,10 @@ end;
|
||||
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.
|
||||
This callback is called whenever a {{cHopperEntity|hopper}} transfers an {{cItem|item}} from another
|
||||
block entity 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 =
|
||||
{
|
||||
@ -2534,6 +2535,30 @@ end;
|
||||
]],
|
||||
}, -- 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[]
|
||||
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user