Package net.minecraft.item

Class BlockItem

java.lang.Object

net.minecraft.item.Item

net.minecraft.item.BlockItem

All Implemented Interfaces:

ItemConvertible, ToggleableFeature

Direct Known Subclasses:

AliasedBlockItem, BedItem, OperatorOnlyBlockItem, PlaceableOnWaterItem, PowderSnowBucketItem, ScaffoldingItem, TallBlockItem, VerticallyAttachableBlockItem

public class BlockItem
extends Item

Represents an item corresponding to a block. Using this item places a block in the world.

Mappings:

Namespace	Name
official	cgy
intermediary	net/minecraft/class_1747
named	net/minecraft/item/BlockItem

Nested Class Summary

Nested classes/interfaces inherited from class net.minecraft.item.Item

Item.Settings

Field Summary

Fields

Modifier and Type	Field	Description
private final Block	block	Deprecated.
static final String	BLOCK_ENTITY_TAG_KEY
static final String	BLOCK_STATE_TAG_KEY

Fields inherited from class net.minecraft.item.Item

ATTACK_DAMAGE_MODIFIER_ID, ATTACK_SPEED_MODIFIER_ID, BLOCK_ITEMS, DEFAULT_MAX_COUNT, DEFAULT_MAX_USE_TIME, ITEM_BAR_STEPS

Fields inherited from interface net.minecraft.resource.featuretoggle.ToggleableFeature

FEATURE_ENABLED_REGISTRY_KEYS

Constructor Summary

Constructors

Constructor	Description
BlockItem(Block block, Item.Settings settings)

Method Summary

Modifier and Type	Method	Description
void	appendBlocks(Map<Block,Item> map, Item item)
void	appendTooltip(ItemStack stack, @Nullable World world, List<Text> tooltip, TooltipContext context)	Called by the client to append tooltips to an item.
boolean	canBeNested()
protected boolean	canPlace(ItemPlacementContext context, BlockState state)
protected boolean	checkStatePlacement()
Block	getBlock()
static @Nullable NbtCompound	getBlockEntityNbt(ItemStack stack)
@Nullable ItemPlacementContext	getPlacementContext(ItemPlacementContext context)
protected @Nullable BlockState	getPlacementState(ItemPlacementContext context)
protected SoundEvent	getPlaceSound(BlockState state)
FeatureSet	getRequiredFeatures()
String	getTranslationKey()	Gets the translation key of this item.
void	onItemEntityDestroyed(ItemEntity entity)	Called on the server when an ItemEntity holding this item gets destroyed.
ActionResult	place(ItemPlacementContext context)
protected boolean	place(ItemPlacementContext context, BlockState state)
private BlockState	placeFromNbt(BlockPos pos, World world, ItemStack stack, BlockState state)
protected boolean	postPlacement(BlockPos pos, World world, @Nullable PlayerEntity player, ItemStack stack, BlockState state)
static void	setBlockEntityNbt(ItemStack stack, BlockEntityType<?> blockEntityType, NbtCompound tag)
ActionResult	useOnBlock(ItemUsageContext context)	Called when an item is used on a block.
private static <T extends Comparable<T>> BlockState	with(BlockState state, Property<T> property, String name)
static boolean	writeNbtToBlockEntity(World world, @Nullable PlayerEntity player, BlockPos pos, ItemStack stack)

Methods inherited from class net.minecraft.item.Item

asItem, byRawId, canMine, canRepair, damage, finishUsing, fromBlock, getAttributeModifiers, getDefaultStack, getDrinkSound, getEatSound, getEnchantability, getFoodComponent, getItemBarColor, getItemBarStep, getMaxCount, getMaxDamage, getMaxUseTime, getMiningSpeedMultiplier, getName, getName, getOrCreateTranslationKey, getRarity, getRawId, getRecipeRemainder, getRegistryEntry, getTooltipData, getTranslationKey, getUseAction, hasGlint, hasRecipeRemainder, inventoryTick, isDamageable, isEnchantable, isFireproof, isFood, isItemBarVisible, isNbtSynced, isNetworkSynced, isSuitableFor, isUsedOnRelease, onClicked, onCraft, onStackClicked, onStoppedUsing, postHit, postMine, postProcessNbt, raycast, toString, usageTick, use, useOnEntity

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.minecraft.resource.featuretoggle.ToggleableFeature

