Package net.minecraft.block.entity

Class BannerBlockEntity

java.lang.Object

net.minecraft.block.entity.BlockEntity

net.minecraft.block.entity.BannerBlockEntity

All Implemented Interfaces:

Nameable, DebugTrackable

public class BannerBlockEntity
extends BlockEntity
implements Nameable

Mappings:

Namespace	Name
named	net/minecraft/block/entity/BannerBlockEntity
intermediary	net/minecraft/class_2573
official	efu

Nested Class Summary

Nested classes/interfaces inherited from interface net.minecraft.world.debug.DebugTrackable

DebugTrackable.DebugDataSupplier<T>, DebugTrackable.Tracker

Field Summary

Fields

Modifier and Type	Field	Description
private final DyeColor	baseColor
private static final Text	BLOCK_NAME
private @Nullable Text	customName
static final int	MAX_PATTERN_COUNT
private BannerPatternsComponent	patterns
private static final String	PATTERNS_KEY

Fields inherited from class net.minecraft.block.entity.BlockEntity

pos, removed, world

Constructor Summary

Constructors

Constructor	Description
BannerBlockEntity(BlockPos pos, BlockState state)
BannerBlockEntity(BlockPos pos, BlockState state, DyeColor baseColor)

Method Summary

Modifier and Type	Method	Description
protected void	addComponents(ComponentMap.Builder builder)
DyeColor	getColorForState()
@Nullable Text	getCustomName()	Returns the custom name of this object, or null if there is none.
Text	getName()	Returns the name of this object.
BannerPatternsComponent	getPatterns()
ItemStack	getPickStack()
protected void	readComponents(ComponentsAccess components)
protected void	readData(ReadView view)	Reads data from nbt.
void	removeFromCopiedStackData(WriteView view)
NbtCompound	toInitialChunkDataNbt(RegistryWrapper.WrapperLookup registries)	Returns the serialized state of this block entity that is observable by clients.
BlockEntityUpdateS2CPacket	toUpdatePacket()	Returns the packet to send to nearby players when the block entity's observable state changes, or null to not send the packet.
protected void	writeData(WriteView view)	Writes data to nbt.

Methods inherited from class net.minecraft.block.entity.BlockEntity

cancelRemoval, createComponentlessNbt, createComponentMap, createFromNbt, createNbt, createNbtWithIdentifyingData, getCachedState, getComponents, getNameForReport, getPos, getReporterContext, getType, getWorld, hasWorld, isRemoved, markDirty, markDirty, markRemoved, onBlockReplaced, onSyncedBlockEvent, populateCrashReport, posFromNbt, read, readComponentlessData, readComponents, readComponents, registerTracking, setCachedState, setComponents, setWorld, supports, tryParseCustomName, writeComponentlessData, writeDataWithId, writeDataWithoutId, writeFullData, writeId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.minecraft.util.Nameable

getDisplayName, getStringifiedName, hasCustomName

Field Details

MAX_PATTERN_COUNT

public static final int MAX_PATTERN_COUNT

See Also:

• Constant Field Values

Mappings:

Namespace	Name	Mixin selector
named	MAX_PATTERN_COUNT	Lnet/minecraft/block/entity/BannerBlockEntity;MAX_PATTERN_COUNT:I
intermediary	field_31296	Lnet/minecraft/class_2573;field_31296:I
official	a	Lefu;a:I

PATTERNS_KEY

private static final String PATTERNS_KEY

See Also:

• Constant Field Values

Mappings:

Namespace	Name	Mixin selector
named	PATTERNS_KEY	Lnet/minecraft/block/entity/BannerBlockEntity;PATTERNS_KEY:Ljava/lang/String;
intermediary	field_31297	Lnet/minecraft/class_2573;field_31297:Ljava/lang/String;
official	b	Lefu;b:Ljava/lang/String;

BLOCK_NAME

private static final Text BLOCK_NAME

Mappings:

Namespace	Name	Mixin selector
named	BLOCK_NAME	Lnet/minecraft/block/entity/BannerBlockEntity;BLOCK_NAME:Lnet/minecraft/text/Text;
intermediary	field_63035	Lnet/minecraft/class_2573;field_63035:Lnet/minecraft/class_2561;
official	c	Lefu;c:Lxx;

customName

@Nullable
private @Nullable Text customName

Mappings:

Namespace	Name	Mixin selector
named	customName	Lnet/minecraft/block/entity/BannerBlockEntity;customName:Lnet/minecraft/text/Text;
intermediary	field_11772	Lnet/minecraft/class_2573;field_11772:Lnet/minecraft/class_2561;
official	d	Lefu;d:Lxx;

baseColor

private final DyeColor baseColor

Mappings:

Namespace	Name	Mixin selector
named	baseColor	Lnet/minecraft/block/entity/BannerBlockEntity;baseColor:Lnet/minecraft/util/DyeColor;
intermediary	field_11774	Lnet/minecraft/class_2573;field_11774:Lnet/minecraft/class_1767;
official	e	Lefu;e:Ldgn;

