Class ItemStack

Method Details

• validateStrict

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

• validatedStreamCodec

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

• 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 components)

• parse

  public static Optional<ItemStack> parse(HolderLookup.Provider lookupProvider, Tag tag)

• parseOptional

  public static ItemStack parseOptional(HolderLookup.Provider lookupProvider, CompoundTag tag)

• isEmpty

  public boolean isEmpty()

• isItemEnabled

  public boolean isItemEnabled(FeatureFlagSet enabledFlags)

• split

  public ItemStack split(int amount)

  Splits off a stack of the given amount of this stack and reduces this stack by the amount.

• copyAndClear

  public ItemStack copyAndClear()

• getItem

  public Item getItem()

• getItemHolder

  public Holder<Item> getItemHolder()

• is

  public boolean is(TagKey<Item> tag)

• is

  public boolean is(Item item)

• is

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

• is

  public boolean is(Holder<Item> item)

• is

  public boolean is(HolderSet<Item> item)

• getTags

  public Stream<TagKey<Item>> getTags()

• useOn

  public InteractionResult useOn(UseOnContext context)

• 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 state)

• use

  public InteractionResultHolder<ItemStack> use(Level level, Player player, InteractionHand usedHand)

  Called when the ItemStack is equipped and right-clicked. Replaces the ItemStack with the return value.

• finishUsingItem

  public ItemStack finishUsingItem(Level level, LivingEntity livingEntity)

  Called when the item in use count reach 0, e.g. item food eaten. Return the new ItemStack. Args : world, entity

• save

  public Tag save(HolderLookup.Provider levelRegistryAccess, Tag outputTag)

• save

  public Tag save(HolderLookup.Provider levelRegistryAccess)

• saveOptional

  public Tag saveOptional(HolderLookup.Provider levelRegistryAccess)

• 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 damage)

• getMaxDamage

  public int getMaxDamage()

• hurtAndBreak

  public void hurtAndBreak(int damage, ServerLevel level, @Nullable ServerPlayer player, Consumer<Item> onBreak)

• hurtAndBreak

  public void hurtAndBreak(int p_220158_, ServerLevel p_346256_, @Nullable LivingEntity p_220160_, Consumer<Item> p_348596_)

• hurtAndBreak

  public void hurtAndBreak(int amount, LivingEntity entity, EquipmentSlot slot)

• hurtAndConvertOnBreak

  public ItemStack hurtAndConvertOnBreak(int amount, ItemLike item, LivingEntity entity, EquipmentSlot slot)

• isBarVisible

  public boolean isBarVisible()

• getBarWidth

  public int getBarWidth()

• getBarColor

  public int getBarColor()

• overrideStackedOnOther

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

• overrideOtherStackedOnMe

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

• hurtEnemy

  public boolean hurtEnemy(LivingEntity target, Player attacker)

• postHurtEnemy

  public void postHurtEnemy(LivingEntity target, Player attacker)

• mineBlock

  public void mineBlock(Level level, BlockState state, BlockPos pos, Player player)

  Called when a Block is destroyed using this ItemStack

• isCorrectToolForDrops

  public boolean isCorrectToolForDrops(BlockState state)

  Check whether the given Block can be harvested using this ItemStack.

• interactLivingEntity

  public InteractionResult interactLivingEntity(Player player, LivingEntity entity, InteractionHand usedHand)

• copy

  public ItemStack copy()

• copyWithCount

  public ItemStack copyWithCount(int count)

• transmuteCopy

  public ItemStack transmuteCopy(ItemLike item)

• transmuteCopy

  public ItemStack transmuteCopy(ItemLike item, int count)

• transmuteCopyIgnoreEmpty

  private ItemStack transmuteCopyIgnoreEmpty(ItemLike item, int count)

• matches

  public static boolean matches(ItemStack stack, ItemStack other)

  Compares both ItemStacks, returns true if both ItemStacks are equal.

• listMatches

  @Deprecated public static boolean listMatches(List<ItemStack> list, List<ItemStack> other)

  Deprecated.

• isSameItem

  public static boolean isSameItem(ItemStack stack, ItemStack other)

• isSameItemSameComponents

  public static boolean isSameItemSameComponents(ItemStack stack, ItemStack other)

• lenientOptionalFieldOf

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

• hashItemAndComponents

  public static int hashItemAndComponents(@Nullable ItemStack stack)

• hashStackList

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

  Deprecated.

• getDescriptionId

  public String getDescriptionId()

• toString

  public String toString()

  Overrides:

  toString in class Object

• inventoryTick

  public void inventoryTick(Level level, Entity entity, int inventorySlot, boolean isCurrentItem)

  Called each tick as long the ItemStack in in player's inventory. Used to progress the pickup animation and update maps.

• onCraftedBy

  public void onCraftedBy(Level level, Player player, int amount)

• onCraftedBySystem

  public void onCraftedBySystem(Level level)

• getUseDuration

  public int getUseDuration(LivingEntity entity)