isEnabled

Field Details

BLOCK_ENTITY_TAG_KEY

public static final String BLOCK_ENTITY_TAG_KEY

See Also:

• Constant Field Values

Mappings:

Namespace	Name	Mixin selector
official	a	Lcgy;a:Ljava/lang/String;
intermediary	field_30849	Lnet/minecraft/class_1747;field_30849:Ljava/lang/String;
named	BLOCK_ENTITY_TAG_KEY	Lnet/minecraft/item/BlockItem;BLOCK_ENTITY_TAG_KEY:Ljava/lang/String;

BLOCK_STATE_TAG_KEY

public static final String BLOCK_STATE_TAG_KEY

See Also:

• Constant Field Values

Mappings:

Namespace	Name	Mixin selector
official	b	Lcgy;b:Ljava/lang/String;
intermediary	field_30850	Lnet/minecraft/class_1747;field_30850:Ljava/lang/String;
named	BLOCK_STATE_TAG_KEY	Lnet/minecraft/item/BlockItem;BLOCK_STATE_TAG_KEY:Ljava/lang/String;

block

@Deprecated
private final Block block

Deprecated.

Mappings:

Namespace	Name	Mixin selector
official	c	Lcgy;c:Lcsv;
intermediary	field_7901	Lnet/minecraft/class_1747;field_7901:Lnet/minecraft/class_2248;
named	block	Lnet/minecraft/item/BlockItem;block:Lnet/minecraft/block/Block;

Constructor Details

BlockItem

public BlockItem(Block block,
 Item.Settings settings)

Mappings:

Namespace	Name	Mixin selector
official	<init>	Lcgy;<init>(Lcsv;Lcja$a;)V
intermediary	<init>	Lnet/minecraft/class_1747;<init>(Lnet/minecraft/class_2248;Lnet/minecraft/class_1792$class_1793;)V
named	<init>	Lnet/minecraft/item/BlockItem;<init>(Lnet/minecraft/block/Block;Lnet/minecraft/item/Item$Settings;)V

Method Details

useOnBlock

public ActionResult useOnBlock(ItemUsageContext context)

Called when an item is used on a block.

This method is called on both the logical client and logical server, so take caution when using this method. The logical side can be checked using context.getWorld().isClient().

Overrides:

useOnBlock in class Item

Parameters:

context - the usage context

Returns:

an action result that specifies if using the item on a block was successful.

Mappings:

Namespace	Name	Mixin selector
official	a	Lcja;a(Lclp;)Lbgy;
intermediary	method_7884	Lnet/minecraft/class_1792;method_7884(Lnet/minecraft/class_1838;)Lnet/minecraft/class_1269;
named	useOnBlock	Lnet/minecraft/item/Item;useOnBlock(Lnet/minecraft/item/ItemUsageContext;)Lnet/minecraft/util/ActionResult;

place

public ActionResult place(ItemPlacementContext context)

Mappings:

Namespace	Name	Mixin selector
official	a	Lcgy;a(Lcln;)Lbgy;
intermediary	method_7712	Lnet/minecraft/class_1747;method_7712(Lnet/minecraft/class_1750;)Lnet/minecraft/class_1269;
named	place	Lnet/minecraft/item/BlockItem;place(Lnet/minecraft/item/ItemPlacementContext;)Lnet/minecraft/util/ActionResult;

getPlaceSound

protected SoundEvent getPlaceSound(BlockState state)

Mappings:

