Package net.minecraft.world.item

Class Item

java.lang.Object

net.minecraft.world.item.Item

All Implemented Interfaces:

FeatureElement, ItemLike, IItemExtension

Direct Known Subclasses:

AirItem, ArmorStandItem, ArrowItem, AxeItem, BlockItem, BoatItem, BoneMealItem, BottleItem, BrushItem, BucketItem, BundleItem, CompassItem, DebugStickItem, DiscFragmentItem, DyeItem, EggItem, EmptyMapItem, EndCrystalItem, EnderEyeItem, EnderpearlItem, ExperienceBottleItem, FireChargeItem, FireworkRocketItem, FishingRodItem, FlintAndSteelItem, FoodOnAStickItem, GlowInkSacItem, HangingEntityItem, HoeItem, HoneycombItem, InkSacItem, InstrumentItem, KnowledgeBookItem, LeadItem, MaceItem, MapItem, MinecartItem, NameTagItem, PotionItem, ProjectileWeaponItem, ShearsItem, ShieldItem, ShovelItem, SmithingTemplateItem, SnowballItem, SpawnEggItem, SpyglassItem, TridentItem, WindChargeItem, WritableBookItem, WrittenBookItem

public class Item
extends Object
implements FeatureElement, ItemLike, IItemExtension

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Item.Properties
static interface	Item.TooltipContext

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ABSOLUTE_MAX_STACK_SIZE
protected static final int	APPROXIMATELY_INFINITE_USE_DURATION
static final ResourceLocation	BASE_ATTACK_DAMAGE_ID
static final ResourceLocation	BASE_ATTACK_SPEED_ID
private final Holder.Reference<Item>	builtInRegistryHolder
static final Map<Block,Item>	BY_BLOCK
protected final boolean	canCombineRepair
static final com.mojang.serialization.Codec<Holder<Item>>	CODEC
private DataComponentMap	components
private final Item	craftingRemainingItem
static final int	DEFAULT_MAX_STACK_SIZE
protected final String	descriptionId
private static final org.slf4j.Logger	LOGGER
static final int	MAX_BAR_WIDTH
private final FeatureFlagSet	requiredFeatures
static final StreamCodec<RegistryFriendlyByteBuf,Holder<Item>>	STREAM_CODEC

Fields inherited from interface net.minecraft.world.flag.FeatureElement

FILTERED_REGISTRIES

Constructor Summary

Constructors

Constructor	Description
Item(Item.Properties properties)

Method Summary

Modifier and Type	Method	Description
void	appendHoverText(ItemStack stack, Item.TooltipContext context, TooltipDisplay tooltipDisplay, Consumer<Component> tooltipAdder, TooltipFlag flag)	Deprecated.
Item	asItem()
Holder.Reference<Item>	builtInRegistryHolder()	Deprecated.
static Item	byBlock(Block block)	Deprecated.
static Item	byId(int id)
boolean	canDestroyBlock(ItemStack stack, BlockState state, Level level, BlockPos pos, LivingEntity entity)
boolean	canFitInsideContainerItems()
DataComponentMap	components()
ItemStack	finishUsingItem(ItemStack stack, Level level, LivingEntity livingEntity)	Called when the player finishes using this Item (E.g. finishes eating.).
float	getAttackDamageBonus(Entity target, float damage, DamageSource damageSource)
int	getBarColor(ItemStack stack)
int	getBarWidth(ItemStack stack)
final ItemStack	getCraftingRemainder()	Deprecated.
DamageSource	getDamageSource(LivingEntity entity)
ItemStack	getDefaultInstance()
int	getDefaultMaxStackSize()
final String	getDescriptionId()
float	getDestroySpeed(ItemStack stack, BlockState state)
static int	getId(Item item)
final Component	getName()
Component	getName(ItemStack stack)
static BlockHitResult	getPlayerPOVHitResult(Level level, Player player, ClipContext.Fluid fluidMode)
Optional<TooltipComponent>	getTooltipImage(ItemStack stack)
ItemUseAnimation	getUseAnimation(ItemStack stack)
int	getUseDuration(ItemStack stack, LivingEntity entity)
void	hurtEnemy(ItemStack stack, LivingEntity target, LivingEntity attacker)
InteractionResult	interactLivingEntity(ItemStack stack, Player player, LivingEntity interactionTarget, InteractionHand usedHand)	Try interacting with given entity.
void	inventoryTick(ItemStack stack, ServerLevel level, Entity entity, EquipmentSlot slot)
boolean	isBarVisible(ItemStack stack)
boolean	isCombineRepairable(ItemStack stack)	Determines if an item is repairable by combining, used by Repair recipes and Grindstone.
boolean	isCorrectToolForDrops(ItemStack stack, BlockState state)
boolean	isFoil(ItemStack stack)	Returns true if this item has an enchantment glint.
boolean	mineBlock(ItemStack stack, Level level, BlockState state, BlockPos pos, LivingEntity miningEntity)	Called when a Block is destroyed using this Item.
void	modifyDefaultComponentsFrom(DataComponentPatch patch)	Deprecated. Neo: do not use, use the event instead
void	onCraftedBy(ItemStack stack, Player player)
void	onCraftedPostProcess(ItemStack stack, Level level)
void	onDestroyed(ItemEntity itemEntity)	Deprecated. Forge: (ItemEntity, DamageSource) Use damage source sensitive version
void	onUseTick(Level level, LivingEntity livingEntity, ItemStack stack, int remainingUseDuration)	Called as the item is being used by an entity.
boolean	overrideOtherStackedOnMe(ItemStack stack, ItemStack other, Slot slot, ClickAction action, Player player, SlotAccess access)
boolean	overrideStackedOnOther(ItemStack stack, Slot slot, ClickAction action, Player player)
void	postHurtEnemy(ItemStack stack, LivingEntity target, LivingEntity attacker)
boolean	releaseUsing(ItemStack stack, Level level, LivingEntity entity, int timeLeft)
FeatureFlagSet	requiredFeatures()
boolean	shouldPrintOpWarning(ItemStack stack, Player player)
String	toString()
InteractionResult	use(Level level, Player player, InteractionHand hand)
InteractionResult	useOn(UseOnContext context)	Called when this item is used when targeting a Block
boolean	useOnRelease(ItemStack stack)	If this stack's item is a crossbow
void	verifyComponentsAfterLoad(ItemStack stack)

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.minecraft.world.flag.FeatureElement

