Class BlockEntity

java.lang.Object

net.neoforged.neoforge.attachment.AttachmentHolder

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

All Implemented Interfaces:

TypedInstance<BlockEntityType<?>>, DebugValueSource, IAttachmentHolder, IBlockEntityExtension

Direct Known Subclasses:

BannerBlockEntity, BaseContainerBlockEntity, BeaconBlockEntity, BedBlockEntity, BeehiveBlockEntity, BellBlockEntity, BrushableBlockEntity, CampfireBlockEntity, ChiseledBookShelfBlockEntity, CommandBlockEntity, ComparatorBlockEntity, ConduitBlockEntity, CopperGolemStatueBlockEntity, CreakingHeartBlockEntity, DaylightDetectorBlockEntity, DecoratedPotBlockEntity, EnchantingTableBlockEntity, EnderChestBlockEntity, JigsawBlockEntity, JukeboxBlockEntity, LecternBlockEntity, PistonMovingBlockEntity, SculkCatalystBlockEntity, SculkSensorBlockEntity, SculkShriekerBlockEntity, ShelfBlockEntity, SignBlockEntity, SkullBlockEntity, SpawnerBlockEntity, StructureBlockEntity, TestBlockEntity, TestInstanceBlockEntity, TheEndPortalBlockEntity, TrialSpawnerBlockEntity, VaultBlockEntity

public abstract class BlockEntity
extends AttachmentHolder
implements DebugValueSource, TypedInstance<BlockEntityType<?>>, IBlockEntityExtension

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final record	BlockEntity.BlockEntityPathElement

Nested classes/interfaces inherited from class AttachmentHolder

AttachmentHolder.AsField

Nested classes/interfaces inherited from interface DebugValueSource

DebugValueSource.Registration, DebugValueSource.ValueGetter<T>

Field Summary

Fields

Modifier and Type	Field	Description
private @Nullable Set<AttachmentType<?>>	attachmentTypesToSync
private BlockState	blockState
private DataComponentMap	components
private @Nullable CompoundTag	customPersistentData
protected @Nullable Level	level
private static final org.slf4j.Logger	LOGGER
protected boolean	remove
private final BlockEntityType<?>	type	Deprecated.
private static final com.mojang.serialization.Codec<BlockEntityType<?>>	TYPE_CODEC
protected final BlockPos	worldPosition

Fields inherited from class AttachmentHolder

ATTACHMENTS_NBT_KEY

Constructor Summary

Constructors

Constructor	Description
BlockEntity(BlockEntityType<?> type, BlockPos worldPosition, BlockState blockState)

Method Summary