Namespace	Name	Mixin selector
official	a	Lcgy;a(Ldfj;)Lapc;
intermediary	method_19260	Lnet/minecraft/class_1747;method_19260(Lnet/minecraft/class_2680;)Lnet/minecraft/class_3414;
named	getPlaceSound	Lnet/minecraft/item/BlockItem;getPlaceSound(Lnet/minecraft/block/BlockState;)Lnet/minecraft/sound/SoundEvent;

getPlacementContext

@Nullable
public @Nullable ItemPlacementContext getPlacementContext(ItemPlacementContext context)

Mappings:

Namespace	Name	Mixin selector
official	b	Lcgy;b(Lcln;)Lcln;
intermediary	method_16356	Lnet/minecraft/class_1747;method_16356(Lnet/minecraft/class_1750;)Lnet/minecraft/class_1750;
named	getPlacementContext	Lnet/minecraft/item/BlockItem;getPlacementContext(Lnet/minecraft/item/ItemPlacementContext;)Lnet/minecraft/item/ItemPlacementContext;

postPlacement

protected boolean postPlacement(BlockPos pos,
 World world,
 @Nullable
 @Nullable PlayerEntity player,
 ItemStack stack,
 BlockState state)

Mappings:

Namespace	Name	Mixin selector
official	a	Lcgy;a(Lgw;Lcpv;Lcbu;Lcjf;Ldfj;)Z
intermediary	method_7710	Lnet/minecraft/class_1747;method_7710(Lnet/minecraft/class_2338;Lnet/minecraft/class_1937;Lnet/minecraft/class_1657;Lnet/minecraft/class_1799;Lnet/minecraft/class_2680;)Z
named	postPlacement	Lnet/minecraft/item/BlockItem;postPlacement(Lnet/minecraft/util/math/BlockPos;Lnet/minecraft/world/World;Lnet/minecraft/entity/player/PlayerEntity;Lnet/minecraft/item/ItemStack;Lnet/minecraft/block/BlockState;)Z

getPlacementState

@Nullable
protected @Nullable BlockState getPlacementState(ItemPlacementContext context)

Mappings:

Namespace	Name	Mixin selector
official	c	Lcgy;c(Lcln;)Ldfj;
intermediary	method_7707	Lnet/minecraft/class_1747;method_7707(Lnet/minecraft/class_1750;)Lnet/minecraft/class_2680;
named	getPlacementState	Lnet/minecraft/item/BlockItem;getPlacementState(Lnet/minecraft/item/ItemPlacementContext;)Lnet/minecraft/block/BlockState;

placeFromNbt

private BlockState placeFromNbt(BlockPos pos,
 World world,
 ItemStack stack,
 BlockState state)

Mappings:

Namespace	Name	Mixin selector
official	a	Lcgy;a(Lgw;Lcpv;Lcjf;Ldfj;)Ldfj;
intermediary	method_18084	Lnet/minecraft/class_1747;method_18084(Lnet/minecraft/class_2338;Lnet/minecraft/class_1937;Lnet/minecraft/class_1799;Lnet/minecraft/class_2680;)Lnet/minecraft/class_2680;
named	placeFromNbt	Lnet/minecraft/item/BlockItem;placeFromNbt(Lnet/minecraft/util/math/BlockPos;Lnet/minecraft/world/World;Lnet/minecraft/item/ItemStack;Lnet/minecraft/block/BlockState;)Lnet/minecraft/block/BlockState;

with

private static <T extends Comparable<T>> BlockState with(BlockState state,
 Property<T> property,
 String name)

Mappings:

Namespace	Name	Mixin selector
official	a	Lcgy;a(Ldfj;Ldgm;Ljava/lang/String;)Ldfj;
intermediary	method_18083	Lnet/minecraft/class_1747;method_18083(Lnet/minecraft/class_2680;Lnet/minecraft/class_2769;Ljava/lang/String;)Lnet/minecraft/class_2680;
named	with	Lnet/minecraft/item/BlockItem;with(Lnet/minecraft/block/BlockState;Lnet/minecraft/state/property/Property;Ljava/lang/String;)Lnet/minecraft/block/BlockState;

