Package net.minecraft.world.item

Class ItemStack

java.lang.Object

net.minecraft.world.item.ItemStack

All Implemented Interfaces:

DataComponentHolder, IDataComponentHolderExtension, IItemStackExtension, MutableDataComponentHolder

public final class ItemStack
extends Object
implements DataComponentHolder, IItemStackExtension, MutableDataComponentHolder

Field Summary

Fields

Modifier and Type	Field	Description
static final com.mojang.serialization.Codec<ItemStack>	CODEC
(package private) final PatchedDataComponentMap	components
private int	count
private static final Component	DISABLED_ITEM_TOOLTIP
static final ItemStack	EMPTY
private Entity	entityRepresentation
private final Item	item	Deprecated.
static final com.mojang.serialization.Codec<Holder<Item>>	ITEM_NON_AIR_CODEC
static final StreamCodec<RegistryFriendlyByteBuf,List<ItemStack>>	LIST_STREAM_CODEC
private static final org.slf4j.Logger	LOGGER
static final com.mojang.serialization.Codec<ItemStack>	OPTIONAL_CODEC
static final StreamCodec<RegistryFriendlyByteBuf,List<ItemStack>>	OPTIONAL_LIST_STREAM_CODEC
static final StreamCodec<RegistryFriendlyByteBuf,ItemStack>	OPTIONAL_STREAM_CODEC
private int	popTime
static final com.mojang.serialization.Codec<ItemStack>	SIMPLE_ITEM_CODEC
static final com.mojang.serialization.Codec<ItemStack>	SINGLE_ITEM_CODEC
static final StreamCodec<RegistryFriendlyByteBuf,ItemStack>	STREAM_CODEC
static final com.mojang.serialization.Codec<ItemStack>	STRICT_CODEC
static final com.mojang.serialization.Codec<ItemStack>	STRICT_SINGLE_ITEM_CODEC

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ItemStack(Void p_282703_)
	ItemStack(Holder<Item> p_204116_)
	ItemStack(Holder<Item> p_220155_, int p_220156_)
	ItemStack(Holder<Item> p_312081_, int p_41605_, DataComponentPatch p_330362_)
	ItemStack(ItemLike p_41599_)
	ItemStack(ItemLike p_41601_, int p_41602_)
private	ItemStack(ItemLike p_330978_, int p_330639_, PatchedDataComponentMap p_330546_)

Method Summary

