HOOK_HOPPER_PULLING_ITEM


Index:
Articles
Classes
Hooks

Quick navigation:
BLOCK_SPREAD
BLOCK_TO_PICKUPS
BREWING_COMPLETED
BREWING_COMPLETING
CHAT
CHUNK_AVAILABLE
CHUNK_GENERATED
CHUNK_GENERATING
CHUNK_UNLOADED
CHUNK_UNLOADING
COLLECTING_PICKUP
CRAFTING_NO_RECIPE
DISCONNECT
DROPSPENSE
ENTITY_ADD_EFFECT
ENTITY_CHANGED_WORLD
ENTITY_CHANGING_WORLD
ENTITY_TELEPORT
EXECUTE_COMMAND
EXPLODED
EXPLODING
HANDSHAKE
HOPPER_PULLING_ITEM
HOPPER_PUSHING_ITEM
KILLED
KILLING
LOGIN
LOGIN_FORGE
PLAYER_ANIMATION
PLAYER_BREAKING_BLOCK
PLAYER_BROKEN_BLOCK
PLAYER_CROUCHED
PLAYER_DESTROYED
PLAYER_EATING
PLAYER_FISHED
PLAYER_FISHING
PLAYER_FOOD_LEVEL_CHANGE
PLAYER_JOINED
PLAYER_LEFT_CLICK
PLAYER_MOVING
PLAYER_OPENING_WINDOW
PLAYER_PLACED_BLOCK
PLAYER_PLACING_BLOCK
PLAYER_RIGHT_CLICK
PLAYER_RIGHT_CLICKING_ENTITY
PLAYER_SHOOTING
PLAYER_SPAWNED
PLAYER_TOSSING_ITEM
PLAYER_USED_BLOCK
PLAYER_USED_ITEM
PLAYER_USING_BLOCK
PLAYER_USING_ITEM
PLUGINS_LOADED
PLUGIN_MESSAGE
POST_CRAFTING
PRE_CRAFTING
PROJECTILE_HIT_BLOCK
PROJECTILE_HIT_ENTITY
SERVER_PING
SPAWNED_ENTITY
SPAWNED_MONSTER
SPAWNING_ENTITY
SPAWNING_MONSTER
TAKE_DAMAGE
TICK
UPDATED_SIGN
UPDATING_SIGN
WEATHER_CHANGED
WEATHER_CHANGING
WORLD_STARTED
WORLD_TICK

This callback is called whenever a hopper transfers an 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.


Callback function

The default name for the callback function is OnHopperPullingItem. It has the following signature:

function MyOnHopperPullingItem(World, Hopper, DstSlot, SrcBlockEntity, SrcSlot)

Parameters:

NameTypeNotes
WorldcWorldWorld where the hopper resides
HoppercHopperEntityThe hopper that is pulling the item
DstSlotnumberThe destination slot in the hopper's internal storage
SrcBlockEntitycBlockEntityWithItemsThe block entity that is losing the item
SrcSlotnumberSlot in SrcBlockEntity from which the item will be pulled

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.


Code examples

Registering the callback

cPluginManager:AddHook(cPluginManager.HOOK_HOPPER_PULLING_ITEM, MyOnHopperPullingItem);
Generated by APIDump on 2024-10-25 05:01:00, Build ID Unknown, Commit approx: 0325de7dacaf1e2feaea5eaab4791bc23d78f9e7