Class HopperBlockEntity

java.lang.Object

net.neoforged.neoforge.attachment.AttachmentHolder

net.minecraft.world.level.block.entity.BlockEntity

net.minecraft.world.level.block.entity.BaseContainerBlockEntity

net.minecraft.world.level.block.entity.RandomizableContainerBlockEntity

net.minecraft.world.level.block.entity.HopperBlockEntity

All Implemented Interfaces:

Iterable<ItemStack>, TypedInstance<BlockEntityType<?>>, DebugValueSource, Clearable, Container, SlotProvider, MenuConstructor, Hopper, MenuProvider, Nameable, RandomizableContainer, IAttachmentHolder, ContainerExtension, IBlockEntityExtension, IMenuProviderExtension

public class HopperBlockEntity
extends RandomizableContainerBlockEntity
implements Hopper

Nested Class Summary

Nested classes/interfaces inherited from class AttachmentHolder

AttachmentHolder.AsField

Nested classes/interfaces inherited from interface Container

Container.ContainerIterator

Nested classes/interfaces inherited from interface DebugValueSource

DebugValueSource.Registration, DebugValueSource.ValueGetter<T>

Field Summary

Fields

Modifier and Type	Field	Description
private static final int[][]	CACHED_SLOTS
private int	cooldownTime
private final SnapshotJournal<Integer>	cooldownTimeJournal
private static final Component	DEFAULT_NAME
private Direction	facing
static final int	HOPPER_CONTAINER_SIZE
private NonNullList<ItemStack>	items
static final int	MOVE_ITEM_SPEED
private static final int	NO_COOLDOWN_TIME
private long	tickedGameTime

Fields inherited from class RandomizableContainerBlockEntity

lootTable, lootTableSeed

Fields inherited from class BlockEntity

level, remove, worldPosition

Fields inherited from class AttachmentHolder

ATTACHMENTS_NBT_KEY

Fields inherited from interface Container

DEFAULT_DISTANCE_BUFFER

Fields inherited from interface Hopper

SUCK_AABB

Fields inherited from interface RandomizableContainer

LOOT_TABLE_SEED_TAG, LOOT_TABLE_TAG

Constructor Summary

Constructors

Constructor	Description
HopperBlockEntity(BlockPos worldPosition, BlockState blockState)

Method Summary