Modifier and Type	Method	Description
private void	addAttributeTooltips(Consumer<Component> p_330796_, Player p_330530_)
private void	addModifierTooltip(Consumer<Component> p_331062_, Player p_330317_, Holder<Attribute> p_330626_, AttributeModifier p_331252_)
<T extends TooltipProvider> void	addToTooltip(DataComponentType<T> p_331344_, Item.TooltipContext p_341231_, Consumer<Component> p_331885_, TooltipFlag p_331177_)
void	applyComponents(DataComponentMap p_330402_)	Applies a set of component changes to this stack.
void	applyComponents(DataComponentPatch p_332097_)	Applies a set of component changes to this stack.
void	applyComponentsAndValidate(DataComponentPatch p_341407_)
boolean	canBeHurtBy(DamageSource p_335431_)
boolean	canBreakBlockInAdventureMode(BlockInWorld p_331592_)
boolean	canPlaceOnBlockInAdventureMode(BlockInWorld p_331419_)
void	consume(int p_326311_, LivingEntity p_326200_)
ItemStack	copy()
ItemStack	copyAndClear()
ItemStack	copyWithCount(int p_256354_)
void	enchant(Enchantment p_41664_, int p_41665_)
ItemStack	finishUsingItem(Level p_41672_, LivingEntity p_41673_)
void	forEachModifier(EquipmentSlot p_332001_, BiConsumer<Holder<Attribute>,AttributeModifier> p_330882_)
int	getBarColor()
int	getBarWidth()
SoundEvent	getBreakingSound()
DataComponentMap	getComponents()
DataComponentPatch	getComponentsPatch()
int	getCount()
int	getDamageValue()
String	getDescriptionId()
float	getDestroySpeed(BlockState p_41692_)
Component	getDisplayName()
SoundEvent	getDrinkingSound()
SoundEvent	getEatingSound()
ItemEnchantments	getEnchantments()
Entity	getEntityRepresentation()
ItemFrame	getFrame()
Component	getHoverName()
Item	getItem()
Holder<Item>	getItemHolder()
int	getMaxDamage()
int	getMaxStackSize()
int	getPopTime()
DataComponentMap	getPrototype()
Rarity	getRarity()
Stream<TagKey<Item>>	getTags()
Optional<TooltipComponent>	getTooltipImage()
List<Component>	getTooltipLines(Item.TooltipContext p_339637_, Player p_41652_, TooltipFlag p_41653_)
UseAnim	getUseAnimation()
int	getUseDuration()
void	grow(int p_41770_)
boolean	hasFoil()
static int	hashItemAndComponents(ItemStack p_331961_)
static int	hashStackList(List<ItemStack> p_332135_)	Deprecated.
void	hurtAndBreak(int p_220158_, RandomSource p_220159_, ServerPlayer p_220160_, Runnable p_320659_)
void	hurtAndBreak(int p_220158_, RandomSource p_220159_, LivingEntity p_220160_, Runnable p_320659_)
void	hurtAndBreak(int p_41623_, LivingEntity p_41624_, EquipmentSlot p_319898_)
void	hurtEnemy(LivingEntity p_41641_, Player p_41642_)
InteractionResult	interactLivingEntity(Player p_41648_, LivingEntity p_41649_, InteractionHand p_41650_)
void	inventoryTick(Level p_41667_, Entity p_41668_, int p_41669_, boolean p_41670_)
boolean	is(Predicate<Holder<Item>> p_220168_)
boolean	is(Holder<Item> p_220166_)
boolean	is(HolderSet<Item> p_298683_)
boolean	is(TagKey<Item> p_204118_)
boolean	is(Item p_150931_)
boolean	isBarVisible()
boolean	isComponentsPatchEmpty()
boolean	isCorrectToolForDrops(BlockState p_41736_)
boolean	isDamageableItem()
boolean	isDamaged()
boolean	isEmpty()
boolean	isEnchantable()
boolean	isEnchanted()
boolean	isFramed()
boolean	isItemEnabled(FeatureFlagSet p_250869_)
static boolean	isSameItem(ItemStack p_287761_, ItemStack p_287676_)
static boolean	isSameItemSameComponents(ItemStack p_150943_, ItemStack p_150944_)
boolean	isStackable()
static com.mojang.serialization.MapCodec<ItemStack>	lenientOptionalFieldOf(String p_338501_)
void	limitSize(int p_335437_)
static boolean	listMatches(List<ItemStack> p_331725_, List<ItemStack> p_331113_)	Deprecated.
static boolean	matches(ItemStack p_41729_, ItemStack p_41730_)
void	mineBlock(Level p_41687_, BlockState p_41688_, BlockPos p_41689_, Player p_41690_)
void	onCraftedBy(Level p_41679_, Player p_41680_, int p_41681_)
void	onCraftedBySystem(Level p_307669_)
void	onDestroyed(ItemEntity p_150925_)	Deprecated. Forge: Use damage source sensitive version
private InteractionResult	onItemUse(UseOnContext p_41662_, Function<UseOnContext,InteractionResult> callback)
InteractionResult	onItemUseFirst(UseOnContext p_41662_)
void	onUseTick(Level p_41732_, LivingEntity p_41733_, int p_41734_)
boolean	overrideOtherStackedOnMe(ItemStack p_150933_, Slot p_150934_, ClickAction p_150935_, Player p_150936_, SlotAccess p_150937_)
boolean	overrideStackedOnOther(Slot p_150927_, ClickAction p_150928_, Player p_150929_)
static Optional<ItemStack>	parse(HolderLookup.Provider p_331096_, Tag p_330238_)
static ItemStack	parseOptional(HolderLookup.Provider p_330543_, CompoundTag p_330539_)
void	releaseUsing(Level p_41675_, LivingEntity p_41676_, int p_41677_)
<T> T	remove(DataComponentType<? extends T> p_332139_)	Removes a data component.
Tag	save(HolderLookup.Provider p_332160_)
Tag	save(HolderLookup.Provider p_331900_, Tag p_330830_)
Tag	saveOptional(HolderLookup.Provider p_330895_)
<T> T	set(DataComponentType<? super T> p_331064_, T p_330775_)	Sets a data component.
void	setCount(int p_41765_)
void	setDamageValue(int p_41722_)
void	setEntityRepresentation(Entity p_41637_)
void	setPopTime(int p_41755_)
void	shrink(int p_41775_)
ItemStack	split(int p_41621_)
String	toString()
ItemStack	transmuteCopy(ItemLike p_323864_, int p_323647_)
ItemStack	transmuteCopyIgnoreEmpty(ItemLike p_323811_, int p_323856_)
<T> T	update(DataComponentType<T> p_330921_, T p_331257_, UnaryOperator<T> p_331701_)	Updates a data component if it exists.
<T, U> T	update(DataComponentType<T> p_331083_, T p_331443_, U p_331049_, BiFunction<T,U,T> p_331846_)	Updates a data component if it exists, using an additional updateContext.
InteractionResultHolder<ItemStack>	use(Level p_41683_, Player p_41684_, InteractionHand p_41685_)
InteractionResult	useOn(UseOnContext p_41662_)
boolean	useOnRelease()
static com.mojang.serialization.DataResult<Unit>	validateComponents(DataComponentMap p_341201_)
static StreamCodec<RegistryFriendlyByteBuf,ItemStack>	validatedStreamCodec(StreamCodec<RegistryFriendlyByteBuf,ItemStack> p_340962_)
private static com.mojang.serialization.DataResult<ItemStack>	validateStrict(ItemStack p_340966_)

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.minecraft.core.component.DataComponentHolder

