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, MutableDataComponentHolder, IItemStackExtension
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final com.mojang.serialization.Codec
<ItemStack> (package private) final PatchedDataComponentMap
private int
private static final Component
static final ItemStack
private Entity
The entity the item is attached to, like an Item Frame.private final Item
Deprecated.static final StreamCodec
<RegistryFriendlyByteBuf, List<ItemStack>> private static final org.slf4j.Logger
static final com.mojang.serialization.Codec
<ItemStack> static final StreamCodec
<RegistryFriendlyByteBuf, List<ItemStack>> static final StreamCodec
<RegistryFriendlyByteBuf, ItemStack> private int
static final com.mojang.serialization.Codec
<ItemStack> static final com.mojang.serialization.Codec
<ItemStack> static final StreamCodec
<RegistryFriendlyByteBuf, ItemStack> static final com.mojang.serialization.Codec
<ItemStack> static final com.mojang.serialization.Codec
<ItemStack> -
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
ItemStack
(Holder<Item> pItem, int pCount, DataComponentPatch p_330362_) private
ItemStack
(ItemLike pItem, int pCount, PatchedDataComponentMap pComponents) -
Method Summary
Modifier and TypeMethodDescriptionprivate void
addAttributeTooltips
(Consumer<Component> pTooltipAdder, Player pPlayer) Deprecated.private void
addModifierTooltip
(Consumer<Component> pTooltipAdder, Player pPlayer, Holder<Attribute> pAttribute, AttributeModifier pModifier) <T extends TooltipProvider>
voidaddToTooltip
(DataComponentType<T> pComponent, Item.TooltipContext pContext, Consumer<Component> pTooltipAdder, TooltipFlag pTooltipFlag) void
applyComponents
(DataComponentMap pComponents) Applies a set of component changes to this stack.void
applyComponents
(DataComponentPatch pComponents) Applies a set of component changes to this stack.void
applyComponentsAndValidate
(DataComponentPatch pComponents) boolean
canBeHurtBy
(DamageSource pDamageSource) boolean
boolean
void
consume
(int pAmount, LivingEntity pEntity) consumeAndReturn
(int pAmount, LivingEntity pEntity) copy()
copyWithCount
(int pCount) void
enchant
(Holder<Enchantment> pEnchantment, int pLevel) finishUsingItem
(Level pLevel, LivingEntity pLivingEntity) Called when the item in use count reach 0, e.g. item food eaten.void
forEachModifier
(EquipmentSlotGroup pSlotGroup, BiConsumer<Holder<Attribute>, AttributeModifier> pAction) void
forEachModifier
(EquipmentSlot pEquipmentSLot, BiConsumer<Holder<Attribute>, AttributeModifier> pAction) int
int
int
getCount()
int
float
getDestroySpeed
(BlockState pState) Deprecated.Neo: UsegetTagEnchantments()
for NBT enchantments, orIItemStackExtension.getAllEnchantments(net.minecraft.core.HolderLookup.RegistryLookup<net.minecraft.world.item.enchantment.Enchantment>)
for gameplay.getFrame()
getItem()
int
int
int
Gets all enchantments from NBT.getTags()
getTooltipLines
(Item.TooltipContext pTooltipContext, Player pPlayer, TooltipFlag pTooltipFlag) int
getUseDuration
(LivingEntity pEntity) void
grow
(int pIncrement) boolean
hasFoil()
static int
hashItemAndComponents
(ItemStack pStack) static int
hashStackList
(List<ItemStack> pList) Deprecated.void
hurtAndBreak
(int pDamage, ServerLevel pLevel, ServerPlayer pPlayer, Consumer<Item> pOnBreak) void
hurtAndBreak
(int p_220158_, ServerLevel p_346256_, LivingEntity p_220160_, Consumer<Item> p_348596_) void
hurtAndBreak
(int pAmount, LivingEntity pEntity, EquipmentSlot pSlot) hurtAndConvertOnBreak
(int pAmount, ItemLike pItem, LivingEntity pEntity, EquipmentSlot pSlot) boolean
hurtEnemy
(LivingEntity pTarget, Player pAttacker) interactLivingEntity
(Player pPlayer, LivingEntity pEntity, InteractionHand pUsedHand) void
inventoryTick
(Level pLevel, Entity pEntity, int pInventorySlot, boolean pIsCurrentItem) Called each tick as long theItemStack
in in player's inventory.boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
isCorrectToolForDrops
(BlockState pState) Check whether the given Block can be harvested using this ItemStack.boolean
boolean
boolean
isEmpty()
boolean
boolean
boolean
isFramed()
boolean
isItemEnabled
(FeatureFlagSet pEnabledFlags) static boolean
isSameItem
(ItemStack pStack, ItemStack pOther) static boolean
isSameItemSameComponents
(ItemStack pStack, ItemStack pOther) boolean
static com.mojang.serialization.MapCodec
<ItemStack> lenientOptionalFieldOf
(String p_338501_) void
limitSize
(int pMaxSize) static boolean
listMatches
(List<ItemStack> pList, List<ItemStack> pOther) Deprecated.static boolean
Compares bothItemStacks
, returnstrue
if bothItemStacks
are equal.void
mineBlock
(Level pLevel, BlockState pState, BlockPos pPos, Player pPlayer) Called when a Block is destroyed using this ItemStackvoid
onCraftedBy
(Level pLevel, Player pPlayer, int pAmount) void
onCraftedBySystem
(Level pLevel) void
onDestroyed
(ItemEntity pItemEntity) Deprecated.Forge: Use invalid input: '{@linkplain net.neoforged.neoforge.common.extensions.IItemStackExtension#' onDestroyed(ItemEntity, net.minecraft.world.damagesource.DamageSource) damage source sensitive version}private InteractionResult
onItemUse
(UseOnContext p_41662_, Function<UseOnContext, InteractionResult> callback) onItemUseFirst
(UseOnContext p_41662_) void
onUseTick
(Level pLevel, LivingEntity pLivingEntity, int pCount) Called as the stack is being used by an entity.boolean
overrideOtherStackedOnMe
(ItemStack pStack, Slot pSlot, ClickAction pAction, Player pPlayer, SlotAccess pAccess) boolean
overrideStackedOnOther
(Slot pSlot, ClickAction pAction, Player pPlayer) parse
(HolderLookup.Provider pLookupProvider, Tag pTag) static ItemStack
parseOptional
(HolderLookup.Provider pLookupProvider, CompoundTag pTag) void
postHurtEnemy
(LivingEntity pTarget, Player pAttacker) void
releaseUsing
(Level pLevel, LivingEntity pLivingEntity, int pTimeLeft) Called when the player releases the use item button.<T> T
remove
(DataComponentType<? extends T> pComponent) Removes a data component.save
(HolderLookup.Provider pLevelRegistryAccess) save
(HolderLookup.Provider pLevelRegistryAccess, Tag pOutputTag) saveOptional
(HolderLookup.Provider pLevelRegistryAccess) <T> T
set
(DataComponentType<? super T> pComponent, T pValue) Sets a data component.void
setCount
(int pCount) void
setDamageValue
(int pDamage) void
setEntityRepresentation
(Entity pEntity) void
setPopTime
(int pPopTime) void
shrink
(int pDecrement) split
(int pAmount) Splits off a stack of the given amount of this stack and reduces this stack by the amount.toString()
transmuteCopy
(ItemLike pItem) transmuteCopy
(ItemLike pItem, int pCount) private ItemStack
transmuteCopyIgnoreEmpty
(ItemLike pItem, int pCount) <T> T
update
(DataComponentType<T> pComponent, T pDefaultValue, UnaryOperator<T> pUpdater) Updates a data component if it exists.<T,
U> T update
(DataComponentType<T> pComponent, T pDefaultValue, U pUpdateValue, BiFunction<T, U, T> pUpdater) Updates a data component if it exists, using an additionalupdateContext
.use
(Level pLevel, Player pPlayer, InteractionHand pUsedHand) Called when theItemStack
is equipped and right-clicked.useOn
(UseOnContext pContext) boolean
static com.mojang.serialization.DataResult
<Unit> validateComponents
(DataComponentMap p_341201_) 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
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, isPrimaryItemFor, isRepairable, makesPiglinsNeutral, onAnimalArmorTick, onDestroyed, onDroppedByPlayer, onEntityItemUpdate, onEntitySwing, onEntitySwing, onStopUsing, shouldCauseBlockBreakReset, supportsEnchantment
-
Field Details
-
ITEM_NON_AIR_CODEC
-
CODEC
-
SINGLE_ITEM_CODEC
-
STRICT_CODEC
-
STRICT_SINGLE_ITEM_CODEC
-
OPTIONAL_CODEC
-
SIMPLE_ITEM_CODEC
-
OPTIONAL_STREAM_CODEC
-
STREAM_CODEC
-
OPTIONAL_LIST_STREAM_CODEC
-
LIST_STREAM_CODEC
-
LOGGER
private static final org.slf4j.Logger LOGGER -
EMPTY
-
DISABLED_ITEM_TOOLTIP
-
count
private int count -
popTime
private int popTime -
item
Deprecated. -
components
-
entityRepresentation
The entity the item is attached to, like an Item Frame.
-
-
Constructor Details
-
ItemStack
-
ItemStack
-
ItemStack
-
ItemStack
-
ItemStack
-
ItemStack
-
ItemStack
-
-
Method Details
-
validateStrict
-
validatedStreamCodec
public static StreamCodec<RegistryFriendlyByteBuf,ItemStack> validatedStreamCodec(StreamCodec<RegistryFriendlyByteBuf, ItemStack> pCodec) -
getTooltipImage
-
getComponents
- Specified by:
getComponents
in interfaceDataComponentHolder
-
getPrototype
-
getComponentsPatch
-
isComponentsPatchEmpty
public boolean isComponentsPatchEmpty() -
validateComponents
public static com.mojang.serialization.DataResult<Unit> validateComponents(DataComponentMap p_341201_) -
parse
-
parseOptional
-
isEmpty
public boolean isEmpty() -
isItemEnabled
-
split
Splits off a stack of the given amount of this stack and reduces this stack by the amount. -
copyAndClear
-
getItem
-
getItemHolder
-
is
-
is
-
is
-
is
-
is
-
getTags
-
useOn
-
onItemUseFirst
- Specified by:
onItemUseFirst
in interfaceIItemStackExtension
-
onItemUse
private InteractionResult onItemUse(UseOnContext p_41662_, Function<UseOnContext, InteractionResult> callback) -
getDestroySpeed
-
use
public InteractionResultHolder<ItemStack> use(Level pLevel, Player pPlayer, InteractionHand pUsedHand) Called when theItemStack
is equipped and right-clicked. Replaces theItemStack
with the return value. -
finishUsingItem
Called when the item in use count reach 0, e.g. item food eaten. Return the new ItemStack. Args : world, entity -
save
-
save
-
saveOptional
-
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 pDamage) -
getMaxDamage
public int getMaxDamage() -
hurtAndBreak
public void hurtAndBreak(int pDamage, ServerLevel pLevel, @Nullable ServerPlayer pPlayer, Consumer<Item> pOnBreak) -
hurtAndBreak
public void hurtAndBreak(int p_220158_, ServerLevel p_346256_, @Nullable LivingEntity p_220160_, Consumer<Item> p_348596_) -
hurtAndBreak
-
hurtAndConvertOnBreak
public ItemStack hurtAndConvertOnBreak(int pAmount, ItemLike pItem, LivingEntity pEntity, EquipmentSlot pSlot) -
isBarVisible
public boolean isBarVisible() -
getBarWidth
public int getBarWidth() -
getBarColor
public int getBarColor() -
overrideStackedOnOther
-
overrideOtherStackedOnMe
public boolean overrideOtherStackedOnMe(ItemStack pStack, Slot pSlot, ClickAction pAction, Player pPlayer, SlotAccess pAccess) -
hurtEnemy
-
postHurtEnemy
-
mineBlock
Called when a Block is destroyed using this ItemStack -
isCorrectToolForDrops
Check whether the given Block can be harvested using this ItemStack. -
interactLivingEntity
public InteractionResult interactLivingEntity(Player pPlayer, LivingEntity pEntity, InteractionHand pUsedHand) -
copy
-
copyWithCount
-
transmuteCopy
-
transmuteCopy
-
transmuteCopyIgnoreEmpty
-
matches
Compares bothItemStacks
, returnstrue
if bothItemStacks
are equal. -
listMatches
Deprecated. -
isSameItem
-
isSameItemSameComponents
-
lenientOptionalFieldOf
-
hashItemAndComponents
-
hashStackList
Deprecated. -
getDescriptionId
-
toString
-
inventoryTick
Called each tick as long theItemStack
in in player's inventory. Used to progress the pickup animation and update maps. -
onCraftedBy
-
onCraftedBySystem
-
getUseDuration
-
getUseAnimation
-
releaseUsing
Called when the player releases the use item button. -
useOnRelease
public boolean useOnRelease() -
set
Description copied from interface:MutableDataComponentHolder
Sets a data component.- Specified by:
set
in interfaceMutableDataComponentHolder
-
update
@Nullable public <T,U> T update(DataComponentType<T> pComponent, T pDefaultValue, U pUpdateValue, BiFunction<T, U, T> pUpdater) Description copied from interface:MutableDataComponentHolder
Updates a data component if it exists, using an additionalupdateContext
.- Specified by:
update
in interfaceMutableDataComponentHolder
-
update
@Nullable public <T> T update(DataComponentType<T> pComponent, T pDefaultValue, UnaryOperator<T> pUpdater) Description copied from interface:MutableDataComponentHolder
Updates a data component if it exists.- Specified by:
update
in interfaceMutableDataComponentHolder
-
remove
Description copied from interface:MutableDataComponentHolder
Removes a data component.- Specified by:
remove
in interfaceMutableDataComponentHolder
-
applyComponentsAndValidate
-
applyComponents
Description copied from interface:MutableDataComponentHolder
Applies a set of component changes to this stack.- Specified by:
applyComponents
in interfaceMutableDataComponentHolder
-
applyComponents
Description copied from interface:MutableDataComponentHolder
Applies a set of component changes to this stack.- Specified by:
applyComponents
in interfaceMutableDataComponentHolder
-
getHoverName
-
addToTooltip
public <T extends TooltipProvider> void addToTooltip(DataComponentType<T> pComponent, Item.TooltipContext pContext, Consumer<Component> pTooltipAdder, TooltipFlag pTooltipFlag) - Specified by:
addToTooltip
in interfaceIDataComponentHolderExtension
-
getTooltipLines
public List<Component> getTooltipLines(Item.TooltipContext pTooltipContext, @Nullable Player pPlayer, TooltipFlag pTooltipFlag) -
addAttributeTooltips
@Deprecated private void addAttributeTooltips(Consumer<Component> pTooltipAdder, @Nullable Player pPlayer) Deprecated.Neo: Useinvalid @link
{@link net.neoforged.neoforge.client.util.TooltipUtil#
-
addModifierTooltip
-
hasFoil
public boolean hasFoil() -
getRarity
-
isEnchantable
public boolean isEnchantable() -
enchant
-
isEnchanted
public boolean isEnchanted() -
getTagEnchantments
Gets all enchantments from NBT. UseIItemStackExtension.getAllEnchantments(net.minecraft.core.HolderLookup.RegistryLookup<net.minecraft.world.item.enchantment.Enchantment>)
for gameplay logic. -
getEnchantments
Deprecated.Neo: UsegetTagEnchantments()
for NBT enchantments, orIItemStackExtension.getAllEnchantments(net.minecraft.core.HolderLookup.RegistryLookup<net.minecraft.world.item.enchantment.Enchantment>)
for gameplay. -
isFramed
public boolean isFramed() -
setEntityRepresentation
-
getFrame
-
getEntityRepresentation
-
forEachModifier
public void forEachModifier(EquipmentSlotGroup pSlotGroup, BiConsumer<Holder<Attribute>, AttributeModifier> pAction) -
forEachModifier
public void forEachModifier(EquipmentSlot pEquipmentSLot, BiConsumer<Holder<Attribute>, AttributeModifier> pAction) -
getDisplayName
-
canPlaceOnBlockInAdventureMode
-
canBreakBlockInAdventureMode
-
getPopTime
public int getPopTime() -
setPopTime
public void setPopTime(int pPopTime) -
getCount
public int getCount() -
setCount
public void setCount(int pCount) -
limitSize
public void limitSize(int pMaxSize) -
grow
public void grow(int pIncrement) -
shrink
public void shrink(int pDecrement) -
consume
-
consumeAndReturn
-
onUseTick
Called as the stack is being used by an entity. -
onDestroyed
Deprecated.Forge: Use invalid input: '{@linkplain net.neoforged.neoforge.common.extensions.IItemStackExtension#' onDestroyed(ItemEntity, net.minecraft.world.damagesource.DamageSource) damage source sensitive version} -
getDrinkingSound
-
getEatingSound
-
getBreakingSound
-
canBeHurtBy
-
invalid @link