isEnabled

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

applyEnchantments, canBeHurtBy, canContinueUsing, canEquip, canGrindstoneRepair, canPerformAction, canWalkOnPowderedSnow, createEntity, damageItem, doesSneakBypassUse, getAllEnchantments, getBurnTime, getCraftingRemainder, getCreatorModId, getDamage, getDefaultAttributeModifiers, getEnchantmentLevel, getEntityLifespan, getEquipmentSlot, getHighlightTip, getMaxDamage, getMaxStackSize, getSweepHitBox, getXpRepairRatio, hasCustomEntity, isDamageable, isDamaged, isGazeDisguise, isNotReplaceableByPickAction, isPiglinCurrency, isPrimaryItemFor, makesPiglinsNeutral, onAnimalArmorTick, onDestroyed, onDroppedByPlayer, onEntityItemUpdate, onEntitySwing, onItemUseFirst, onLeftClickEntity, onStopUsing, setDamage, shouldCauseBlockBreakReset, shouldCauseReequipAnimation, supportsEnchantment

Field Details

CODEC

public static final com.mojang.serialization.Codec<Holder<Item>> CODEC

STREAM_CODEC

public static final StreamCodec<RegistryFriendlyByteBuf,Holder<Item>> STREAM_CODEC

LOGGER

private static final org.slf4j.Logger LOGGER

BY_BLOCK

public static final Map<Block,Item> BY_BLOCK

BASE_ATTACK_DAMAGE_ID

public static final ResourceLocation BASE_ATTACK_DAMAGE_ID

BASE_ATTACK_SPEED_ID

public static final ResourceLocation BASE_ATTACK_SPEED_ID

DEFAULT_MAX_STACK_SIZE

public static final int DEFAULT_MAX_STACK_SIZE

See Also:

• Constant Field Values

ABSOLUTE_MAX_STACK_SIZE

public static final int ABSOLUTE_MAX_STACK_SIZE

See Also:

• Constant Field Values

MAX_BAR_WIDTH

public static final int MAX_BAR_WIDTH

See Also:

• Constant Field Values

APPROXIMATELY_INFINITE_USE_DURATION

protected static final int APPROXIMATELY_INFINITE_USE_DURATION

See Also:

• Constant Field Values

builtInRegistryHolder

private final Holder.Reference<Item> builtInRegistryHolder

components

private DataComponentMap components

craftingRemainingItem

@Nullable
private final Item craftingRemainingItem

descriptionId

protected final String descriptionId

requiredFeatures

private final FeatureFlagSet requiredFeatures

canCombineRepair

protected final boolean canCombineRepair

Constructor Details

Item

public Item(Item.Properties properties)

Method Details

getId

public static int getId(Item item)

byId

public static Item byId(int id)

byBlock

@Deprecated
public static Item byBlock(Block block)

Deprecated.

builtInRegistryHolder

@Deprecated
public Holder.Reference<Item> builtInRegistryHolder()

Deprecated.

components

public DataComponentMap components()

modifyDefaultComponentsFrom

@Internal
@Deprecated
public void modifyDefaultComponentsFrom(DataComponentPatch patch)

Deprecated.

Neo: do not use, use the event instead

getDefaultMaxStackSize

public int getDefaultMaxStackSize()

onUseTick

public void onUseTick(Level level,
 LivingEntity livingEntity,
 ItemStack stack,
 int remainingUseDuration)

Called as the item is being used by an entity.

onDestroyed

@Deprecated
public void onDestroyed(ItemEntity itemEntity)

Deprecated.

Forge: (ItemEntity, DamageSource) Use damage source sensitive version