get, getOrDefault, has

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

addToTooltip, get, getOrDefault, has

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

canApplyAtEnchantingTable, canDisableShield, canElytraFly, canEquip, canGrindstoneRepair, canPerformAction, canWalkOnPowderedSnow, doesSneakBypassUse, elytraFlightTick, getAllEnchantments, getAttributeModifiers, getBurnTime, getCapability, getCapability, getCraftingRemainingItem, getEnchantmentLevel, getEnchantmentValue, getEntityLifespan, getEquipmentSlot, getFoodProperties, getHighlightTip, getSweepHitBox, getXpRepairRatio, hasCraftingRemainingItem, isBookEnchantable, isEnderMask, isNotReplaceableByPickAction, isPiglinCurrency, isRepairable, makesPiglinsNeutral, onAnimalArmorTick, onArmorTick, onDestroyed, onDroppedByPlayer, onEntityItemUpdate, onEntitySwing, onStopUsing, shouldCauseBlockBreakReset

Methods inherited from interface net.neoforged.neoforge.common.MutableDataComponentHolder

copyFrom, copyFrom, remove, set, update, update

Field Details

ITEM_NON_AIR_CODEC

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

CODEC

public static final com.mojang.serialization.Codec<ItemStack> CODEC

SINGLE_ITEM_CODEC

public static final com.mojang.serialization.Codec<ItemStack> SINGLE_ITEM_CODEC

STRICT_CODEC

public static final com.mojang.serialization.Codec<ItemStack> STRICT_CODEC

STRICT_SINGLE_ITEM_CODEC

public static final com.mojang.serialization.Codec<ItemStack> STRICT_SINGLE_ITEM_CODEC

OPTIONAL_CODEC

public static final com.mojang.serialization.Codec<ItemStack> OPTIONAL_CODEC

SIMPLE_ITEM_CODEC

public static final com.mojang.serialization.Codec<ItemStack> SIMPLE_ITEM_CODEC

OPTIONAL_STREAM_CODEC

public static final StreamCodec<RegistryFriendlyByteBuf,ItemStack> OPTIONAL_STREAM_CODEC

STREAM_CODEC

public static final StreamCodec<RegistryFriendlyByteBuf,ItemStack> STREAM_CODEC

OPTIONAL_LIST_STREAM_CODEC