canPlace

protected boolean canPlace(ItemPlacementContext context,
 BlockState state)

Mappings:

Namespace	Name	Mixin selector
official	b	Lcgy;b(Lcln;Ldfj;)Z
intermediary	method_7709	Lnet/minecraft/class_1747;method_7709(Lnet/minecraft/class_1750;Lnet/minecraft/class_2680;)Z
named	canPlace	Lnet/minecraft/item/BlockItem;canPlace(Lnet/minecraft/item/ItemPlacementContext;Lnet/minecraft/block/BlockState;)Z

checkStatePlacement

protected boolean checkStatePlacement()

Mappings:

Namespace	Name	Mixin selector
official	d	Lcgy;d()Z
intermediary	method_20360	Lnet/minecraft/class_1747;method_20360()Z
named	checkStatePlacement	Lnet/minecraft/item/BlockItem;checkStatePlacement()Z

place

protected boolean place(ItemPlacementContext context,
 BlockState state)

Mappings:

Namespace	Name	Mixin selector
official	a	Lcgy;a(Lcln;Ldfj;)Z
intermediary	method_7708	Lnet/minecraft/class_1747;method_7708(Lnet/minecraft/class_1750;Lnet/minecraft/class_2680;)Z
named	place	Lnet/minecraft/item/BlockItem;place(Lnet/minecraft/item/ItemPlacementContext;Lnet/minecraft/block/BlockState;)Z

writeNbtToBlockEntity

public static boolean writeNbtToBlockEntity(World world,
 @Nullable
 @Nullable PlayerEntity player,
 BlockPos pos,
 ItemStack stack)

Mappings:

Namespace	Name	Mixin selector
official	a	Lcgy;a(Lcpv;Lcbu;Lgw;Lcjf;)Z
intermediary	method_7714	Lnet/minecraft/class_1747;method_7714(Lnet/minecraft/class_1937;Lnet/minecraft/class_1657;Lnet/minecraft/class_2338;Lnet/minecraft/class_1799;)Z
named	writeNbtToBlockEntity	Lnet/minecraft/item/BlockItem;writeNbtToBlockEntity(Lnet/minecraft/world/World;Lnet/minecraft/entity/player/PlayerEntity;Lnet/minecraft/util/math/BlockPos;Lnet/minecraft/item/ItemStack;)Z

getTranslationKey

public String getTranslationKey()

Gets the translation key of this item.

Overrides:

getTranslationKey in class Item

Mappings:

Namespace	Name	Mixin selector
official	a	Lcja;a()Ljava/lang/String;
intermediary	method_7876	Lnet/minecraft/class_1792;method_7876()Ljava/lang/String;
named	getTranslationKey	Lnet/minecraft/item/Item;getTranslationKey()Ljava/lang/String;

appendTooltip

public void appendTooltip(ItemStack stack,
 @Nullable
 @Nullable World world,
 List<Text> tooltip,
 TooltipContext context)

Called by the client to append tooltips to an item. Subclasses can override this and add custom tooltips to tooltip list.

Overrides:

appendTooltip in class Item

Parameters:

tooltip - the list of tooltips to show

Mappings:

Namespace	Name	Mixin selector
official	a	Lcja;a(Lcjf;Lcpv;Ljava/util/List;Lckw;)V
intermediary	method_7851	Lnet/minecraft/class_1792;method_7851(Lnet/minecraft/class_1799;Lnet/minecraft/class_1937;Ljava/util/List;Lnet/minecraft/class_1836;)V
named	appendTooltip	Lnet/minecraft/item/Item;appendTooltip(Lnet/minecraft/item/ItemStack;Lnet/minecraft/world/World;Ljava/util/List;Lnet/minecraft/client/item/TooltipContext;)V

getBlock

public Block getBlock()

Mappings:

