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 ItemLike, FeatureElement, 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 Identifier	BASE_ATTACK_DAMAGE_ID
static final Identifier	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
static final com.mojang.serialization.Codec<Holder<Item>>	CODEC_WITH_BOUND_COMPONENTS
private final @Nullable ItemStackTemplate	craftingRemainingItem
static final int	DEFAULT_MAX_STACK_SIZE
private @Nullable ItemResource	defaultResource
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 FeatureElement

FILTERED_REGISTRIES

Constructor Summary

Constructors

Constructor	Description
Item(Item.Properties properties)

Method Summary

Modifier and Type	Method	Description
void	appendHoverText(ItemStack itemStack, Item.TooltipContext context, TooltipDisplay display, Consumer<Component> builder, TooltipFlag tooltipFlag)	Deprecated.
Item	asItem()
Holder.Reference<Item>	builtInRegistryHolder()	Deprecated.
static Item	byBlock(Block block)	Deprecated.
static Item	byId(int id)
boolean	canDestroyBlock(ItemStack itemStack, BlockState state, Level level, BlockPos pos, LivingEntity user)
boolean	canFitInsideContainerItems()	Deprecated. Neo: call IItemStackExtension.canFitInsideContainerItems() instead, prefer overriding IItemExtension.canFitInsideContainerItems(ItemStack)
DataComponentMap	components()
ItemResource	computeDefaultResource(Function<Item, ItemResource> resourceConstructor)	Deprecated. Neo: do not use, use ItemResource.of(ItemStack) instead.
ItemStack	finishUsingItem(ItemStack itemStack, Level level, LivingEntity entity)	Called when the player finishes using this Item (E.g. finishes eating.).
float	getAttackDamageBonus(Entity victim, float damage, DamageSource damageSource)
int	getBarColor(ItemStack stack)
int	getBarWidth(ItemStack stack)
final @Nullable ItemStackTemplate	getCraftingRemainder()	Deprecated. use IItemExtension.getCraftingRemainder(ItemStack) instead
ItemStack	getDefaultInstance()
int	getDefaultMaxStackSize()
final String	getDescriptionId()
float	getDestroySpeed(ItemStack itemStack, BlockState state)
static int	getId(Item item)
@Nullable DamageSource	getItemDamageSource(LivingEntity attacker)	Deprecated.
Component	getName(ItemStack itemStack)
static BlockHitResult	getPlayerPOVHitResult(Level level, Player player, ClipContext.Fluid fluid)
Optional<TooltipComponent>	getTooltipImage(ItemStack itemStack)
ItemUseAnimation	getUseAnimation(ItemStack itemStack)
int	getUseDuration(ItemStack itemStack, LivingEntity user)
void	hurtEnemy(ItemStack itemStack, LivingEntity mob, LivingEntity attacker)
InteractionResult	interactLivingEntity(ItemStack itemStack, Player player, LivingEntity target, InteractionHand type)	Try interacting with given entity.
void	inventoryTick(ItemStack itemStack, ServerLevel level, Entity owner, @Nullable 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 itemStack, BlockState state)
boolean	isFoil(ItemStack itemStack)	Returns true if this item has an enchantment glint.
boolean	mineBlock(ItemStack itemStack, Level level, BlockState state, BlockPos pos, LivingEntity owner)	Called when a Block is destroyed using this Item.
void	onCraftedBy(ItemStack itemStack, Player player)
void	onCraftedPostProcess(ItemStack itemStack, Level level)
void	onDestroyed(ItemEntity itemEntity)	Deprecated. Forge: Use damage source sensitive version
void	onUseTick(Level level, LivingEntity livingEntity, ItemStack itemStack, int ticksRemaining)	Called as the item is being used by an entity.
boolean	overrideOtherStackedOnMe(ItemStack self, ItemStack other, Slot slot, ClickAction clickAction, Player player, SlotAccess carriedItem)
boolean	overrideStackedOnOther(ItemStack self, Slot slot, ClickAction clickAction, Player player)
void	postHurtEnemy(ItemStack itemStack, LivingEntity mob, LivingEntity attacker)
boolean	releaseUsing(ItemStack itemStack, Level level, LivingEntity entity, int remainingTime)
FeatureFlagSet	requiredFeatures()
void	resetDefaultResource()	Deprecated. Neo: do not use, use ItemResource.of(ItemStack) instead.
boolean	shouldPrintOpWarning(ItemStack stack, @Nullable 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 itemStack)	If this stack's item is a crossbow

Methods inherited from class Object

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

Methods inherited from interface FeatureElement

isEnabled

Methods inherited from interface IItemExtension

