Package net.minecraft.world.level.block.entity

Class BaseContainerBlockEntity

java.lang.Object

net.neoforged.neoforge.attachment.AttachmentHolder

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

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

All Implemented Interfaces:

Iterable<ItemStack>, DebugValueSource, Clearable, Container, SlotProvider, MenuConstructor, MenuProvider, Nameable, IAttachmentHolder, ContainerExtension, IBlockEntityExtension, IMenuProviderExtension

Direct Known Subclasses:

AbstractFurnaceBlockEntity, BrewingStandBlockEntity, RandomizableContainerBlockEntity

public abstract class BaseContainerBlockEntity
extends BlockEntity
implements Container, MenuProvider, Nameable

Nested Class Summary

Nested classes/interfaces inherited from class net.minecraft.world.level.block.entity.BlockEntity

BlockEntity.BlockEntityPathElement

Nested classes/interfaces inherited from class net.neoforged.neoforge.attachment.AttachmentHolder

AttachmentHolder.AsField

Nested classes/interfaces inherited from interface net.minecraft.world.Container

Container.ContainerIterator

Nested classes/interfaces inherited from interface net.minecraft.util.debug.DebugValueSource

DebugValueSource.Registration, DebugValueSource.ValueGetter<T>

Field Summary

Fields

Modifier and Type	Field	Description
private LockCode	lockKey
private @Nullable Component	name

Fields inherited from class net.minecraft.world.level.block.entity.BlockEntity

level, remove, worldPosition

Fields inherited from class net.neoforged.neoforge.attachment.AttachmentHolder

ATTACHMENTS_NBT_KEY

Fields inherited from interface net.minecraft.world.Container

DEFAULT_DISTANCE_BUFFER

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseContainerBlockEntity(BlockEntityType<?> p_155076_, BlockPos p_155077_, BlockState p_155078_)

Method Summary

Modifier and Type	Method	Description
protected void	applyImplicitComponents(DataComponentGetter p_397486_)
boolean	canOpen(Player pPlayer)
void	clearContent()
protected void	collectImplicitComponents(DataComponentMap.Builder p_338252_)
protected abstract AbstractContainerMenu	createMenu(int pContainerId, Inventory pInventory)
@Nullable AbstractContainerMenu	createMenu(int pContainerId, Inventory pInventory, Player p_58643_)
@Nullable Component	getCustomName()
protected abstract Component	getDefaultName()
Component	getDisplayName()
ItemStack	getItem(int p_332727_)	Returns the stack in the given slot.
protected abstract NonNullList<ItemStack>	getItems()
Component	getName()
boolean	isEmpty()
boolean	isLocked()
protected void	loadAdditional(ValueInput p_422403_)
void	removeComponentsFromTag(ValueOutput p_421741_)
ItemStack	removeItem(int p_332707_, int p_332672_)	Removes up to a specified number of items from an inventory slot and returns them in a new stack.
ItemStack	removeItemNoUpdate(int p_332812_)	Removes a stack from the given slot and returns it.
protected void	saveAdditional(ValueOutput p_422177_)
static void	sendChestLockedNotifications(Vec3 pPos, Player pPlayer, Component pDisplayName)
void	setItem(int p_332705_, ItemStack p_332643_)	Sets the given item stack to the specified slot in the inventory (can be crafting or armor sections).
void	setItem(int p_332705_, ItemStack p_332643_, boolean insideTransaction)	An extension of Container.setItem(int, ItemStack) that allows non-transactional side-effects to be skipped.
protected abstract void	setItems(NonNullList<ItemStack> pItems)
boolean	stillValid(Player p_332791_)	Don't rename this method to canInteractWith due to conflicts with Container

Methods inherited from class net.minecraft.world.level.block.entity.BlockEntity

addEntityType, applyComponents, applyComponentsFromItemStack, clearRemoved, collectComponents, components, fillCrashReportCategory, 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, setBlockState, setChanged, setChanged, setComponents, setData, setLevel, setRemoved, syncData, triggerEvent

Methods inherited from class net.neoforged.neoforge.attachment.AttachmentHolder

deserializeAttachments, getData, getExistingDataOrNull, hasAttachments, hasData, serializeAttachments

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.minecraft.world.Container

