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
named	net/minecraft/item/BlockItem
intermediary	net/minecraft/class_1747
official	csp

Nested Class Summary

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

Item.Settings, Item.TooltipContext

Field Summary

Fields

Modifier and Type	Field	Description
private final Block	block	Deprecated.

Fields inherited from class net.minecraft.item.Item

ATTACK_DAMAGE_MODIFIER_ID, ATTACK_SPEED_MODIFIER_ID, BLOCK_ITEMS, DEFAULT_MAX_COUNT, ITEM_BAR_STEPS, MAX_MAX_COUNT

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, Item.TooltipContext context, List<Text> tooltip, TooltipType type)	Called by the client to append tooltips to an item.
boolean	canBeNested()
protected boolean	canPlace(ItemPlacementContext context, BlockState state)
protected boolean	checkStatePlacement()
private static void	copyComponentsToBlockEntity(World world, BlockPos pos, ItemStack stack)
Block	getBlock()
@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	setBlockEntityData(ItemStack stack, BlockEntityType<?> type, NbtCompound nbt)
ActionResult	useOnBlock(ItemUsageContext context)	Called when an item is used on a block.
static boolean	writeNbtToBlockEntity(World world, @Nullable PlayerEntity player, BlockPos pos, ItemStack stack)

Methods inherited from class net.minecraft.item.Item

asItem, byRawId, canMine, canRepair, finishUsing, fromBlock, getAttributeModifiers, getBonusAttackDamage, getBreakSound, getComponents, getDefaultStack, getDrinkSound, getEatSound, getEnchantability, getItemBarColor, getItemBarStep, getMaxCount, getMaxUseTime, getMiningSpeed, getName, getName, getOrCreateTranslationKey, getRawId, getRecipeRemainder, getRegistryEntry, getTooltipData, getTranslationKey, getUseAction, hasGlint, hasRecipeRemainder, inventoryTick, isCorrectForDrops, isEnchantable, isItemBarVisible, isNetworkSynced, isUsedOnRelease, onClicked, onCraft, onCraftByPlayer, onStackClicked, onStoppedUsing, postHit, postMine, postProcessComponents, 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

@Deprecated
private final Block block

Deprecated.

Mappings:

Namespace	Name	Mixin selector
named	block	Lnet/minecraft/item/BlockItem;block:Lnet/minecraft/block/Block;
intermediary	field_7901	Lnet/minecraft/class_1747;field_7901:Lnet/minecraft/class_2248;
official	a	Lcsp;a:Ldfb;

Constructor Details

BlockItem

public BlockItem(Block block,
 Item.Settings settings)

Mappings:

Namespace	Name	Mixin selector
named	<init>	Lnet/minecraft/item/BlockItem;<init>(Lnet/minecraft/block/Block;Lnet/minecraft/item/Item$Settings;)V
intermediary	<init>	Lnet/minecraft/class_1747;<init>(Lnet/minecraft/class_2248;Lnet/minecraft/class_1792$class_1793;)V
official	<init>	Lcsp;<init>(Ldfb;Lcum$a;)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
named	useOnBlock	Lnet/minecraft/item/Item;useOnBlock(Lnet/minecraft/item/ItemUsageContext;)Lnet/minecraft/util/ActionResult;
intermediary	method_7884	Lnet/minecraft/class_1792;method_7884(Lnet/minecraft/class_1838;)Lnet/minecraft/class_1269;
official	a	Lcum;a(Lcye;)Lbqw;

place

public ActionResult place(ItemPlacementContext context)

Mappings:

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

getPlaceSound

protected SoundEvent getPlaceSound(BlockState state)

Mappings:

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

getPlacementContext

@Nullable
public @Nullable ItemPlacementContext getPlacementContext(ItemPlacementContext context)

Mappings:

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

copyComponentsToBlockEntity

private static void copyComponentsToBlockEntity(World world,
 BlockPos pos,
 ItemStack stack)

Mappings:

Namespace	Name	Mixin selector
named	copyComponentsToBlockEntity	Lnet/minecraft/item/BlockItem;copyComponentsToBlockEntity(Lnet/minecraft/world/World;Lnet/minecraft/util/math/BlockPos;Lnet/minecraft/item/ItemStack;)V
intermediary	method_57339	Lnet/minecraft/class_1747;method_57339(Lnet/minecraft/class_1937;Lnet/minecraft/class_2338;Lnet/minecraft/class_1799;)V
official	a	Lcsp;a(Ldca;Liz;Lcur;)V