verifyComponentsAfterLoad

public void verifyComponentsAfterLoad(ItemStack stack)

canDestroyBlock

public boolean canDestroyBlock(ItemStack stack,
 BlockState state,
 Level level,
 BlockPos pos,
 LivingEntity entity)

asItem

public Item asItem()

Specified by:

asItem in interface ItemLike

useOn

public InteractionResult useOn(UseOnContext context)

Called when this item is used when targeting a Block

getDestroySpeed

public float getDestroySpeed(ItemStack stack,
 BlockState state)

use

public InteractionResult use(Level level,
 Player player,
 InteractionHand hand)

finishUsingItem

public ItemStack finishUsingItem(ItemStack stack,
 Level level,
 LivingEntity livingEntity)

Called when the player finishes using this Item (E.g. finishes eating.). Not called when the player stops using the Item before the action is complete.

isBarVisible

public boolean isBarVisible(ItemStack stack)

getBarWidth

public int getBarWidth(ItemStack stack)

getBarColor

public int getBarColor(ItemStack stack)

overrideStackedOnOther

public boolean overrideStackedOnOther(ItemStack stack,
 Slot slot,
 ClickAction action,
 Player player)

overrideOtherStackedOnMe

public boolean overrideOtherStackedOnMe(ItemStack stack,
 ItemStack other,
 Slot slot,
 ClickAction action,
 Player player,
 SlotAccess access)

getAttackDamageBonus

public float getAttackDamageBonus(Entity target,
 float damage,
 DamageSource damageSource)

getDamageSource

@Nullable
public DamageSource getDamageSource(LivingEntity entity)

hurtEnemy

public void hurtEnemy(ItemStack stack,
 LivingEntity target,
 LivingEntity attacker)

postHurtEnemy

public void postHurtEnemy(ItemStack stack,
 LivingEntity target,
 LivingEntity attacker)

mineBlock

public boolean mineBlock(ItemStack stack,
 Level level,
 BlockState state,
 BlockPos pos,
 LivingEntity miningEntity)

Called when a Block is destroyed using this Item. Return true to trigger the "Use Item" statistic.

isCorrectToolForDrops

public boolean isCorrectToolForDrops(ItemStack stack,
 BlockState state)

interactLivingEntity

public InteractionResult interactLivingEntity(ItemStack stack,
 Player player,
 LivingEntity interactionTarget,
 InteractionHand usedHand)

Try interacting with given entity. Return InteractionResult.PASS if nothing should happen.

toString

public String toString()

Overrides:

toString in class Object

getCraftingRemainder

@Deprecated
public final ItemStack getCraftingRemainder()

Deprecated.

inventoryTick

public void inventoryTick(ItemStack stack,
 ServerLevel level,
 Entity entity,
 @Nullable
 EquipmentSlot slot)

onCraftedBy

public void onCraftedBy(ItemStack stack,
 Player player)

onCraftedPostProcess

public void onCraftedPostProcess(ItemStack stack,
 Level level)

getUseAnimation

public ItemUseAnimation getUseAnimation(ItemStack stack)

getUseDuration

public int getUseDuration(ItemStack stack,
 LivingEntity entity)

releaseUsing

public boolean releaseUsing(ItemStack stack,
 Level level,
 LivingEntity entity,
 int timeLeft)

appendHoverText

@Deprecated
public void appendHoverText(ItemStack stack,
 Item.TooltipContext context,
 TooltipDisplay tooltipDisplay,
 Consumer<Component> tooltipAdder,
 TooltipFlag flag)

Deprecated.

getTooltipImage

public Optional<TooltipComponent> getTooltipImage(ItemStack stack)

getDescriptionId

public final String getDescriptionId()

getName

public final Component getName()

getName

public Component getName(ItemStack stack)

isFoil

public boolean isFoil(ItemStack stack)

Returns true if this item has an enchantment glint. By default, this returns stack.isEnchanted(), but other items can override it (for instance, written books always return true). Note that if you override this method, you generally want to also call the super version (on Item) to get the glint for enchanted items. Of course, that is unnecessary if the overwritten version always returns true.

getPlayerPOVHitResult

public static BlockHitResult getPlayerPOVHitResult(Level level,
 Player player,
 ClipContext.Fluid fluidMode)

useOnRelease

public boolean useOnRelease(ItemStack stack)

If this stack's item is a crossbow

isCombineRepairable

public boolean isCombineRepairable(ItemStack stack)

Description copied from interface: IItemExtension

Determines if an item is repairable by combining, used by Repair recipes and Grindstone.

Specified by:

isCombineRepairable in interface IItemExtension

Returns:

True if repairable by combining

getDefaultInstance

public ItemStack getDefaultInstance()

canFitInsideContainerItems

public boolean canFitInsideContainerItems()

requiredFeatures

public FeatureFlagSet requiredFeatures()

Specified by:

requiredFeatures in interface FeatureElement

shouldPrintOpWarning

public boolean shouldPrintOpWarning(ItemStack stack,
 @Nullable
 Player player)