canPlaceItem, canTakeItem, countItem, getContainerSize, getEntitiesWithContainerOpen, getMaxStackSize, getMaxStackSize, getSlot, hasAnyMatching, hasAnyOf, iterator, setChanged, startOpen, stopOpen

Methods inherited from interface net.neoforged.neoforge.common.extensions.ContainerExtension

onTransfer

Methods inherited from interface net.neoforged.neoforge.attachment.IAttachmentHolder

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

Methods inherited from interface net.neoforged.neoforge.common.extensions.IBlockEntityExtension

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

Methods inherited from interface net.neoforged.neoforge.common.extensions.IMenuProviderExtension

shouldTriggerClientSideContainerClosingOnOpen, writeClientSideData

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface net.minecraft.world.Nameable

getPlainTextName, hasCustomName

Methods inherited from interface net.minecraft.world.entity.SlotProvider

getSlotsFromRange

Field Details

lockKey

private LockCode lockKey

name

private @Nullable Component name

Constructor Details

BaseContainerBlockEntity

protected BaseContainerBlockEntity(BlockEntityType<?> p_155076_,
 BlockPos p_155077_,
 BlockState p_155078_)

Method Details

loadAdditional

protected void loadAdditional(ValueInput p_422403_)

Overrides:

loadAdditional in class BlockEntity

saveAdditional

protected void saveAdditional(ValueOutput p_422177_)

Overrides:

saveAdditional in class BlockEntity

getName

public Component getName()

Specified by:

getName in interface Nameable

getDisplayName

public Component getDisplayName()

Specified by:

getDisplayName in interface MenuProvider

Specified by:

getDisplayName in interface Nameable

getCustomName

public @Nullable Component getCustomName()

Specified by:

getCustomName in interface Nameable

getDefaultName

protected abstract Component getDefaultName()

canOpen

public boolean canOpen(Player pPlayer)

sendChestLockedNotifications

public static void sendChestLockedNotifications(Vec3 pPos,
 Player pPlayer,
 Component pDisplayName)

isLocked

public boolean isLocked()

getItems

protected abstract NonNullList<ItemStack> getItems()

setItems

protected abstract void setItems(NonNullList<ItemStack> pItems)

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Container

getItem

public ItemStack getItem(int p_332727_)

Description copied from interface: Container

Returns the stack in the given slot.

Specified by:

getItem in interface Container

removeItem

public ItemStack removeItem(int p_332707_,
 int p_332672_)

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

removeItemNoUpdate

public ItemStack removeItemNoUpdate(int p_332812_)

Description copied from interface: Container

Removes a stack from the given slot and returns it.

Specified by:

removeItemNoUpdate in interface Container

setItem

public void setItem(int p_332705_,
 ItemStack p_332643_)

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

setItem

public void setItem(int p_332705_,
 ItemStack p_332643_,
 boolean insideTransaction)

Description copied from interface: ContainerExtension

An extension of Container.setItem(int, ItemStack) that allows non-transactional side-effects to be skipped. Non-transactional side-effects include for example calling setChanged or making changes to the world.

Specified by:

setItem in interface ContainerExtension

Parameters:

insideTransaction - When true, non-transactional actions should be deferred. When false, non-transactional actions can be performed immediately.

See Also:

• Overriding onTransfer, to react to transactions and defer non-transactional side-effects until the transaction is committed.

stillValid

public boolean stillValid(Player p_332791_)

Description copied from interface: Container

Don't rename this method to canInteractWith due to conflicts with Container

Specified by:

stillValid in interface Container

clearContent

public void clearContent()

Specified by:

clearContent in interface Clearable

createMenu

public @Nullable AbstractContainerMenu createMenu(int pContainerId,
 Inventory pInventory,
 Player p_58643_)

Specified by:

createMenu in interface MenuConstructor

createMenu

protected abstract AbstractContainerMenu createMenu(int pContainerId,
 Inventory pInventory)

applyImplicitComponents

protected void applyImplicitComponents(DataComponentGetter p_397486_)

Overrides:

applyImplicitComponents in class BlockEntity

collectImplicitComponents

protected void collectImplicitComponents(DataComponentMap.Builder p_338252_)

Overrides:

collectImplicitComponents in class BlockEntity

removeComponentsFromTag

public void removeComponentsFromTag(ValueOutput p_421741_)

Overrides:

removeComponentsFromTag in class BlockEntity