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:

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

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 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<?> pType, BlockPos pPos, BlockState pBlockState)

Method Summary

Modifier and Type	Method	Description
static void	addEntityType(ValueOutput pOutput, BlockEntityType<?> pEntityType)
final void	applyComponents(DataComponentMap pComponents, DataComponentPatch pPatch)
final void	applyComponentsFromItemStack(ItemStack pStack)
protected void	applyImplicitComponents(DataComponentGetter pComponentGetter)
void	clearRemoved()
final DataComponentMap	collectComponents()
protected void	collectImplicitComponents(DataComponentMap.Builder pComponents)
DataComponentMap	components()
void	fillCrashReportCategory(CrashReportCategory pReportCategory)
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 pChunkPos, CompoundTag pTag)
BlockEntityType<?>	getType()
Packet<ClientGamePacketListener>	getUpdatePacket()
CompoundTag	getUpdateTag(HolderLookup.Provider pRegistries)
boolean	hasLevel()
boolean	isRemoved()
boolean	isValidBlockState(BlockState pState)
protected void	loadAdditional(ValueInput pInput)
final void	loadCustomOnly(ValueInput pInput)
static BlockEntity	loadStatic(BlockPos pPos, BlockState pState, CompoundTag pTag, HolderLookup.Provider pRegistries)
final void	loadWithComponents(ValueInput pInput)
static Component	parseCustomNameSafe(ValueInput pInput, String pCustomName)
void	preRemoveSideEffects(BlockPos pPos, BlockState pState)
ProblemReporter.PathElement	problemPath()
void	registerDebugValues(ServerLevel p_449833_, DebugValueSource.Registration p_449301_)
void	removeComponentsFromTag(ValueOutput pOutput)	Deprecated.
final <T> T	removeData(AttachmentType<T> type)	Removes the data attachment of the given type.
protected void	saveAdditional(ValueOutput pOutput)
final CompoundTag	saveCustomOnly(HolderLookup.Provider pRegistries)
void	saveCustomOnly(ValueOutput pOutput)
private void	saveId(ValueOutput pOutput)
private void	saveMetadata(ValueOutput pOutput)
final CompoundTag	saveWithFullMetadata(HolderLookup.Provider pRegistries)
void	saveWithFullMetadata(ValueOutput pOutput)
void	saveWithId(ValueOutput pOutput)
final CompoundTag	saveWithoutMetadata(HolderLookup.Provider pRegistries)
void	saveWithoutMetadata(ValueOutput pOutput)
void	setBlockState(BlockState pBlockState)	Deprecated.
void	setChanged()
protected static void	setChanged(Level pLevel, BlockPos pPos, BlockState pState)
void	setComponents(DataComponentMap pComponents)
final <T> T	setData(AttachmentType<T> type, T data)	Sets the data attachment of the given type.
void	setLevel(Level pLevel)
void	setRemoved()
final void	syncData(AttachmentType<?> type)	Syncs a data attachment of the given type with all relevant clients.
boolean	triggerEvent(int pId, int pType)
private void	validateBlockState(BlockState pState)

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, hasCustomOutlineRendering, 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<?> pType,
 BlockPos pPos,
 BlockState pBlockState)

Method Details

validateBlockState

private void validateBlockState(BlockState pState)

isValidBlockState

public boolean isValidBlockState(BlockState pState)

getPosFromTag

public static BlockPos getPosFromTag(ChunkPos pChunkPos,
 CompoundTag pTag)

getLevel

@Nullable
public Level getLevel()

setLevel

public void setLevel(Level pLevel)

hasLevel

public boolean hasLevel()

loadAdditional

protected void loadAdditional(ValueInput pInput)

loadWithComponents

public final void loadWithComponents(ValueInput pInput)

loadCustomOnly

public final void loadCustomOnly(ValueInput pInput)

saveAdditional

protected void saveAdditional(ValueOutput pOutput)

saveWithFullMetadata

public final CompoundTag saveWithFullMetadata(HolderLookup.Provider pRegistries)

saveWithFullMetadata

public void saveWithFullMetadata(ValueOutput pOutput)

saveWithId

public void saveWithId(ValueOutput pOutput)

saveWithoutMetadata

public final CompoundTag saveWithoutMetadata(HolderLookup.Provider pRegistries)

saveWithoutMetadata

public void saveWithoutMetadata(ValueOutput pOutput)

saveCustomOnly

public final CompoundTag saveCustomOnly(HolderLookup.Provider pRegistries)

saveCustomOnly

public void saveCustomOnly(ValueOutput pOutput)

saveId

private void saveId(ValueOutput pOutput)

addEntityType

public static void addEntityType(ValueOutput pOutput,
 BlockEntityType<?> pEntityType)

saveMetadata

private void saveMetadata(ValueOutput pOutput)

loadStatic

@Nullable
public static BlockEntity loadStatic(BlockPos pPos,
 BlockState pState,
 CompoundTag pTag,
 HolderLookup.Provider pRegistries)

setChanged

public void setChanged()

setChanged

protected static void setChanged(Level pLevel,
 BlockPos pPos,
 BlockState pState)

getBlockPos

public BlockPos getBlockPos()

getBlockState

public BlockState getBlockState()

getUpdatePacket

@Nullable
public Packet<ClientGamePacketListener> getUpdatePacket()

getUpdateTag

public CompoundTag getUpdateTag(HolderLookup.Provider pRegistries)

isRemoved

public boolean isRemoved()

setRemoved

public void setRemoved()

clearRemoved

public void clearRemoved()

preRemoveSideEffects

public void preRemoveSideEffects(BlockPos pPos,
 BlockState pState)

triggerEvent

public boolean triggerEvent(int pId,
 int pType)

fillCrashReportCategory

public void fillCrashReportCategory(CrashReportCategory pReportCategory)

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

Deprecated.

applyImplicitComponents

protected void applyImplicitComponents(DataComponentGetter pComponentGetter)

applyComponentsFromItemStack

public final void applyComponentsFromItemStack(ItemStack pStack)

applyComponents

public final void applyComponents(DataComponentMap pComponents,
 DataComponentPatch pPatch)

collectImplicitComponents

protected void collectImplicitComponents(DataComponentMap.Builder pComponents)

removeComponentsFromTag

@Deprecated
public void removeComponentsFromTag(ValueOutput pOutput)

Deprecated.

collectComponents

public final DataComponentMap collectComponents()

components

public DataComponentMap components()

setComponents

public void setComponents(DataComponentMap pComponents)

parseCustomNameSafe

@Nullable
public static Component parseCustomNameSafe(ValueInput pInput,
 String pCustomName)

problemPath

public ProblemReporter.PathElement problemPath()

registerDebugValues

public void registerDebugValues(ServerLevel p_449833_,
 DebugValueSource.Registration p_449301_)

Specified by:

registerDebugValues in interface DebugValueSource