patterns

private BannerPatternsComponent patterns

Mappings:

Namespace	Name	Mixin selector
named	patterns	Lnet/minecraft/block/entity/BannerBlockEntity;patterns:Lnet/minecraft/component/type/BannerPatternsComponent;
intermediary	field_49756	Lnet/minecraft/class_2573;field_49756:Lnet/minecraft/class_9307;
official	f	Lefu;f:Lefw;

Constructor Details

BannerBlockEntity

public BannerBlockEntity(BlockPos pos,
 BlockState state)

Mappings:

Namespace	Name	Mixin selector
named	<init>	Lnet/minecraft/block/entity/BannerBlockEntity;<init>(Lnet/minecraft/util/math/BlockPos;Lnet/minecraft/block/BlockState;)V
intermediary	<init>	Lnet/minecraft/class_2573;<init>(Lnet/minecraft/class_2338;Lnet/minecraft/class_2680;)V
official	<init>	Lefu;<init>(Lja;Lejm;)V

BannerBlockEntity

public BannerBlockEntity(BlockPos pos,
 BlockState state,
 DyeColor baseColor)

Mappings:

Namespace	Name	Mixin selector
named	<init>	Lnet/minecraft/block/entity/BannerBlockEntity;<init>(Lnet/minecraft/util/math/BlockPos;Lnet/minecraft/block/BlockState;Lnet/minecraft/util/DyeColor;)V
intermediary	<init>	Lnet/minecraft/class_2573;<init>(Lnet/minecraft/class_2338;Lnet/minecraft/class_2680;Lnet/minecraft/class_1767;)V
official	<init>	Lefu;<init>(Lja;Lejm;Ldgn;)V

Method Details

getName

public Text getName()

Returns the name of this object.

This should return the custom name if it exists, otherwise the default name. This should not have styling applied.

Specified by:

getName in interface Nameable

Returns:

the name of this object

Mappings:

Namespace	Name	Mixin selector
named	getName	Lnet/minecraft/util/Nameable;getName()Lnet/minecraft/text/Text;
intermediary	method_5477	Lnet/minecraft/class_1275;method_5477()Lnet/minecraft/class_2561;
official	ao	Lcbu;ao()Lxx;

getCustomName

@Nullable
public @Nullable Text getCustomName()

Returns the custom name of this object, or null if there is none.

Specified by:

getCustomName in interface Nameable

Returns:

the custom name of this object, or null if there is none

Mappings:

Namespace	Name	Mixin selector
named	getCustomName	Lnet/minecraft/util/Nameable;getCustomName()Lnet/minecraft/text/Text;
intermediary	method_5797	Lnet/minecraft/class_1275;method_5797()Lnet/minecraft/class_2561;
official	ar	Lcbu;ar()Lxx;

writeData

protected void writeData(WriteView view)

Writes data to nbt. Subclasses should override this if they store a persistent data.

NBT is a storage format; therefore, a data from NBT is loaded to a block entity instance's fields, which are used for other operations instead of the NBT. The data is written back to NBT when saving the block entity.

Overrides:

writeData in class BlockEntity

See Also:

• invalid reference

  #readNbt

Mappings:

Namespace	Name	Mixin selector
named	writeData	Lnet/minecraft/block/entity/BlockEntity;writeData(Lnet/minecraft/storage/WriteView;)V
intermediary	method_11007	Lnet/minecraft/class_2586;method_11007(Lnet/minecraft/class_11372;)V
official	a	Legg;a(Lfir;)V

readData

protected void readData(ReadView view)

Reads data from nbt. Subclasses should override this if they store a persistent data.

NBT is a storage format; therefore, a data from NBT is loaded to a block entity instance's fields, which are used for other operations instead of the NBT. The data is written back to NBT when saving the block entity.

nbt might not have all expected keys, or might have a key whose value does not meet the requirement (such as the type or the range). This method should fall back to a reasonable default value instead of throwing an exception.

Overrides:

readData in class BlockEntity

See Also:

• invalid reference

  #writeNbt

Mappings:

Namespace	Name	Mixin selector
named	readData	Lnet/minecraft/block/entity/BlockEntity;readData(Lnet/minecraft/storage/ReadView;)V
intermediary	method_11014	Lnet/minecraft/class_2586;method_11014(Lnet/minecraft/class_11368;)V
official	a	Legg;a(Lfip;)V

toUpdatePacket

public BlockEntityUpdateS2CPacket toUpdatePacket()

Description copied from class: BlockEntity

Returns the packet to send to nearby players when the block entity's observable state changes, or null to not send the packet.

If the data returned by initial chunk data is suitable for updates, the following shortcut can be used to create an update packet: BlockEntityUpdateS2CPacket.create(this). The NBT will be passed to

invalid reference

#readNbt

on the client.

"Observable state" is a state that clients can observe without specific interaction. For example, CampfireBlockEntity's cooked items are observable states, but chests' inventories are not observable states, since the player must first open that chest before they can see the contents.