public static final StreamCodec<RegistryFriendlyByteBuf,List<ItemStack>> OPTIONAL_LIST_STREAM_CODEC

LIST_STREAM_CODEC

public static final StreamCodec<RegistryFriendlyByteBuf,List<ItemStack>> LIST_STREAM_CODEC

LOGGER

private static final org.slf4j.Logger LOGGER

EMPTY

public static final ItemStack EMPTY

DISABLED_ITEM_TOOLTIP

private static final Component DISABLED_ITEM_TOOLTIP

count

private int count

popTime

private int popTime

item

@Deprecated
@Nullable
private final Item item

Deprecated.

components

final PatchedDataComponentMap components

entityRepresentation

@Nullable
private Entity entityRepresentation

Constructor Details

ItemStack

public ItemStack(ItemLike p_41599_)

ItemStack

public ItemStack(Holder<Item> p_204116_)

ItemStack

public ItemStack(Holder<Item> p_312081_,
 int p_41605_,
 DataComponentPatch p_330362_)

ItemStack

public ItemStack(Holder<Item> p_220155_,
 int p_220156_)

ItemStack

public ItemStack(ItemLike p_41601_,
 int p_41602_)

ItemStack

private ItemStack(ItemLike p_330978_,
 int p_330639_,
 PatchedDataComponentMap p_330546_)

ItemStack

private ItemStack(@Nullable
 Void p_282703_)

Method Details

validateStrict

private static com.mojang.serialization.DataResult<ItemStack> validateStrict(ItemStack p_340966_)

validatedStreamCodec

public static StreamCodec<RegistryFriendlyByteBuf,ItemStack> validatedStreamCodec(StreamCodec<RegistryFriendlyByteBuf,ItemStack> p_340962_)

getTooltipImage

public Optional<TooltipComponent> getTooltipImage()

getComponents

public DataComponentMap getComponents()

Specified by:

getComponents in interface DataComponentHolder

getPrototype

public DataComponentMap getPrototype()

getComponentsPatch

public DataComponentPatch getComponentsPatch()

isComponentsPatchEmpty

public boolean isComponentsPatchEmpty()

validateComponents

public static com.mojang.serialization.DataResult<Unit> validateComponents(DataComponentMap p_341201_)

parse

public static Optional<ItemStack> parse(HolderLookup.Provider p_331096_,
 Tag p_330238_)

parseOptional

public static ItemStack parseOptional(HolderLookup.Provider p_330543_,
 CompoundTag p_330539_)

isEmpty

public boolean isEmpty()

isItemEnabled

public boolean isItemEnabled(FeatureFlagSet p_250869_)

split

public ItemStack split(int p_41621_)

copyAndClear

public ItemStack copyAndClear()

getItem

public Item getItem()

getItemHolder

public Holder<Item> getItemHolder()

is

public boolean is(TagKey<Item> p_204118_)

is

public boolean is(Item p_150931_)

is

public boolean is(Predicate<Holder<Item>> p_220168_)

is

public boolean is(Holder<Item> p_220166_)

is

public boolean is(HolderSet<Item> p_298683_)

getTags

public Stream<TagKey<Item>> getTags()

useOn

public InteractionResult useOn(UseOnContext p_41662_)

onItemUseFirst

public InteractionResult onItemUseFirst(UseOnContext p_41662_)

Specified by:

onItemUseFirst in interface IItemStackExtension

onItemUse

private InteractionResult onItemUse(UseOnContext p_41662_,
 Function<UseOnContext,InteractionResult> callback)

getDestroySpeed

public float getDestroySpeed(BlockState p_41692_)

use

public InteractionResultHolder<ItemStack> use(Level p_41683_,
 Player p_41684_,
 InteractionHand p_41685_)

finishUsingItem

public ItemStack finishUsingItem(Level p_41672_,
 LivingEntity p_41673_)

save

public Tag save(HolderLookup.Provider p_331900_,
 Tag p_330830_)

save

public Tag save(HolderLookup.Provider p_332160_)

saveOptional

public Tag saveOptional(HolderLookup.Provider p_330895_)

getMaxStackSize

public int getMaxStackSize()

