Package net.minecraft.block.entity

Class LockableContainerBlockEntity

java.lang.Object

net.minecraft.block.entity.BlockEntity

net.minecraft.block.entity.LockableContainerBlockEntity

All Implemented Interfaces:

Inventory, NamedScreenHandlerFactory, ScreenHandlerFactory, Clearable, Nameable

Direct Known Subclasses:

AbstractFurnaceBlockEntity, BrewingStandBlockEntity, LootableContainerBlockEntity

public abstract class LockableContainerBlockEntity
extends BlockEntity
implements Inventory, NamedScreenHandlerFactory, Nameable

Mappings:

Namespace	Name
intermediary	net/minecraft/class_2624
official	cze
named	net/minecraft/block/entity/LockableContainerBlockEntity

Field Summary

Fields

Modifier and Type	Field	Description
private @Nullable Text	customName
private ContainerLock	lock

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

pos, removed, world

Fields inherited from interface net.minecraft.inventory.Inventory

field_42619, MAX_COUNT_PER_STACK

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	LockableContainerBlockEntity(BlockEntityType<?> type, BlockPos pos, BlockState state)

Method Summary

Modifier and Type	Method	Description
boolean	checkUnlocked(PlayerEntity player)
static boolean	checkUnlocked(PlayerEntity player, ContainerLock lock, Text containerName)
@Nullable ScreenHandler	createMenu(int syncId, PlayerInventory playerInventory, PlayerEntity player)
protected abstract ScreenHandler	createScreenHandler(int syncId, PlayerInventory playerInventory)
protected abstract Text	getContainerName()
@Nullable Text	getCustomName()	Returns the custom name of this object, or null if there is none.
Text	getDisplayName()	Returns the title of this screen handler; will be a part of the open screen packet sent to the client.
Text	getName()	Returns the name of this object.
void	readNbt(NbtCompound nbt)	Reads data from nbt.
void	setCustomName(Text customName)
protected void	writeNbt(NbtCompound nbt)	Writes data to nbt.

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

cancelRemoval, copyItemDataRequiresOperator, createFromNbt, createNbt, createNbtWithId, createNbtWithIdentifyingData, getCachedState, getPos, getType, getWorld, hasWorld, isRemoved, markDirty, markDirty, markRemoved, onSyncedBlockEvent, populateCrashReport, posFromNbt, setCachedState, setStackNbt, setWorld, toInitialChunkDataNbt, toUpdatePacket, writeIdToNbt

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.Clearable

clear

Methods inherited from interface net.minecraft.inventory.Inventory

canPlayerUse, canTransferTo, containsAny, containsAny, count, getMaxCountPerStack, getStack, isEmpty, isValid, markDirty, onClose, onOpen, removeStack, removeStack, setStack, size

Methods inherited from interface net.minecraft.util.Nameable

hasCustomName

Field Details

lock

private ContainerLock lock

Mappings:

Namespace	Name	Mixin selector
intermediary	field_12045	Lnet/minecraft/class_2624;field_12045:Lnet/minecraft/class_1273;
official	c	Lcze;c:Lbdy;
named	lock	Lnet/minecraft/block/entity/LockableContainerBlockEntity;lock:Lnet/minecraft/inventory/ContainerLock;

customName

@Nullable
private @Nullable Text customName

Mappings:

Namespace	Name	Mixin selector
intermediary	field_17376	Lnet/minecraft/class_2624;field_17376:Lnet/minecraft/class_2561;
official	d	Lcze;d:Lsw;
named	customName	Lnet/minecraft/block/entity/LockableContainerBlockEntity;customName:Lnet/minecraft/text/Text;

Constructor Details

LockableContainerBlockEntity

protected LockableContainerBlockEntity(BlockEntityType<?> type,
 BlockPos pos,
 BlockState state)

Mappings:

Namespace	Name	Mixin selector
intermediary	<init>	Lnet/minecraft/class_2586;<init>(Lnet/minecraft/class_2591;Lnet/minecraft/class_2338;Lnet/minecraft/class_2680;)V
official	<init>	Lczk;<init>(Lczm;Lgu;Ldby;)V
named	<init>	Lnet/minecraft/block/entity/BlockEntity;<init>(Lnet/minecraft/block/entity/BlockEntityType;Lnet/minecraft/util/math/BlockPos;Lnet/minecraft/block/BlockState;)V

Method Details

readNbt

public void readNbt(NbtCompound nbt)

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:

readNbt in class BlockEntity

See Also:

• BlockEntity.writeNbt(net.minecraft.nbt.NbtCompound)

Mappings:

Namespace	Name	Mixin selector
intermediary	method_11014	Lnet/minecraft/class_2586;method_11014(Lnet/minecraft/class_2487;)V
official	a	Lczk;a(Lqr;)V
named	readNbt	Lnet/minecraft/block/entity/BlockEntity;readNbt(Lnet/minecraft/nbt/NbtCompound;)V

writeNbt

protected void writeNbt(NbtCompound nbt)

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:

writeNbt in class BlockEntity

See Also:

• BlockEntity.readNbt(net.minecraft.nbt.NbtCompound)

