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, BlockPropertyTests.LightBlockEntity, BrushableBlockEntity, CampfireBlockEntity, ChiseledBookShelfBlockEntity, CommandBlockEntity, ComparatorBlockEntity, ConduitBlockEntity, CustomItemDisplayContextTest.ItemHangerBlockEntity, DaylightDetectorBlockEntity, DecoratedPotBlockEntity, EnchantingTableBlockEntity, EnderChestBlockEntity, FullPotsAccessorDemo.DioriteFlowerPotBlockEntity, GameTestTest.EnergyBlockEntity, JigsawBlockEntity, JukeboxBlockEntity, LecternBlockEntity, MegaModelTest.TestBlock.Entity, PistonMovingBlockEntity, SculkCatalystBlockEntity, SculkSensorBlockEntity, SculkShriekerBlockEntity, SignBlockEntity, SkullBlockEntity, SpawnerBlockEntity, StructureBlockEntity, TheEndPortalBlockEntity, TrialSpawnerBlockEntity, VaultBlockEntity

public abstract class BlockEntity
extends AttachmentHolder
implements IBlockEntityExtension

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	BlockEntity.ComponentHelper
protected static interface	BlockEntity.DataComponentInput

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
protected final BlockPos	worldPosition

Fields inherited from class net.neoforged.neoforge.attachment.AttachmentHolder

ATTACHMENTS_NBT_KEY

Constructor Summary

Constructors

Constructor	Description
BlockEntity(BlockEntityType<?> p_155228_, BlockPos p_155229_, BlockState p_155230_)

Method Summary

Modifier and Type	Method	Description
static void	addEntityType(CompoundTag p_187469_, BlockEntityType<?> p_187470_)
final void	applyComponents(DataComponentMap p_330364_, DataComponentPatch p_338381_)
final void	applyComponentsFromItemStack(ItemStack p_338428_)
protected void	applyImplicitComponents(BlockEntity.DataComponentInput p_338718_)
void	clearRemoved()
final DataComponentMap	collectComponents()
protected void	collectImplicitComponents(DataComponentMap.Builder p_338210_)
DataComponentMap	components()
void	fillCrashReportCategory(CrashReportCategory p_58887_)
BlockPos	getBlockPos()
BlockState	getBlockState()
Level	getLevel()
CompoundTag	getPersistentData()	Gets a CompoundTag that can be used to store custom data for this block entity.
static BlockPos	getPosFromTag(CompoundTag p_187473_)
BlockEntityType<?>	getType()
Packet<ClientGamePacketListener>	getUpdatePacket()
CompoundTag	getUpdateTag(HolderLookup.Provider p_323910_)
boolean	hasLevel()
boolean	isRemoved()
protected void	loadAdditional(CompoundTag p_338466_, HolderLookup.Provider p_338445_)
final void	loadCustomOnly(CompoundTag p_338387_, HolderLookup.Provider p_338713_)
static BlockEntity	loadStatic(BlockPos p_155242_, BlockState p_155243_, CompoundTag p_155244_, HolderLookup.Provider p_323542_)
final void	loadWithComponents(CompoundTag p_338356_, HolderLookup.Provider p_338558_)
boolean	onlyOpCanSetNbt()
static Component	parseCustomNameSafe(String p_342033_, HolderLookup.Provider p_342030_)
void	removeComponentsFromTag(CompoundTag p_332032_)	Deprecated.
final <T> T	removeData(AttachmentType<T> type)	Removes the data attachment of the given type.
protected void	saveAdditional(CompoundTag p_187471_, HolderLookup.Provider p_323635_)
final CompoundTag	saveCustomAndMetadata(HolderLookup.Provider p_339688_)
final CompoundTag	saveCustomOnly(HolderLookup.Provider p_338656_)
private void	saveId(CompoundTag p_187475_)
private void	saveMetadata(CompoundTag p_187479_)
void	saveToItem(ItemStack p_187477_, HolderLookup.Provider p_323484_)
final CompoundTag	saveWithFullMetadata(HolderLookup.Provider p_323767_)
final CompoundTag	saveWithId(HolderLookup.Provider p_324357_)
final CompoundTag	saveWithoutMetadata(HolderLookup.Provider p_324030_)
void	setBlockState(BlockState p_155251_)	Deprecated.
void	setChanged()
protected static void	setChanged(Level p_155233_, BlockPos p_155234_, BlockState p_155235_)
void	setComponents(DataComponentMap p_338529_)
final <T> T	setData(AttachmentType<T> type, T data)	Sets the data attachment of the given type.
void	setLevel(Level p_155231_)
void	setRemoved()
boolean	triggerEvent(int p_58889_, int p_58890_)