isStackable

public boolean isStackable()

isDamageableItem

public boolean isDamageableItem()

isDamaged

public boolean isDamaged()

getDamageValue

public int getDamageValue()

setDamageValue

public void setDamageValue(int p_41722_)

getMaxDamage

public int getMaxDamage()

hurtAndBreak

public void hurtAndBreak(int p_220158_,
 RandomSource p_220159_,
 @Nullable
 ServerPlayer p_220160_,
 Runnable p_320659_)

hurtAndBreak

public void hurtAndBreak(int p_220158_,
 RandomSource p_220159_,
 @Nullable
 LivingEntity p_220160_,
 Runnable p_320659_)

hurtAndBreak

public void hurtAndBreak(int p_41623_,
 LivingEntity p_41624_,
 EquipmentSlot p_319898_)

isBarVisible

public boolean isBarVisible()

getBarWidth

public int getBarWidth()

getBarColor

public int getBarColor()

overrideStackedOnOther

public boolean overrideStackedOnOther(Slot p_150927_,
 ClickAction p_150928_,
 Player p_150929_)

overrideOtherStackedOnMe

public boolean overrideOtherStackedOnMe(ItemStack p_150933_,
 Slot p_150934_,
 ClickAction p_150935_,
 Player p_150936_,
 SlotAccess p_150937_)

hurtEnemy

public void hurtEnemy(LivingEntity p_41641_,
 Player p_41642_)

mineBlock

public void mineBlock(Level p_41687_,
 BlockState p_41688_,
 BlockPos p_41689_,
 Player p_41690_)

isCorrectToolForDrops

public boolean isCorrectToolForDrops(BlockState p_41736_)

interactLivingEntity

public InteractionResult interactLivingEntity(Player p_41648_,
 LivingEntity p_41649_,
 InteractionHand p_41650_)

copy

public ItemStack copy()

copyWithCount

public ItemStack copyWithCount(int p_256354_)

transmuteCopy

public ItemStack transmuteCopy(ItemLike p_323864_,
 int p_323647_)

transmuteCopyIgnoreEmpty

public ItemStack transmuteCopyIgnoreEmpty(ItemLike p_323811_,
 int p_323856_)

matches

public static boolean matches(ItemStack p_41729_,
 ItemStack p_41730_)

listMatches

@Deprecated
public static boolean listMatches(List<ItemStack> p_331725_,
 List<ItemStack> p_331113_)

Deprecated.

isSameItem

public static boolean isSameItem(ItemStack p_287761_,
 ItemStack p_287676_)

isSameItemSameComponents

public static boolean isSameItemSameComponents(ItemStack p_150943_,
 ItemStack p_150944_)

lenientOptionalFieldOf

public static com.mojang.serialization.MapCodec<ItemStack> lenientOptionalFieldOf(String p_338501_)

hashItemAndComponents

public static int hashItemAndComponents(@Nullable
 ItemStack p_331961_)

hashStackList

@Deprecated
public static int hashStackList(List<ItemStack> p_332135_)

Deprecated.

getDescriptionId

public String getDescriptionId()

toString

public String toString()

Overrides:

toString in class Object

inventoryTick

public void inventoryTick(Level p_41667_,
 Entity p_41668_,
 int p_41669_,
 boolean p_41670_)

onCraftedBy

public void onCraftedBy(Level p_41679_,
 Player p_41680_,
 int p_41681_)

onCraftedBySystem

public void onCraftedBySystem(Level p_307669_)

getUseDuration

public int getUseDuration()

getUseAnimation

public UseAnim getUseAnimation()

releaseUsing

public void releaseUsing(Level p_41675_,
 LivingEntity p_41676_,
 int p_41677_)

useOnRelease

public boolean useOnRelease()

set

@Nullable
public <T> T set(DataComponentType<? super T> p_331064_,
 @Nullable
 T p_330775_)

Description copied from interface: MutableDataComponentHolder

Sets a data component.

Specified by:

set in interface MutableDataComponentHolder

update

@Nullable
public <T,
U> T update(DataComponentType<T> p_331083_,
 T p_331443_,
 U p_331049_,
 BiFunction<T,U,T> p_331846_)