Modifier and Type	Method	Description
static void	addEntityType(ValueOutput output, BlockEntityType<?> type)
final void	applyComponents(DataComponentMap prototype, DataComponentPatch patch)
final void	applyComponentsFromItemStack(ItemStack stack)
protected void	applyImplicitComponents(DataComponentGetter components)
void	clearRemoved()
final DataComponentMap	collectComponents()
protected void	collectImplicitComponents(DataComponentMap.Builder components)
DataComponentMap	components()
void	fillCrashReportCategory(CrashReportCategory category)
final @Nullable Set<AttachmentType<?>>	getAndClearAttachmentTypesToSync()
BlockPos	getBlockPos()
BlockState	getBlockState()
@Nullable Level	getLevel()
String	getNameForReporting()
CompoundTag	getPersistentData()	Gets a CompoundTag that can be used to store custom data for this block entity.
static BlockPos	getPosFromTag(ChunkPos base, CompoundTag entityTag)
BlockEntityType<?>	getType()
@Nullable Packet<ClientGamePacketListener>	getUpdatePacket()
CompoundTag	getUpdateTag(HolderLookup.Provider registries)
boolean	hasLevel()
boolean	isRemoved()
boolean	isValidBlockState(BlockState blockState)
protected void	loadAdditional(ValueInput input)
final void	loadCustomOnly(ValueInput input)
static @Nullable BlockEntity	loadStatic(BlockPos pos, BlockState state, CompoundTag tag, HolderLookup.Provider registries)
final void	loadWithComponents(ValueInput input)
static @Nullable Component	parseCustomNameSafe(ValueInput input, String name)
void	preRemoveSideEffects(BlockPos pos, BlockState state)
ProblemReporter.PathElement	problemPath()
void	registerDebugValues(ServerLevel level, DebugValueSource.Registration registration)
void	removeComponentsFromTag(ValueOutput output)	Deprecated.
final <T> @Nullable T	removeData(AttachmentType<T> type)	Removes the data attachment of the given type.
protected void	saveAdditional(ValueOutput output)
final CompoundTag	saveCustomOnly(HolderLookup.Provider registries)
void	saveCustomOnly(ValueOutput output)
private void	saveId(ValueOutput output)
private void	saveMetadata(ValueOutput output)
final CompoundTag	saveWithFullMetadata(HolderLookup.Provider registries)
void	saveWithFullMetadata(ValueOutput output)
void	saveWithId(ValueOutput output)
final CompoundTag	saveWithoutMetadata(HolderLookup.Provider registries)
void	saveWithoutMetadata(ValueOutput output)
void	setBlockState(BlockState blockState)	Deprecated.
void	setChanged()
protected static void	setChanged(Level level, BlockPos worldPosition, BlockState blockState)
void	setComponents(DataComponentMap components)
final <T> @Nullable T	setData(AttachmentType<T> type, T data)	Sets the data attachment of the given type.
void	setLevel(Level level)
void	setRemoved()
final void	syncData(AttachmentType<?> type)	Syncs a data attachment of the given type with all relevant clients.
boolean	triggerEvent(int b0, int b1)
Holder<BlockEntityType<?>>	typeHolder()
private void	validateBlockState(BlockState blockState)

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

is, is, is, is, is, tags

Field Details

TYPE_CODEC

private static final com.mojang.serialization.Codec<BlockEntityType<?>> TYPE_CODEC

LOGGER

private static final org.slf4j.Logger LOGGER

type

@Deprecated
private final BlockEntityType<?> type

Deprecated.

level

protected @Nullable Level level

worldPosition

protected final BlockPos worldPosition

remove

protected boolean remove

blockState

private BlockState blockState

components

private DataComponentMap components

customPersistentData

private @Nullable CompoundTag customPersistentData

attachmentTypesToSync

private @Nullable Set<AttachmentType<?>> attachmentTypesToSync

Constructor Details

BlockEntity

public BlockEntity(BlockEntityType<?> type,
 BlockPos worldPosition,
 BlockState blockState)

Method Details

validateBlockState

private void validateBlockState(BlockState blockState)

isValidBlockState

public boolean isValidBlockState(BlockState blockState)

getPosFromTag

public static BlockPos getPosFromTag(ChunkPos base,
 CompoundTag entityTag)

getLevel

public @Nullable Level getLevel()

setLevel

public void setLevel(Level level)

hasLevel

public boolean hasLevel()

loadAdditional

protected void loadAdditional(ValueInput input)

loadWithComponents

public final void loadWithComponents(ValueInput input)

loadCustomOnly

public final void loadCustomOnly(ValueInput input)

saveAdditional

protected void saveAdditional(ValueOutput output)

saveWithFullMetadata

public final CompoundTag saveWithFullMetadata(HolderLookup.Provider registries)

saveWithFullMetadata

public void saveWithFullMetadata(ValueOutput output)

saveWithId

public void saveWithId(ValueOutput output)

saveWithoutMetadata

public final CompoundTag saveWithoutMetadata(HolderLookup.Provider registries)

saveWithoutMetadata

public void saveWithoutMetadata(ValueOutput output)

saveCustomOnly

public final CompoundTag saveCustomOnly(HolderLookup.Provider registries)

saveCustomOnly

public void saveCustomOnly(ValueOutput output)

saveId

private void saveId(ValueOutput output)