Mappings:

Namespace	Name	Mixin selector
intermediary	method_11007	Lnet/minecraft/class_2586;method_11007(Lnet/minecraft/class_2487;)V
official	b	Lczk;b(Lqr;)V
named	writeNbt	Lnet/minecraft/block/entity/BlockEntity;writeNbt(Lnet/minecraft/nbt/NbtCompound;)V

setCustomName

public void setCustomName(Text customName)

Mappings:

Namespace	Name	Mixin selector
intermediary	method_17488	Lnet/minecraft/class_2624;method_17488(Lnet/minecraft/class_2561;)V
official	a	Lcze;a(Lsw;)V
named	setCustomName	Lnet/minecraft/block/entity/LockableContainerBlockEntity;setCustomName(Lnet/minecraft/text/Text;)V

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
intermediary	method_5477	Lnet/minecraft/class_1275;method_5477()Lnet/minecraft/class_2561;
official	Y	Lbea;Y()Lsw;
named	getName	Lnet/minecraft/util/Nameable;getName()Lnet/minecraft/text/Text;

getDisplayName

public Text getDisplayName()

Returns the title of this screen handler; will be a part of the open screen packet sent to the client.

Specified by:

getDisplayName in interface Nameable

Specified by:

getDisplayName in interface NamedScreenHandlerFactory

Returns:

the display name of this object

Mappings:

Namespace	Name	Mixin selector
intermediary	method_5476	Lnet/minecraft/class_3908;method_5476()Lnet/minecraft/class_2561;
official	G_	Lbdz;G_()Lsw;
named	getDisplayName	Lnet/minecraft/screen/NamedScreenHandlerFactory;getDisplayName()Lnet/minecraft/text/Text;

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
intermediary	method_5797	Lnet/minecraft/class_1275;method_5797()Lnet/minecraft/class_2561;
official	aa	Lbea;aa()Lsw;
named	getCustomName	Lnet/minecraft/util/Nameable;getCustomName()Lnet/minecraft/text/Text;

getContainerName

protected abstract Text getContainerName()

Mappings:

Namespace	Name	Mixin selector
intermediary	method_17823	Lnet/minecraft/class_2624;method_17823()Lnet/minecraft/class_2561;
official	g	Lcze;g()Lsw;
named	getContainerName	Lnet/minecraft/block/entity/LockableContainerBlockEntity;getContainerName()Lnet/minecraft/text/Text;

checkUnlocked

public boolean checkUnlocked(PlayerEntity player)

Mappings:

Namespace	Name	Mixin selector
intermediary	method_17489	Lnet/minecraft/class_2624;method_17489(Lnet/minecraft/class_1657;)Z
official	d	Lcze;d(Lbym;)Z
named	checkUnlocked	Lnet/minecraft/block/entity/LockableContainerBlockEntity;checkUnlocked(Lnet/minecraft/entity/player/PlayerEntity;)Z

checkUnlocked

public static boolean checkUnlocked(PlayerEntity player,
 ContainerLock lock,
 Text containerName)

Mappings:

Namespace	Name	Mixin selector
intermediary	method_17487	Lnet/minecraft/class_2624;method_17487(Lnet/minecraft/class_1657;Lnet/minecraft/class_1273;Lnet/minecraft/class_2561;)Z
official	a	Lcze;a(Lbym;Lbdy;Lsw;)Z
named	checkUnlocked	Lnet/minecraft/block/entity/LockableContainerBlockEntity;checkUnlocked(Lnet/minecraft/entity/player/PlayerEntity;Lnet/minecraft/inventory/ContainerLock;Lnet/minecraft/text/Text;)Z

createMenu

@Nullable
public @Nullable ScreenHandler createMenu(int syncId,
 PlayerInventory playerInventory,
 PlayerEntity player)

Specified by:

createMenu in interface ScreenHandlerFactory

Mappings:

Namespace	Name	Mixin selector
intermediary	createMenu	Lnet/minecraft/class_1270;createMenu(ILnet/minecraft/class_1661;Lnet/minecraft/class_1657;)Lnet/minecraft/class_1703;
official	createMenu	Lcch;createMenu(ILbyl;Lbym;)Lcbd;
named	createMenu	Lnet/minecraft/screen/ScreenHandlerFactory;createMenu(ILnet/minecraft/entity/player/PlayerInventory;Lnet/minecraft/entity/player/PlayerEntity;)Lnet/minecraft/screen/ScreenHandler;

createScreenHandler

protected abstract ScreenHandler createScreenHandler(int syncId,
 PlayerInventory playerInventory)

Mappings:

Namespace	Name	Mixin selector
intermediary	method_5465	Lnet/minecraft/class_2624;method_5465(ILnet/minecraft/class_1661;)Lnet/minecraft/class_1703;
official	a	Lcze;a(ILbyl;)Lcbd;
named	createScreenHandler	Lnet/minecraft/block/entity/LockableContainerBlockEntity;createScreenHandler(ILnet/minecraft/entity/player/PlayerInventory;)Lnet/minecraft/screen/ScreenHandler;