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>, TypedInstance<BlockEntityType<?>>, 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 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 LockCode	lockKey
private @Nullable Component	name

Fields inherited from class BlockEntity

level, remove, worldPosition

Fields inherited from class AttachmentHolder

ATTACHMENTS_NBT_KEY

Fields inherited from interface Container

DEFAULT_DISTANCE_BUFFER

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseContainerBlockEntity(BlockEntityType<?> type, BlockPos worldPosition, BlockState blockState)

Method Summary

Modifier and Type	Method	Description
protected void	applyImplicitComponents(DataComponentGetter components)
boolean	canOpen(Player player)
void	clearContent()
protected void	collectImplicitComponents(DataComponentMap.Builder components)
protected abstract AbstractContainerMenu	createMenu(int containerId, Inventory inventory)
@Nullable AbstractContainerMenu	createMenu(int containerId, Inventory inventory, Player player)
@Nullable Component	getCustomName()
protected abstract Component	getDefaultName()
Component	getDisplayName()
ItemStack	getItem(int slot)	Returns the stack in the given slot.
protected abstract NonNullList<ItemStack>	getItems()
Component	getName()
boolean	isEmpty()
boolean	isLocked()
protected void	loadAdditional(ValueInput input)
void	removeComponentsFromTag(ValueOutput output)
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.
ItemStack	removeItemNoUpdate(int slot)	Removes a stack from the given slot and returns it.
protected void	saveAdditional(ValueOutput output)
static void	sendChestLockedNotifications(Vec3 pos, Player player, Component displayName)
void	setItem(int slot, ItemStack itemStack)	Sets the given item stack to the specified slot in the inventory (can be crafting or armor sections).
void	setItem(int slot, ItemStack itemStack, boolean insideTransaction)	An extension of Container.setItem(int, ItemStack) that allows non-transactional side-effects to be skipped.
protected abstract void	setItems(NonNullList<ItemStack> items)
boolean	stillValid(Player player)	Don't rename this method to canInteractWith due to conflicts with Container

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, setBlockState, 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 Container

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

Methods inherited from interface ContainerExtension

onTransfer

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 SlotProvider

getSlotsFromRange

Methods inherited from interface TypedInstance

is, is, is, is, is, tags

Field Details

lockKey

private LockCode lockKey

name

private @Nullable Component name

Constructor Details

BaseContainerBlockEntity

protected BaseContainerBlockEntity(BlockEntityType<?> type,
 BlockPos worldPosition,
 BlockState blockState)

Method Details

loadAdditional

protected void loadAdditional(ValueInput input)

Overrides:

loadAdditional in class BlockEntity

saveAdditional

protected void saveAdditional(ValueOutput output)

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

sendChestLockedNotifications

public static void sendChestLockedNotifications(Vec3 pos,
 Player player,
 Component displayName)

isLocked

public boolean isLocked()

getItems

protected abstract NonNullList<ItemStack> getItems()

setItems

protected abstract void setItems(NonNullList<ItemStack> items)

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Container

getItem

public ItemStack getItem(int slot)

Description copied from interface: Container

Returns the stack in the given slot.

Specified by:

getItem 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

removeItemNoUpdate

public ItemStack removeItemNoUpdate(int slot)

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

setItem

public void setItem(int slot,
 ItemStack itemStack,
 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 player)

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 containerId,
 Inventory inventory,
 Player player)

Specified by:

createMenu in interface MenuConstructor

createMenu

protected abstract AbstractContainerMenu createMenu(int containerId,
 Inventory inventory)

applyImplicitComponents

protected void applyImplicitComponents(DataComponentGetter components)

Overrides:

applyImplicitComponents in class BlockEntity

collectImplicitComponents

protected void collectImplicitComponents(DataComponentMap.Builder components)

Overrides:

collectImplicitComponents in class BlockEntity

removeComponentsFromTag

public void removeComponentsFromTag(ValueOutput output)

Overrides:

removeComponentsFromTag in class BlockEntity