To sync block entity data using this method, use serverWorld.getChunkManager().markForUpdate(this.getPos());.

Overrides:

toUpdatePacket in class BlockEntity

Returns:

the packet to send to nearby players when the block entity's observable state changes, or null to not send the packet

See Also:

• BlockEntity.toInitialChunkDataNbt(net.minecraft.registry.RegistryWrapper.WrapperLookup)

Mappings:

Namespace	Name	Mixin selector
named	toUpdatePacket	Lnet/minecraft/block/entity/BannerBlockEntity;toUpdatePacket()Lnet/minecraft/network/packet/s2c/play/BlockEntityUpdateS2CPacket;
intermediary	method_16886	Lnet/minecraft/class_2573;method_16886()Lnet/minecraft/class_2622;
official	a	Lefu;a()Lacx;

toInitialChunkDataNbt

public NbtCompound toInitialChunkDataNbt(RegistryWrapper.WrapperLookup registries)

Returns the serialized state of this block entity that is observable by clients.

This is sent alongside the initial chunk data, as well as when the block entity implements toUpdatePacket() and decides to use the default BlockEntityUpdateS2CPacket.

"Observable state" is a state that clients can observe without specific interaction. For example, CampfireBlockEntity's cooked items are observable states, but chests' inventories are not observable states, since the player must first open that chest before they can see the contents.

To send all NBT data of this block entity saved to disk, return BlockEntity.createNbt(net.minecraft.registry.RegistryWrapper.WrapperLookup).

Overrides:

toInitialChunkDataNbt in class BlockEntity

Returns:

the serialized state of this block entity that is observable by clients

See Also:

• toUpdatePacket()

Mappings:

Namespace	Name	Mixin selector
named	toInitialChunkDataNbt	Lnet/minecraft/block/entity/BlockEntity;toInitialChunkDataNbt(Lnet/minecraft/registry/RegistryWrapper$WrapperLookup;)Lnet/minecraft/nbt/NbtCompound;
intermediary	method_16887	Lnet/minecraft/class_2586;method_16887(Lnet/minecraft/class_7225$class_7874;)Lnet/minecraft/class_2487;
official	a	Legg;a(Ljm$a;)Lup;

getPatterns

public BannerPatternsComponent getPatterns()

Mappings:

Namespace	Name	Mixin selector
named	getPatterns	Lnet/minecraft/block/entity/BannerBlockEntity;getPatterns()Lnet/minecraft/component/type/BannerPatternsComponent;
intermediary	method_58122	Lnet/minecraft/class_2573;method_58122()Lnet/minecraft/class_9307;
official	b	Lefu;b()Lefw;

getPickStack

public ItemStack getPickStack()

Mappings:

Namespace	Name	Mixin selector
named	getPickStack	Lnet/minecraft/block/entity/BannerBlockEntity;getPickStack()Lnet/minecraft/item/ItemStack;
intermediary	method_10907	Lnet/minecraft/class_2573;method_10907()Lnet/minecraft/class_1799;
official	c	Lefu;c()Ldhp;

getColorForState

public DyeColor getColorForState()

Mappings:

Namespace	Name	Mixin selector
named	getColorForState	Lnet/minecraft/block/entity/BannerBlockEntity;getColorForState()Lnet/minecraft/util/DyeColor;
intermediary	method_10908	Lnet/minecraft/class_2573;method_10908()Lnet/minecraft/class_1767;
official	f	Lefu;f()Ldgn;

readComponents

protected void readComponents(ComponentsAccess components)

Overrides:

readComponents in class BlockEntity

Mappings:

Namespace	Name	Mixin selector
named	readComponents	Lnet/minecraft/block/entity/BlockEntity;readComponents(Lnet/minecraft/component/ComponentsAccess;)V
intermediary	method_57568	Lnet/minecraft/class_2586;method_57568(Lnet/minecraft/class_9473;)V
official	a	Legg;a(Lkk;)V

addComponents

protected void addComponents(ComponentMap.Builder builder)

Overrides:

addComponents in class BlockEntity

Mappings:

Namespace	Name	Mixin selector
named	addComponents	Lnet/minecraft/block/entity/BlockEntity;addComponents(Lnet/minecraft/component/ComponentMap$Builder;)V
intermediary	method_57567	Lnet/minecraft/class_2586;method_57567(Lnet/minecraft/class_9323$class_9324;)V
official	a	Legg;a(Lkm$a;)V

removeFromCopiedStackData

public void removeFromCopiedStackData(WriteView view)

Overrides:

removeFromCopiedStackData in class BlockEntity

Mappings:

Namespace	Name	Mixin selector
named	removeFromCopiedStackData	Lnet/minecraft/block/entity/BlockEntity;removeFromCopiedStackData(Lnet/minecraft/storage/WriteView;)V
intermediary	method_57569	Lnet/minecraft/class_2586;method_57569(Lnet/minecraft/class_11372;)V
official	b	Legg;b(Lfir;)V