Namespace	Name	Mixin selector
official	e	Lcgy;e()Lcsv;
intermediary	method_7711	Lnet/minecraft/class_1747;method_7711()Lnet/minecraft/class_2248;
named	getBlock	Lnet/minecraft/item/BlockItem;getBlock()Lnet/minecraft/block/Block;

appendBlocks

public void appendBlocks(Map<Block,Item> map,
 Item item)

Mappings:

Namespace	Name	Mixin selector
official	a	Lcgy;a(Ljava/util/Map;Lcja;)V
intermediary	method_7713	Lnet/minecraft/class_1747;method_7713(Ljava/util/Map;Lnet/minecraft/class_1792;)V
named	appendBlocks	Lnet/minecraft/item/BlockItem;appendBlocks(Ljava/util/Map;Lnet/minecraft/item/Item;)V

canBeNested

public boolean canBeNested()

Overrides:

canBeNested in class Item

Returns:

true if the item can be placed inside of shulker boxes or bundles.

Mappings:

Namespace	Name	Mixin selector
official	al_	Lcja;al_()Z
intermediary	method_31568	Lnet/minecraft/class_1792;method_31568()Z
named	canBeNested	Lnet/minecraft/item/Item;canBeNested()Z

onItemEntityDestroyed

public void onItemEntityDestroyed(ItemEntity entity)

Called on the server when an ItemEntity holding this item gets destroyed. This can happen due to fire, lava, cactus, explosion, etc. Items that can hold other items should override this to drop its contents.

Overrides:

onItemEntityDestroyed in class Item

See Also:

• ItemUsage.spawnItemContents(net.minecraft.entity.ItemEntity, java.util.stream.Stream<net.minecraft.item.ItemStack>)

Mappings:

Namespace	Name	Mixin selector
official	a	Lcja;a(Lbyn;)V
intermediary	method_33261	Lnet/minecraft/class_1792;method_33261(Lnet/minecraft/class_1542;)V
named	onItemEntityDestroyed	Lnet/minecraft/item/Item;onItemEntityDestroyed(Lnet/minecraft/entity/ItemEntity;)V

getBlockEntityNbt

@Nullable
public static @Nullable NbtCompound getBlockEntityNbt(ItemStack stack)

Mappings:

Namespace	Name	Mixin selector
official	a	Lcgy;a(Lcjf;)Lqw;
intermediary	method_38072	Lnet/minecraft/class_1747;method_38072(Lnet/minecraft/class_1799;)Lnet/minecraft/class_2487;
named	getBlockEntityNbt	Lnet/minecraft/item/BlockItem;getBlockEntityNbt(Lnet/minecraft/item/ItemStack;)Lnet/minecraft/nbt/NbtCompound;

setBlockEntityNbt

public static void setBlockEntityNbt(ItemStack stack,
 BlockEntityType<?> blockEntityType,
 NbtCompound tag)

Mappings:

Namespace	Name	Mixin selector
official	a	Lcgy;a(Lcjf;Ldcx;Lqw;)V
intermediary	method_38073	Lnet/minecraft/class_1747;method_38073(Lnet/minecraft/class_1799;Lnet/minecraft/class_2591;Lnet/minecraft/class_2487;)V
named	setBlockEntityNbt	Lnet/minecraft/item/BlockItem;setBlockEntityNbt(Lnet/minecraft/item/ItemStack;Lnet/minecraft/block/entity/BlockEntityType;Lnet/minecraft/nbt/NbtCompound;)V

getRequiredFeatures

public FeatureSet getRequiredFeatures()

Specified by:

getRequiredFeatures in interface ToggleableFeature

Overrides:

getRequiredFeatures in class Item

Mappings:

Namespace	Name	Mixin selector
official	m	Lcdz;m()Lcec;
intermediary	method_45322	Lnet/minecraft/class_7695;method_45322()Lnet/minecraft/class_7699;
named	getRequiredFeatures	Lnet/minecraft/resource/featuretoggle/ToggleableFeature;getRequiredFeatures()Lnet/minecraft/resource/featuretoggle/FeatureSet;