applyEnchantments, canBeHurtBy, canContinueUsing, canEquip, canFitInsideContainerItems, 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

CODEC_WITH_BOUND_COMPONENTS

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

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 Identifier BASE_ATTACK_DAMAGE_ID

BASE_ATTACK_SPEED_ID

public static final Identifier 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

craftingRemainingItem

private final @Nullable ItemStackTemplate craftingRemainingItem

descriptionId

protected final String descriptionId

requiredFeatures

private final FeatureFlagSet requiredFeatures

defaultResource

private @Nullable ItemResource defaultResource

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()

resetDefaultResource

@Internal
@Deprecated
public void resetDefaultResource()

Deprecated.

Neo: do not use, use ItemResource.of(ItemStack) instead.

computeDefaultResource

@Internal
@Deprecated
public ItemResource computeDefaultResource(Function<Item, ItemResource> resourceConstructor)

Deprecated.

Neo: do not use, use ItemResource.of(ItemStack) instead.

getDefaultMaxStackSize

public int getDefaultMaxStackSize()

onUseTick

public void onUseTick(Level level,
 LivingEntity livingEntity,
 ItemStack itemStack,
 int ticksRemaining)

Called as the item is being used by an entity.

onDestroyed

@Deprecated
public void onDestroyed(ItemEntity itemEntity)

Deprecated.

Forge: Use damage source sensitive version

canDestroyBlock

public boolean canDestroyBlock(ItemStack itemStack,
 BlockState state,
 Level level,
 BlockPos pos,
 LivingEntity user)

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 itemStack,
 BlockState state)

use

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

finishUsingItem

public ItemStack finishUsingItem(ItemStack itemStack,
 Level level,
 LivingEntity entity)

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 self,
 Slot slot,
 ClickAction clickAction,
 Player player)

overrideOtherStackedOnMe

public boolean overrideOtherStackedOnMe(ItemStack self,
 ItemStack other,
 Slot slot,
 ClickAction clickAction,
 Player player,
 SlotAccess carriedItem)

getAttackDamageBonus

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

getItemDamageSource

@Deprecated
public @Nullable DamageSource getItemDamageSource(LivingEntity attacker)

Deprecated.

hurtEnemy

public void hurtEnemy(ItemStack itemStack,
 LivingEntity mob,
 LivingEntity attacker)

postHurtEnemy

public void postHurtEnemy(ItemStack itemStack,
 LivingEntity mob,
 LivingEntity attacker)

mineBlock

public boolean mineBlock(ItemStack itemStack,
 Level level,
 BlockState state,
 BlockPos pos,
 LivingEntity owner)

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

isCorrectToolForDrops

public boolean isCorrectToolForDrops(ItemStack itemStack,
 BlockState state)

interactLivingEntity

public InteractionResult interactLivingEntity(ItemStack itemStack,
 Player player,
 LivingEntity target,
 InteractionHand type)

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 @Nullable ItemStackTemplate getCraftingRemainder()

Deprecated.

use IItemExtension.getCraftingRemainder(ItemStack) instead

inventoryTick

public void inventoryTick(ItemStack itemStack,
 ServerLevel level,
 Entity owner,
 @Nullable EquipmentSlot slot)

onCraftedBy

public void onCraftedBy(ItemStack itemStack,
 Player player)

onCraftedPostProcess

public void onCraftedPostProcess(ItemStack itemStack,
 Level level)

getUseAnimation

public ItemUseAnimation getUseAnimation(ItemStack itemStack)

getUseDuration

public int getUseDuration(ItemStack itemStack,
 LivingEntity user)

releaseUsing

public boolean releaseUsing(ItemStack itemStack,
 Level level,
 LivingEntity entity,
 int remainingTime)

appendHoverText

@Deprecated
public void appendHoverText(ItemStack itemStack,
 Item.TooltipContext context,
 TooltipDisplay display,
 Consumer<Component> builder,
 TooltipFlag tooltipFlag)

Deprecated.

getTooltipImage

public Optional<TooltipComponent> getTooltipImage(ItemStack itemStack)

getDescriptionId

public final String getDescriptionId()

getName

public Component getName(ItemStack itemStack)

isFoil

public boolean isFoil(ItemStack itemStack)

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 fluid)

useOnRelease

public boolean useOnRelease(ItemStack itemStack)

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

@Deprecated
public boolean canFitInsideContainerItems()

Deprecated.

Neo: call IItemStackExtension.canFitInsideContainerItems() instead, prefer overriding IItemExtension.canFitInsideContainerItems(ItemStack)

requiredFeatures

public FeatureFlagSet requiredFeatures()

Specified by:

requiredFeatures in interface FeatureElement

shouldPrintOpWarning

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