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

Class BlockEntity

java.lang.Object

net.neoforged.neoforge.attachment.AttachmentHolder

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

All Implemented Interfaces:

IAttachmentHolder, IBlockEntityExtension

Direct Known Subclasses:

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

public abstract class BlockEntity
extends AttachmentHolder
implements IBlockEntityExtension

Nested Class Summary

Nested Classes

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

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

AttachmentHolder.AsField

Field Summary

Fields

Modifier and Type	Field	Description
private BlockState	blockState
private DataComponentMap	components
private CompoundTag	customPersistentData
protected 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 net.neoforged.neoforge.attachment.AttachmentHolder

ATTACHMENTS_NBT_KEY

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static void	addEntityType(ValueOutput output, BlockEntityType<?> entityType)
final void	applyComponents(DataComponentMap components, DataComponentPatch patch)
final void	applyComponentsFromItemStack(ItemStack stack)
protected void	applyImplicitComponents(DataComponentGetter componentGetter)
void	clearRemoved()
final DataComponentMap	collectComponents()
protected void	collectImplicitComponents(DataComponentMap.Builder components)
DataComponentMap	components()
void	fillCrashReportCategory(CrashReportCategory reportCategory)
BlockPos	getBlockPos()
BlockState	getBlockState()
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 chunkPos, CompoundTag tag)
BlockEntityType<?>	getType()
Packet<ClientGamePacketListener>	getUpdatePacket()
CompoundTag	getUpdateTag(HolderLookup.Provider registries)
boolean	hasLevel()
boolean	isRemoved()
boolean	isValidBlockState(BlockState state)
protected void	loadAdditional(ValueInput input)
final void	loadCustomOnly(ValueInput input)
static BlockEntity	loadStatic(BlockPos pos, BlockState state, CompoundTag tag, HolderLookup.Provider registries)
final void	loadWithComponents(ValueInput input)
static Component	parseCustomNameSafe(ValueInput input, String customName)
void	preRemoveSideEffects(BlockPos pos, BlockState state)
ProblemReporter.PathElement	problemPath()
void	removeComponentsFromTag(ValueOutput output)	Deprecated.
final <T> 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 pos, BlockState state)
void	setComponents(DataComponentMap components)
final <T> 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 id, int type)
private void	validateBlockState(BlockState state)

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.neoforged.neoforge.attachment.IAttachmentHolder

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

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

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

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

@Nullable
protected Level level

worldPosition

protected final BlockPos worldPosition

remove

protected boolean remove

blockState

private BlockState blockState

components

private DataComponentMap components

customPersistentData

@Nullable
private CompoundTag customPersistentData

Constructor Details

BlockEntity

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

Method Details

validateBlockState

private void validateBlockState(BlockState state)

isValidBlockState

public boolean isValidBlockState(BlockState state)

getPosFromTag

public static BlockPos getPosFromTag(ChunkPos chunkPos,
 CompoundTag tag)

getLevel

@Nullable
public 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<?> entityType)

saveMetadata

private void saveMetadata(ValueOutput output)

loadStatic

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

setChanged

public void setChanged()

setChanged

protected static void setChanged(Level level,
 BlockPos pos,
 BlockState state)

getBlockPos

public BlockPos getBlockPos()

getBlockState

public BlockState getBlockState()

getUpdatePacket

@Nullable
public 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 id,
 int type)

fillCrashReportCategory

public void fillCrashReportCategory(CrashReportCategory reportCategory)

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

@Nullable
public final <T> 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

@Nullable
public final <T> 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

setBlockState

@Deprecated
public void setBlockState(BlockState blockState)

Deprecated.

applyImplicitComponents

protected void applyImplicitComponents(DataComponentGetter componentGetter)

applyComponentsFromItemStack

public final void applyComponentsFromItemStack(ItemStack stack)

applyComponents

public final void applyComponents(DataComponentMap components,
 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

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

problemPath

public ProblemReporter.PathElement problemPath()