Methods inherited from class net.neoforged.neoforge.attachment.AttachmentHolder

deserializeAttachments, getData, getExistingData, 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, hasData, removeData, setData

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

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

Field Details

LOGGER

private static final org.slf4j.Logger LOGGER

type

private final BlockEntityType<?> type

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<?> p_155228_,
 BlockPos p_155229_,
 BlockState p_155230_)

Method Details

getPosFromTag

public static BlockPos getPosFromTag(CompoundTag p_187473_)

getLevel

@Nullable
public Level getLevel()

setLevel

public void setLevel(Level p_155231_)

hasLevel

public boolean hasLevel()

loadAdditional

protected void loadAdditional(CompoundTag p_338466_,
 HolderLookup.Provider p_338445_)

loadWithComponents

public final void loadWithComponents(CompoundTag p_338356_,
 HolderLookup.Provider p_338558_)

loadCustomOnly

public final void loadCustomOnly(CompoundTag p_338387_,
 HolderLookup.Provider p_338713_)

saveAdditional

protected void saveAdditional(CompoundTag p_187471_,
 HolderLookup.Provider p_323635_)

saveWithFullMetadata

public final CompoundTag saveWithFullMetadata(HolderLookup.Provider p_323767_)

saveWithId

public final CompoundTag saveWithId(HolderLookup.Provider p_324357_)

saveWithoutMetadata

public final CompoundTag saveWithoutMetadata(HolderLookup.Provider p_324030_)

saveCustomOnly

public final CompoundTag saveCustomOnly(HolderLookup.Provider p_338656_)

saveCustomAndMetadata

public final CompoundTag saveCustomAndMetadata(HolderLookup.Provider p_339688_)

saveId

private void saveId(CompoundTag p_187475_)

addEntityType

public static void addEntityType(CompoundTag p_187469_,
 BlockEntityType<?> p_187470_)

saveToItem

public void saveToItem(ItemStack p_187477_,
 HolderLookup.Provider p_323484_)

saveMetadata

private void saveMetadata(CompoundTag p_187479_)

loadStatic

@Nullable
public static BlockEntity loadStatic(BlockPos p_155242_,
 BlockState p_155243_,
 CompoundTag p_155244_,
 HolderLookup.Provider p_323542_)

setChanged

public void setChanged()

setChanged

protected static void setChanged(Level p_155233_,
 BlockPos p_155234_,
 BlockState p_155235_)

getBlockPos

public BlockPos getBlockPos()

getBlockState

public BlockState getBlockState()

getUpdatePacket

@Nullable
public Packet<ClientGamePacketListener> getUpdatePacket()

getUpdateTag

public CompoundTag getUpdateTag(HolderLookup.Provider p_323910_)

isRemoved

public boolean isRemoved()

setRemoved

public void setRemoved()

clearRemoved

public void clearRemoved()

triggerEvent

public boolean triggerEvent(int p_58889_,
 int p_58890_)

fillCrashReportCategory

public void fillCrashReportCategory(CrashReportCategory p_58887_)

onlyOpCanSetNbt

public boolean onlyOpCanSetNbt()

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

setBlockState

@Deprecated
public void setBlockState(BlockState p_155251_)

Deprecated.

applyImplicitComponents

protected void applyImplicitComponents(BlockEntity.DataComponentInput p_338718_)

applyComponentsFromItemStack

public final void applyComponentsFromItemStack(ItemStack p_338428_)

applyComponents

public final void applyComponents(DataComponentMap p_330364_,
 DataComponentPatch p_338381_)

collectImplicitComponents

protected void collectImplicitComponents(DataComponentMap.Builder p_338210_)

removeComponentsFromTag

@Deprecated
public void removeComponentsFromTag(CompoundTag p_332032_)

Deprecated.

collectComponents

public final DataComponentMap collectComponents()

components

public DataComponentMap components()

setComponents

public void setComponents(DataComponentMap p_338529_)

parseCustomNameSafe

@Nullable
public static Component parseCustomNameSafe(String p_342033_,
 HolderLookup.Provider p_342030_)