• getUseAnimation

  public UseAnim getUseAnimation()

• releaseUsing

  public void releaseUsing(Level level, LivingEntity livingEntity, int timeLeft)

  Called when the player releases the use item button.

• useOnRelease

  public boolean useOnRelease()

• set

  @Nullable public <T> T set(DataComponentType<? super T> component, @Nullable T value)

  Description copied from interface: MutableDataComponentHolder

  Sets a data component.

  Specified by:

  set in interface MutableDataComponentHolder

• update

  @Nullable public <T, U> T update(DataComponentType<T> component, T defaultValue, U updateValue, BiFunction<T,U,T> updater)

  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> component, T defaultValue, UnaryOperator<T> updater)

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

  Description copied from interface: MutableDataComponentHolder

  Removes a data component.

  Specified by:

  remove in interface MutableDataComponentHolder

• applyComponentsAndValidate

  public void applyComponentsAndValidate(DataComponentPatch components)

• applyComponents

  public void applyComponents(DataComponentPatch components)

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

  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> component, Item.TooltipContext context, Consumer<Component> tooltipAdder, TooltipFlag tooltipFlag)

  Specified by:

  addToTooltip in interface IDataComponentHolderExtension

• getTooltipLines

  public List<Component> getTooltipLines(Item.TooltipContext tooltipContext, @Nullable Player player, TooltipFlag tooltipFlag)

• addAttributeTooltips

  @Deprecated private void addAttributeTooltips(Consumer<Component> tooltipAdder, @Nullable Player player)

  Deprecated.

  Neo: Use

  invalid @link

  {@link net.neoforged.neoforge.client.util.TooltipUtil#

  addAttributeTooltips}

• addModifierTooltip

  private void addModifierTooltip(Consumer<Component> tooltipAdder, @Nullable Player player, Holder<Attribute> attribute, AttributeModifier modifier)

• hasFoil

  public boolean hasFoil()

• getRarity

  public Rarity getRarity()

• isEnchantable

  public boolean isEnchantable()

• enchant

  public void enchant(Holder<Enchantment> enchantment, int level)

• isEnchanted

  public boolean isEnchanted()

• getTagEnchantments

  public ItemEnchantments getTagEnchantments()

  Gets all enchantments from NBT. Use IItemStackExtension.getAllEnchantments(net.minecraft.core.HolderLookup.RegistryLookup<net.minecraft.world.item.enchantment.Enchantment>) for gameplay logic.

• getEnchantments

  @Deprecated public ItemEnchantments getEnchantments()

  Deprecated.

  Neo: Use getTagEnchantments() for NBT enchantments, or IItemStackExtension.getAllEnchantments(net.minecraft.core.HolderLookup.RegistryLookup<net.minecraft.world.item.enchantment.Enchantment>) for gameplay.

• isFramed

  public boolean isFramed()

• setEntityRepresentation

  public void setEntityRepresentation(@Nullable Entity entity)

• getFrame

  @Nullable public ItemFrame getFrame()

• getEntityRepresentation

  @Nullable public Entity getEntityRepresentation()

• forEachModifier

  public void forEachModifier(EquipmentSlotGroup slotGroup, BiConsumer<Holder<Attribute>,AttributeModifier> action)

• forEachModifier

  public void forEachModifier(EquipmentSlot equipmentSLot, BiConsumer<Holder<Attribute>,AttributeModifier> action)

• getDisplayName

  public Component getDisplayName()

• canPlaceOnBlockInAdventureMode

  public boolean canPlaceOnBlockInAdventureMode(BlockInWorld block)

• canBreakBlockInAdventureMode

  public boolean canBreakBlockInAdventureMode(BlockInWorld block)

• getPopTime

  public int getPopTime()

• setPopTime

  public void setPopTime(int popTime)

• getCount

  public int getCount()

• setCount

  public void setCount(int count)

• limitSize

  public void limitSize(int maxSize)

• grow

  public void grow(int increment)

• shrink

  public void shrink(int decrement)

• consume

  public void consume(int amount, @Nullable LivingEntity entity)

• consumeAndReturn

  public ItemStack consumeAndReturn(int amount, @Nullable LivingEntity entity)

• onUseTick

  public void onUseTick(Level level, LivingEntity livingEntity, int count)

  Called as the stack is being used by an entity.

• onDestroyed

  @Deprecated public void onDestroyed(ItemEntity itemEntity)

  Deprecated.

  Forge: Use invalid input: '{@linkplain net.neoforged.neoforge.common.extensions.IItemStackExtension#' onDestroyed(ItemEntity, net.minecraft.world.damagesource.DamageSource) damage source sensitive version}

• getDrinkingSound

  public SoundEvent getDrinkingSound()

• getEatingSound

  public SoundEvent getEatingSound()

• getBreakingSound

  public SoundEvent getBreakingSound()

• canBeHurtBy

  public boolean canBeHurtBy(DamageSource damageSource)