Class StackCopySlot

java.lang.Object

net.minecraft.world.inventory.Slot

net.neoforged.neoforge.world.inventory.StackCopySlot

Direct Known Subclasses:

ItemHandlerCopySlot, ResourceHandlerSlot

public abstract class StackCopySlot
extends Slot

Slot to handle immutable itemstack storages (Ex: ItemAccessItemHandler).

For an implementation for use with a ResourceHandler see ResourceHandlerSlot.

Vanilla MC code modifies the stack returned by getItem() directly, but it calls setChanged() when that happens, so we just cache the returned stack, and set it when setChanged() is called.

Field Summary

Fields

Modifier and Type	Field	Description
private @Nullable ItemStack	cachedReturnedStack
private static final Container	emptyInventory

Fields inherited from class Slot

container, index, x, y

Constructor Summary

Constructors

Constructor	Description
StackCopySlot(int slot, int x, int y)

Method Summary

Modifier and Type	Method	Description
protected void	clearCachedReturnStack()	Clears the current cached return stack to prevent a setChanged() call from potentially overriding the contents of this slot.
final ItemStack	getItem()
protected abstract ItemStack	getStackCopy()	Gets the itemstack from the storage.
ItemStack	remove(int amount)
final void	set(ItemStack stack)
final void	setChanged()
protected abstract void	setStackCopy(ItemStack stack)	Sets the itemstack from the storage.

Methods inherited from class Slot

allowModification, checkTakeAchievements, getContainerSlot, getMaxStackSize, getMaxStackSize, getNoItemIcon, getSlotIndex, hasItem, isActive, isFake, isHighlightable, isSameInventory, mayPickup, mayPlace, onQuickCraft, onQuickCraft, onSwapCraft, onTake, safeClone, safeInsert, safeInsert, safeTake, setBackground, setByPlayer, setByPlayer, tryRemove

Methods inherited from class Object

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

Field Details

emptyInventory

private static final Container emptyInventory

cachedReturnedStack

private @Nullable ItemStack cachedReturnedStack

Constructor Details

StackCopySlot

public StackCopySlot(int slot,
 int x,
 int y)

Parameters:

slot - The slot in the underlying container, whatever it may be; zero if not applicable.

Method Details

getStackCopy

protected abstract ItemStack getStackCopy()

Gets the itemstack from the storage.

Returns:

the stack in this slot

setStackCopy

protected abstract void setStackCopy(ItemStack stack)

Sets the itemstack from the storage.

Parameters:

stack - the stack to put into this slot

getItem

public final ItemStack getItem()

Overrides:

getItem in class Slot

set

public final void set(ItemStack stack)

Overrides:

set in class Slot

setChanged

public final void setChanged()

Overrides:

setChanged in class Slot

remove

public ItemStack remove(int amount)

Overrides:

remove in class Slot

clearCachedReturnStack

protected void clearCachedReturnStack()

Clears the current cached return stack to prevent a setChanged() call from potentially overriding the contents of this slot. This is useful when the slot's backing inventory may have been modified directly.