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:

Clearable, Container, MenuConstructor, MenuProvider, Nameable, IAttachmentHolder, IMenuProviderExtension, IBlockEntityExtension

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.ComponentHelper, BlockEntity.DataComponentInput

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

AttachmentHolder.AsField

Field Summary

Fields

Modifier and Type	Field	Description
private LockCode	lockKey
private 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<?> pType, BlockPos pPos, BlockState pBlockState)

Method Summary

Modifier and Type	Method	Description
protected void	applyImplicitComponents(BlockEntity.DataComponentInput pComponentInput)
boolean	canOpen(Player pPlayer)
static boolean	canUnlock(Player pPlayer, LockCode pCode, Component pDisplayName)
void	clearContent()
protected void	collectImplicitComponents(DataComponentMap.Builder pComponents)
protected abstract AbstractContainerMenu	createMenu(int pContainerId, Inventory pInventory)
AbstractContainerMenu	createMenu(int pContainerId, Inventory pPlayerInventory, Player pPlayer)
Component	getCustomName()
protected abstract Component	getDefaultName()
Component	getDisplayName()
ItemStack	getItem(int pSlot)	Returns the stack in the given slot.
protected abstract NonNullList<ItemStack>	getItems()
Component	getName()
boolean	isEmpty()
protected void	loadAdditional(CompoundTag pTag, HolderLookup.Provider pRegistries)
void	removeComponentsFromTag(CompoundTag pTag)
ItemStack	removeItem(int pSlot, int pAmount)	Removes up to a specified number of items from an inventory slot and returns them in a new stack.
ItemStack	removeItemNoUpdate(int pSlot)	Removes a stack from the given slot and returns it.
protected void	saveAdditional(CompoundTag pTag, HolderLookup.Provider pRegistries)
void	setItem(int pSlot, ItemStack pStack)	Sets the given item stack to the specified slot in the inventory (can be crafting or armor sections).
protected abstract void	setItems(NonNullList<ItemStack> pItems)
boolean	stillValid(Player pPlayer)	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, getPersistentData, getPosFromTag, getType, getUpdatePacket, getUpdateTag, hasLevel, isRemoved, isValidBlockState, loadCustomOnly, loadStatic, loadWithComponents, onlyOpCanSetNbt, parseCustomNameSafe, removeData, saveCustomAndMetadata, saveCustomOnly, saveToItem, saveWithFullMetadata, saveWithId, 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, getMaxStackSize, getMaxStackSize, hasAnyMatching, hasAnyOf, setChanged, startOpen, stopOpen

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.client.extensions.IMenuProviderExtension

shouldTriggerClientSideContainerClosingOnOpen, writeClientSideData

Methods inherited from interface net.minecraft.world.Nameable

hasCustomName

Field Details

lockKey

private LockCode lockKey

name

@Nullable
private Component name

Constructor Details

BaseContainerBlockEntity

protected BaseContainerBlockEntity(BlockEntityType<?> pType,
 BlockPos pPos,
 BlockState pBlockState)

Method Details

loadAdditional

protected void loadAdditional(CompoundTag pTag,
 HolderLookup.Provider pRegistries)

Overrides:

loadAdditional in class BlockEntity

saveAdditional

protected void saveAdditional(CompoundTag pTag,
 HolderLookup.Provider pRegistries)

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

@Nullable
public Component getCustomName()

Specified by:

getCustomName in interface Nameable

getDefaultName

protected abstract Component getDefaultName()

canOpen

public boolean canOpen(Player pPlayer)

canUnlock

public static boolean canUnlock(Player pPlayer,
 LockCode pCode,
 Component pDisplayName)

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 pSlot)

Returns the stack in the given slot.

Specified by:

getItem in interface Container

removeItem

public ItemStack removeItem(int pSlot,
 int pAmount)

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 pSlot)

Removes a stack from the given slot and returns it.

Specified by:

removeItemNoUpdate in interface Container

setItem

public void setItem(int pSlot,
 ItemStack pStack)

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

Specified by:

setItem in interface Container

stillValid

public boolean stillValid(Player pPlayer)

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

@Nullable
public AbstractContainerMenu createMenu(int pContainerId,
 Inventory pPlayerInventory,
 Player pPlayer)

Specified by:

createMenu in interface MenuConstructor

createMenu

protected abstract AbstractContainerMenu createMenu(int pContainerId,
 Inventory pInventory)

applyImplicitComponents

protected void applyImplicitComponents(BlockEntity.DataComponentInput pComponentInput)

Overrides:

applyImplicitComponents in class BlockEntity

collectImplicitComponents

protected void collectImplicitComponents(DataComponentMap.Builder pComponents)

Overrides:

collectImplicitComponents in class BlockEntity

removeComponentsFromTag

public void removeComponentsFromTag(CompoundTag pTag)

Overrides:

removeComponentsFromTag in class BlockEntity