Description copied from interface: MutableDataComponentHolder

Updates a data component if it exists, using an additional updateContext.

Specified by:

update in interface MutableDataComponentHolder

update

@Nullable
public <T> T update(DataComponentType<T> p_330921_,
 T p_331257_,
 UnaryOperator<T> p_331701_)

Description copied from interface: MutableDataComponentHolder

Updates a data component if it exists.

Specified by:

update in interface MutableDataComponentHolder

remove

@Nullable
public <T> T remove(DataComponentType<? extends T> p_332139_)

Description copied from interface: MutableDataComponentHolder

Removes a data component.

Specified by:

remove in interface MutableDataComponentHolder

applyComponentsAndValidate

public void applyComponentsAndValidate(DataComponentPatch p_341407_)

applyComponents

public void applyComponents(DataComponentPatch p_332097_)

Description copied from interface: MutableDataComponentHolder

Applies a set of component changes to this stack.

Specified by:

applyComponents in interface MutableDataComponentHolder

applyComponents

public void applyComponents(DataComponentMap p_330402_)

Description copied from interface: MutableDataComponentHolder

Applies a set of component changes to this stack.

Specified by:

applyComponents in interface MutableDataComponentHolder

getHoverName

public Component getHoverName()

addToTooltip

public <T extends TooltipProvider> void addToTooltip(DataComponentType<T> p_331344_,
 Item.TooltipContext p_341231_,
 Consumer<Component> p_331885_,
 TooltipFlag p_331177_)

Specified by:

addToTooltip in interface IDataComponentHolderExtension

getTooltipLines

public List<Component> getTooltipLines(Item.TooltipContext p_339637_,
 @Nullable
 Player p_41652_,
 TooltipFlag p_41653_)

addAttributeTooltips

private void addAttributeTooltips(Consumer<Component> p_330796_,
 @Nullable
 Player p_330530_)

addModifierTooltip

private void addModifierTooltip(Consumer<Component> p_331062_,
 @Nullable
 Player p_330317_,
 Holder<Attribute> p_330626_,
 AttributeModifier p_331252_)

hasFoil

public boolean hasFoil()

getRarity

public Rarity getRarity()

isEnchantable

public boolean isEnchantable()

enchant

public void enchant(Enchantment p_41664_,
 int p_41665_)

isEnchanted

public boolean isEnchanted()

getEnchantments

public ItemEnchantments getEnchantments()

isFramed

public boolean isFramed()

setEntityRepresentation

public void setEntityRepresentation(@Nullable
 Entity p_41637_)

getFrame

@Nullable
public ItemFrame getFrame()

getEntityRepresentation

@Nullable
public Entity getEntityRepresentation()

forEachModifier

public void forEachModifier(EquipmentSlot p_332001_,
 BiConsumer<Holder<Attribute>,AttributeModifier> p_330882_)

getDisplayName

public Component getDisplayName()

canPlaceOnBlockInAdventureMode

public boolean canPlaceOnBlockInAdventureMode(BlockInWorld p_331419_)

canBreakBlockInAdventureMode

public boolean canBreakBlockInAdventureMode(BlockInWorld p_331592_)

getPopTime

public int getPopTime()

setPopTime

public void setPopTime(int p_41755_)

getCount

public int getCount()

setCount

public void setCount(int p_41765_)

limitSize

public void limitSize(int p_335437_)

grow

public void grow(int p_41770_)

shrink

public void shrink(int p_41775_)

consume

public void consume(int p_326311_,
 @Nullable
 LivingEntity p_326200_)

onUseTick

public void onUseTick(Level p_41732_,
 LivingEntity p_41733_,
 int p_41734_)

onDestroyed

@Deprecated
public void onDestroyed(ItemEntity p_150925_)

Deprecated.

Forge: Use damage source sensitive version

getDrinkingSound

public SoundEvent getDrinkingSound()

getEatingSound

public SoundEvent getEatingSound()

getBreakingSound

public SoundEvent getBreakingSound()

canBeHurtBy

public boolean canBeHurtBy(DamageSource p_335431_)