addEntityType

public static void addEntityType(ValueOutput output,
 BlockEntityType<?> type)

saveMetadata

private void saveMetadata(ValueOutput output)

loadStatic

public static @Nullable BlockEntity loadStatic(BlockPos pos,
 BlockState state,
 CompoundTag tag,
 HolderLookup.Provider registries)

setChanged

public void setChanged()

setChanged

protected static void setChanged(Level level,
 BlockPos worldPosition,
 BlockState blockState)

getBlockPos

public BlockPos getBlockPos()

getBlockState

public BlockState getBlockState()

getUpdatePacket

public @Nullable Packet<ClientGamePacketListener> getUpdatePacket()

getUpdateTag

public CompoundTag getUpdateTag(HolderLookup.Provider registries)

isRemoved

public boolean isRemoved()

setRemoved

public void setRemoved()

clearRemoved

public void clearRemoved()

preRemoveSideEffects

public void preRemoveSideEffects(BlockPos pos,
 BlockState state)

triggerEvent

public boolean triggerEvent(int b0,
 int b1)

fillCrashReportCategory

public void fillCrashReportCategory(CrashReportCategory category)

getNameForReporting

public String getNameForReporting()

getType

public BlockEntityType<?> getType()

getPersistentData

public CompoundTag getPersistentData()

Description copied from interface: IBlockEntityExtension

Gets a CompoundTag that can be used to store custom data for this block entity. It will be written, and read from disc, so it persists over world saves.

Specified by:

getPersistentData in interface IBlockEntityExtension

Returns:

A compound tag for custom persistent data

setData

public final <T> @Nullable T setData(AttachmentType<T> type,
 T data)

Description copied from interface: IAttachmentHolder

Sets the data attachment of the given type.

Specified by:

setData in interface IAttachmentHolder

Overrides:

setData in class AttachmentHolder

Returns:

the previous value for that attachment type, if any, or null if there was none

removeData

public final <T> @Nullable T removeData(AttachmentType<T> type)

Description copied from interface: IAttachmentHolder

Removes the data attachment of the given type.

Specified by:

removeData in interface IAttachmentHolder

Overrides:

removeData in class AttachmentHolder

Returns:

the previous value for that attachment type, if any, or null if there was none

syncData

public final void syncData(AttachmentType<?> type)

Description copied from interface: IAttachmentHolder

Syncs a data attachment of the given type with all relevant clients.

If there is currently no attachment of the given type, the removal of the attachment is synced to the client.

Specified by:

syncData in interface IAttachmentHolder

See Also:

• AttachmentSyncHandler

getAndClearAttachmentTypesToSync

@Internal
public final @Nullable Set<AttachmentType<?>> getAndClearAttachmentTypesToSync()

typeHolder

public Holder<BlockEntityType<?>> typeHolder()

Specified by:

typeHolder in interface TypedInstance<BlockEntityType<?>>

setBlockState

@Deprecated
public void setBlockState(BlockState blockState)

Deprecated.

applyImplicitComponents

protected void applyImplicitComponents(DataComponentGetter components)

applyComponentsFromItemStack

public final void applyComponentsFromItemStack(ItemStack stack)

applyComponents

public final void applyComponents(DataComponentMap prototype,
 DataComponentPatch patch)

collectImplicitComponents

protected void collectImplicitComponents(DataComponentMap.Builder components)

removeComponentsFromTag

@Deprecated
public void removeComponentsFromTag(ValueOutput output)

Deprecated.

collectComponents

public final DataComponentMap collectComponents()

components

public DataComponentMap components()

setComponents

public void setComponents(DataComponentMap components)

parseCustomNameSafe

public static @Nullable Component parseCustomNameSafe(ValueInput input,
 String name)

problemPath

public ProblemReporter.PathElement problemPath()

registerDebugValues

public void registerDebugValues(ServerLevel level,
 DebugValueSource.Registration registration)

Specified by:

registerDebugValues in interface DebugValueSource