postPlacement

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

Mappings:

Namespace	Name	Mixin selector
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
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
official	a	Lcsp;a(Liz;Ldca;Lcmz;Lcur;Ldse;)Z

getPlacementState

@Nullable
protected @Nullable BlockState getPlacementState(ItemPlacementContext context)

Mappings:

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

placeFromNbt

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

Mappings:

Namespace	Name	Mixin selector
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;
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;
official	a	Lcsp;a(Liz;Ldca;Lcur;Ldse;)Ldse;

canPlace

protected boolean canPlace(ItemPlacementContext context,
 BlockState state)

Mappings:

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

checkStatePlacement

protected boolean checkStatePlacement()

Mappings:

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

place

protected boolean place(ItemPlacementContext context,
 BlockState state)

Mappings:

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

writeNbtToBlockEntity

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

Mappings:

Namespace	Name	Mixin selector
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
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
official	a	Lcsp;a(Ldca;Lcmz;Liz;Lcur;)Z

getTranslationKey

public String getTranslationKey()

Gets the translation key of this item.

Overrides:

getTranslationKey in class Item

Mappings:

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

appendTooltip

public void appendTooltip(ItemStack stack,
 Item.TooltipContext context,
 List<Text> tooltip,
 TooltipType type)

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
named	appendTooltip	Lnet/minecraft/item/Item;appendTooltip(Lnet/minecraft/item/ItemStack;Lnet/minecraft/item/Item$TooltipContext;Ljava/util/List;Lnet/minecraft/client/item/TooltipType;)V
intermediary	method_7851	Lnet/minecraft/class_1792;method_7851(Lnet/minecraft/class_1799;Lnet/minecraft/class_1792$class_9635;Ljava/util/List;Lnet/minecraft/class_1836;)V
official	a	Lcum;a(Lcur;Lcum$b;Ljava/util/List;Lcwk;)V

getBlock

public Block getBlock()

Mappings:

Namespace	Name	Mixin selector
named	getBlock	Lnet/minecraft/item/BlockItem;getBlock()Lnet/minecraft/block/Block;
intermediary	method_7711	Lnet/minecraft/class_1747;method_7711()Lnet/minecraft/class_2248;
official	d	Lcsp;d()Ldfb;

appendBlocks

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

Mappings:

Namespace	Name	Mixin selector
named	appendBlocks	Lnet/minecraft/item/BlockItem;appendBlocks(Ljava/util/Map;Lnet/minecraft/item/Item;)V
intermediary	method_7713	Lnet/minecraft/class_1747;method_7713(Ljava/util/Map;Lnet/minecraft/class_1792;)V
official	a	Lcsp;a(Ljava/util/Map;Lcum;)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
named	canBeNested	Lnet/minecraft/item/Item;canBeNested()Z
intermediary	method_31568	Lnet/minecraft/class_1792;method_31568()Z
official	am_	Lcum;am_()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.lang.Iterable<net.minecraft.item.ItemStack>)

Mappings:

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

setBlockEntityData

public static void setBlockEntityData(ItemStack stack,
 BlockEntityType<?> type,
 NbtCompound nbt)

Mappings:

Namespace	Name	Mixin selector
named	setBlockEntityData	Lnet/minecraft/item/BlockItem;setBlockEntityData(Lnet/minecraft/item/ItemStack;Lnet/minecraft/block/entity/BlockEntityType;Lnet/minecraft/nbt/NbtCompound;)V
intermediary	method_57338	Lnet/minecraft/class_1747;method_57338(Lnet/minecraft/class_1799;Lnet/minecraft/class_2591;Lnet/minecraft/class_2487;)V
official	a	Lcsp;a(Lcur;Ldpl;Lus;)V

getRequiredFeatures

public FeatureSet getRequiredFeatures()

Specified by:

getRequiredFeatures in interface ToggleableFeature

Overrides:

getRequiredFeatures in class Item

Mappings:

Namespace	Name	Mixin selector
named	getRequiredFeatures	Lnet/minecraft/resource/featuretoggle/ToggleableFeature;getRequiredFeatures()Lnet/minecraft/resource/featuretoggle/FeatureSet;
intermediary	method_45322	Lnet/minecraft/class_7695;method_45322()Lnet/minecraft/class_7699;
official	i	Lcpk;i()Lcpn;