Modifier and Type	Method	Description
static ItemStack	addItem(@Nullable Container from, Container container, ItemStack itemStack, @Nullable Direction direction)	Attempts to place the passed stack in the container, using as many slots as required.
static boolean	addItem(Container container, ItemEntity entity)
private static boolean	canMergeItems(ItemStack a, ItemStack b)
private static boolean	canPlaceItemInContainer(Container container, ItemStack itemStack, int slot, @Nullable Direction direction)
private static boolean	canTakeItemFromContainer(Container into, Container from, ItemStack itemStack, int slot, Direction direction)
private static int[]	createFlatSlots(int containerSize)
protected AbstractContainerMenu	createMenu(int containerId, Inventory inventory)
private static boolean	ejectItems(Level level, BlockPos blockPos, HopperBlockEntity self)
static void	entityInside(Level level, BlockPos pos, BlockState blockState, Entity entity, HopperBlockEntity hopper)
private static @Nullable Container	getAttachedContainer(Level level, BlockPos blockPos, HopperBlockEntity self)
private static @Nullable Container	getBlockContainer(Level level, BlockPos pos, BlockState state)
static @Nullable Container	getContainerAt(Level level, BlockPos pos)	Deprecated. Use IItemHandler capability instead.
private static @Nullable Container	getContainerAt(Level level, BlockPos pos, BlockState state, double x, double y, double z)
static ContainerOrHandler	getContainerOrHandlerAt(Level level, BlockPos pos, @Nullable Direction side)
private static ContainerOrHandler	getContainerOrHandlerAt(Level level, BlockPos pos, BlockState state, double x, double y, double z, @Nullable Direction side)
int	getContainerSize()
protected Component	getDefaultName()
private static @Nullable Container	getEntityContainer(Level level, double x, double y, double z)
protected NonNullList<ItemStack>	getItems()
static List<ItemEntity>	getItemsAtAndAbove(Level level, Hopper hopper)
long	getLastUpdateTime()
double	getLevelX()
double	getLevelY()
double	getLevelZ()
private static int[]	getSlots(Container container, Direction direction)
private static @Nullable Container	getSourceContainer(Level level, Hopper hopper, BlockPos pos, BlockState state)
private static ContainerOrHandler	getSourceContainerOrHandler(Level level, Hopper hopper, BlockPos pos, BlockState state)
private boolean	inventoryFull()
private static boolean	isFullContainer(Container container, Direction direction)
boolean	isGridAligned()
private boolean	isOnCooldown()
boolean	isOnCustomCooldown()
protected void	loadAdditional(ValueInput input)
void	onTransfer(int slot, int amountChange, TransactionContext transaction)	Perform additional logic during the transaction, immediately after a successful transfer (i.e.
static void	pushItemsTick(Level level, BlockPos pos, BlockState state, HopperBlockEntity entity)
ItemStack	removeItem(int slot, int count)	Removes up to a specified number of items from an inventory slot and returns them in a new stack.
protected void	saveAdditional(ValueOutput output)
void	setBlockState(BlockState blockState)
void	setCooldown(int time)
void	setItem(int slot, ItemStack itemStack)	Sets the given item stack to the specified slot in the inventory (can be crafting or armor sections).
protected void	setItems(NonNullList<ItemStack> items)
static boolean	suckInItems(Level level, Hopper hopper)
private static ItemStack	tryMoveInItem(@Nullable Container from, Container container, ItemStack itemStack, int slot, @Nullable Direction direction)
private static boolean	tryMoveItems(Level level, BlockPos pos, BlockState state, HopperBlockEntity entity, BooleanSupplier action)
private static boolean	tryTakeInItemFromSlot(Hopper hopper, Container container, int slot, Direction direction)	Pulls from the specified slot in the container and places in any available slot in the hopper.
private boolean	wasEmpty(int slot, int amountChange)

Methods inherited from class RandomizableContainerBlockEntity

applyImplicitComponents, canOpen, collectImplicitComponents, createMenu, getItem, getLootTable, getLootTableSeed, isEmpty, removeComponentsFromTag, removeItemNoUpdate, setLootTable, setLootTableSeed

Methods inherited from class BaseContainerBlockEntity

clearContent, getCustomName, getDisplayName, getName, isLocked, sendChestLockedNotifications, setItem, stillValid

Methods inherited from class BlockEntity

addEntityType, applyComponents, applyComponentsFromItemStack, clearRemoved, collectComponents, components, fillCrashReportCategory, getAndClearAttachmentTypesToSync, getBlockPos, getBlockState, getLevel, getNameForReporting, getPersistentData, getPosFromTag, getType, getUpdatePacket, getUpdateTag, hasLevel, isRemoved, isValidBlockState, loadCustomOnly, loadStatic, loadWithComponents, parseCustomNameSafe, preRemoveSideEffects, problemPath, registerDebugValues, removeData, saveCustomOnly, saveCustomOnly, saveWithFullMetadata, saveWithFullMetadata, saveWithId, saveWithoutMetadata, saveWithoutMetadata, setChanged, setChanged, setComponents, setData, setLevel, setRemoved, syncData, triggerEvent, typeHolder

Methods inherited from class AttachmentHolder

deserializeAttachments, getData, getExistingDataOrNull, hasAttachments, hasData, serializeAttachments

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface Clearable

clearContent

Methods inherited from interface Container

canPlaceItem, canTakeItem, countItem, getEntitiesWithContainerOpen, getItem, getMaxStackSize, getMaxStackSize, getSlot, hasAnyMatching, hasAnyOf, isEmpty, iterator, removeItemNoUpdate, setChanged, startOpen, stillValid, stopOpen

Methods inherited from interface ContainerExtension

setItem

Methods inherited from interface Hopper

getSuckAabb

Methods inherited from interface IAttachmentHolder

getData, getExistingData, getExistingData, getExistingDataOrNull, hasData, removeData, setData, syncData

Methods inherited from interface IBlockEntityExtension

getModelData, handleUpdateTag, hasCustomOutlineRendering, invalidateCapabilities, onChunkUnloaded, onDataPacket, onLoad, requestModelDataUpdate

Methods inherited from interface IMenuProviderExtension

shouldTriggerClientSideContainerClosingOnOpen, writeClientSideData

Methods inherited from interface Iterable

forEach, spliterator

Methods inherited from interface Nameable

getPlainTextName, hasCustomName

Methods inherited from interface RandomizableContainer

getBlockPos, getLevel, setLootTable, tryLoadLootTable, trySaveLootTable, unpackLootTable

Methods inherited from interface SlotProvider

getSlotsFromRange

Methods inherited from interface TypedInstance

is, is, is, is, is, tags

Field Details

MOVE_ITEM_SPEED

public static final int MOVE_ITEM_SPEED

See Also:

• Constant Field Values

HOPPER_CONTAINER_SIZE

public static final int HOPPER_CONTAINER_SIZE

See Also:

• Constant Field Values

CACHED_SLOTS

private static final int[][] CACHED_SLOTS

NO_COOLDOWN_TIME

private static final int NO_COOLDOWN_TIME

See Also:

• Constant Field Values

DEFAULT_NAME

private static final Component DEFAULT_NAME

items

private NonNullList<ItemStack> items

cooldownTime

private int cooldownTime

tickedGameTime

private long tickedGameTime

facing

private Direction facing

cooldownTimeJournal

private final SnapshotJournal<Integer> cooldownTimeJournal

Constructor Details

HopperBlockEntity

public HopperBlockEntity(BlockPos worldPosition,
 BlockState blockState)

Method Details

loadAdditional

protected void loadAdditional(ValueInput input)

Overrides:

loadAdditional in class BaseContainerBlockEntity

saveAdditional

protected void saveAdditional(ValueOutput output)

Overrides:

saveAdditional in class BaseContainerBlockEntity

getContainerSize

public int getContainerSize()

Specified by:

getContainerSize in interface Container

removeItem

public ItemStack removeItem(int slot,
 int count)

Description copied from interface: Container

Removes up to a specified number of items from an inventory slot and returns them in a new stack.

Specified by:

removeItem in interface Container

Overrides:

removeItem in class RandomizableContainerBlockEntity

setItem

public void setItem(int slot,
 ItemStack itemStack)

Description copied from interface: Container

Sets the given item stack to the specified slot in the inventory (can be crafting or armor sections).

Specified by:

setItem in interface Container

Overrides:

setItem in class RandomizableContainerBlockEntity

wasEmpty

private boolean wasEmpty(int slot,
 int amountChange)

onTransfer

public void onTransfer(int slot,
 int amountChange,
 TransactionContext transaction)

Description copied from interface: ContainerExtension

Perform additional logic during the transaction, immediately after a successful transfer (i.e. insert or extract with result > 0). Any logic performed by this method should be fully transactional, and support being rolled back. In other words, the transaction is still ongoing.

Specified by:

onTransfer in interface ContainerExtension

Parameters:

amountChange - If positive, the amount of items that were just inserted into this slot. If negative, minus the amount of items that were just extracted from this slot.

setBlockState

public void setBlockState(BlockState blockState)

Overrides:

setBlockState in class BlockEntity

getDefaultName

protected Component getDefaultName()

Specified by:

getDefaultName in class BaseContainerBlockEntity

pushItemsTick

public static void pushItemsTick(Level level,
 BlockPos pos,
 BlockState state,
 HopperBlockEntity entity)

tryMoveItems

private static boolean tryMoveItems(Level level,
 BlockPos pos,
 BlockState state,
 HopperBlockEntity entity,
 BooleanSupplier action)

inventoryFull

private boolean inventoryFull()

ejectItems

private static boolean ejectItems(Level level,
 BlockPos blockPos,
 HopperBlockEntity self)

getSlots

private static int[] getSlots(Container container,
 Direction direction)

createFlatSlots

private static int[] createFlatSlots(int containerSize)

isFullContainer

private static boolean isFullContainer(Container container,
 Direction direction)

Returns:

false if the container has any room to place items in

suckInItems

public static boolean suckInItems(Level level,
 Hopper hopper)

tryTakeInItemFromSlot

private static boolean tryTakeInItemFromSlot(Hopper hopper,
 Container container,
 int slot,
 Direction direction)

Pulls from the specified slot in the container and places in any available slot in the hopper.

Returns:

true if the entire stack was moved.

addItem

public static boolean addItem(Container container,
 ItemEntity entity)

addItem

public static ItemStack addItem(@Nullable Container from,
 Container container,
 ItemStack itemStack,
 @Nullable Direction direction)

Attempts to place the passed stack in the container, using as many slots as required.

Returns:

any leftover stack

canPlaceItemInContainer

private static boolean canPlaceItemInContainer(Container container,
 ItemStack itemStack,
 int slot,
 @Nullable Direction direction)

canTakeItemFromContainer

private static boolean canTakeItemFromContainer(Container into,
 Container from,
 ItemStack itemStack,
 int slot,
 Direction direction)

tryMoveInItem

private static ItemStack tryMoveInItem(@Nullable Container from,
 Container container,
 ItemStack itemStack,
 int slot,
 @Nullable Direction direction)

getAttachedContainer

private static @Nullable Container getAttachedContainer(Level level,
 BlockPos blockPos,
 HopperBlockEntity self)

getSourceContainer

private static @Nullable Container getSourceContainer(Level level,
 Hopper hopper,
 BlockPos pos,
 BlockState state)

getItemsAtAndAbove

public static List<ItemEntity> getItemsAtAndAbove(Level level,
 Hopper hopper)

getContainerAt

@Deprecated
public static @Nullable Container getContainerAt(Level level,
 BlockPos pos)

Deprecated.

Use IItemHandler capability instead. To preserve Container-specific interactions, use getContainerOrHandlerAt(Level, BlockPos, Direction) and handle both cases.

getContainerAt

private static @Nullable Container getContainerAt(Level level,
 BlockPos pos,
 BlockState state,
 double x,
 double y,
 double z)

getBlockContainer

private static @Nullable Container getBlockContainer(Level level,
 BlockPos pos,
 BlockState state)

getEntityContainer

private static @Nullable Container getEntityContainer(Level level,
 double x,
 double y,
 double z)

getSourceContainerOrHandler

private static ContainerOrHandler getSourceContainerOrHandler(Level level,
 Hopper hopper,
 BlockPos pos,
 BlockState state)

getContainerOrHandlerAt

public static ContainerOrHandler getContainerOrHandlerAt(Level level,
 BlockPos pos,
 @Nullable Direction side)

getContainerOrHandlerAt

private static ContainerOrHandler getContainerOrHandlerAt(Level level,
 BlockPos pos,
 BlockState state,
 double x,
 double y,
 double z,
 @Nullable Direction side)

canMergeItems

private static boolean canMergeItems(ItemStack a,
 ItemStack b)

getLevelX

public double getLevelX()

Specified by:

getLevelX in interface Hopper

getLevelY

public double getLevelY()

Specified by:

getLevelY in interface Hopper

getLevelZ

public double getLevelZ()

Specified by:

getLevelZ in interface Hopper

isGridAligned

public boolean isGridAligned()

Specified by:

isGridAligned in interface Hopper

setCooldown

public void setCooldown(int time)

isOnCooldown

private boolean isOnCooldown()

isOnCustomCooldown

public boolean isOnCustomCooldown()

getItems

protected NonNullList<ItemStack> getItems()

Specified by:

getItems in class BaseContainerBlockEntity

setItems

protected void setItems(NonNullList<ItemStack> items)

Specified by:

setItems in class BaseContainerBlockEntity

entityInside

public static void entityInside(Level level,
 BlockPos pos,
 BlockState blockState,
 Entity entity,
 HopperBlockEntity hopper)

createMenu

protected AbstractContainerMenu createMenu(int containerId,
 Inventory inventory)

Specified by:

createMenu in class BaseContainerBlockEntity

getLastUpdateTime

public long getLastUpdateTime()