Class ItemStack

java.lang.Object

net.minecraft.world.item.ItemStack

All Implemented Interfaces:

DataComponentGetter, DataComponentHolder, TypedInstance<Item>, ItemInstance, IDataComponentHolderExtension, IItemStackExtension, MutableDataComponentHolder

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

Field Summary

Fields

Modifier and Type	Field	Description
static final com.mojang.serialization.Codec<ItemStack>	CODEC
private final PatchedDataComponentMap	components
private int	count
private static final Component	DISABLED_ITEM_TOOLTIP
static final ItemStack	EMPTY
private @Nullable Entity	entityRepresentation
private static final Component	INTANGIBLE_TOOLTIP
private final @Nullable Holder<Item>	item	Deprecated.
private static final org.slf4j.Logger	LOGGER
static final com.mojang.serialization.MapCodec<ItemStack>	MAP_CODEC
private static final List<Component>	OP_NBT_WARNING
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
static final StreamCodec<RegistryFriendlyByteBuf, ItemStack>	OPTIONAL_UNTRUSTED_STREAM_CODEC
private int	popTime
static final StreamCodec<RegistryFriendlyByteBuf, ItemStack>	STREAM_CODEC
private static final Component	UNBREAKABLE_TOOLTIP

Fields inherited from interface ItemInstance

FIELD_COMPONENTS, FIELD_COUNT, FIELD_ID

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ItemStack(@Nullable Void nullMarker)
	ItemStack(Holder<Item> item)
	ItemStack(Holder<Item> item, int count)
	ItemStack(Holder<Item> item, int count, DataComponentPatch components)
private	ItemStack(Holder<Item> item, int count, PatchedDataComponentMap components)
	ItemStack(ItemLike item)
	ItemStack(ItemLike item, int count)

Method Summary

Modifier and Type	Method	Description
private void	addAttributeTooltips(Consumer<Component> consumer, TooltipDisplay display, @Nullable Player player)	Deprecated. Neo: Use AttributeUtil.addAttributeTooltips(ItemStack, Consumer, TooltipDisplay, AttributeTooltipContext)
void	addDetailsToTooltip(Item.TooltipContext context, TooltipDisplay display, @Nullable Player player, TooltipFlag tooltipFlag, Consumer<Component> builder)
<T extends TooltipProvider> void	addToTooltip(DataComponentType<T> type, Item.TooltipContext context, TooltipDisplay display, Consumer<Component> consumer, TooltipFlag flag)
private void	addUnitComponentToTooltip(DataComponentType<?> dataComponentType, Component component, TooltipDisplay display, Consumer<Component> builder)
private ItemStack	applyAfterUseComponentSideEffects(LivingEntity user, ItemStack stackBeforeUsing)
void	applyComponents(DataComponentMap components)	Applies a set of component changes to this stack.
void	applyComponents(DataComponentPatch patch)	Applies a set of component changes to this stack.
void	applyComponentsAndValidate(DataComponentPatch patch)
private void	applyDamage(int newDamage, @Nullable ServerPlayer player, Consumer<Item> onBreak)
private void	applyDamage(int newDamage, @Nullable LivingEntity player, Consumer<Item> onBreak)
boolean	canBeHurtBy(DamageSource source)
boolean	canBreakBlockInAdventureMode(BlockInWorld blockInWorld)
boolean	canDestroyBlock(BlockState state, Level level, BlockPos pos, Player player)
boolean	canPlaceOnBlockInAdventureMode(BlockInWorld blockInWorld)
void	causeUseVibration(Entity causer, Holder.Reference<GameEvent> event)
void	consume(int amount, @Nullable LivingEntity owner)
ItemStack	consumeAndReturn(int amount, @Nullable LivingEntity owner)
ItemStack	copy()
ItemStack	copyAndClear()
<T> void	copyFrom(DataComponentType<T> type, DataComponentGetter source)	Copies a data component from a component getter.
ItemStack	copyWithCount(int count)
int	count()
private static StreamCodec<RegistryFriendlyByteBuf, ItemStack>	createOptionalStreamCodec(StreamCodec<RegistryFriendlyByteBuf, DataComponentPatch> patchCodec)
void	enchant(Holder<Enchantment> enchantment, int level)
ItemStack	finishUsingItem(Level level, LivingEntity livingEntity)
void	forEachModifier(EquipmentSlotGroup slot, org.apache.commons.lang3.function.TriConsumer<Holder<Attribute>, AttributeModifier, ItemAttributeModifiers.Display> consumer)
void	forEachModifier(EquipmentSlot slot, BiConsumer<Holder<Attribute>, AttributeModifier> consumer)
int	getBarColor()
int	getBarWidth()
DataComponentMap	getComponents()
DataComponentPatch	getComponentsPatch()
int	getCount()
@Nullable Component	getCustomName()
DamageSource	getDamageSource(LivingEntity attacker, Supplier<DamageSource> defaultSource)
int	getDamageValue()
float	getDestroySpeed(BlockState state)
Component	getDisplayName()
ItemEnchantments	getEnchantments()	Deprecated. Neo: Use getTagEnchantments() for NBT enchantments, or IItemStackExtension.getAllEnchantments(HolderLookup.RegistryLookup) for gameplay.
@Nullable Entity	getEntityRepresentation()
@Nullable ItemFrame	getFrame()
Component	getHoverName()
Item	getItem()
Component	getItemName()
int	getMaxDamage()
int	getMaxStackSize()
int	getPopTime()
DataComponentMap	getPrototype()
Rarity	getRarity()
Component	getStyledHoverName()
SwingAnimation	getSwingAnimation()
ItemEnchantments	getTagEnchantments()	Gets all enchantments from NBT.
Optional<TooltipComponent>	getTooltipImage()
List<Component>	getTooltipLines(Item.TooltipContext context, @Nullable Player player, TooltipFlag tooltipFlag)
ItemUseAnimation	getUseAnimation()
int	getUseDuration(LivingEntity user)
void	grow(int amount)
boolean	hasFoil()
static int	hashItemAndComponents(@Nullable ItemStack item)
static int	hashStackList(List<ItemStack> items)	Deprecated.
boolean	hasNonDefault(DataComponentType<?> type)
void	hurtAndBreak(int amount, ServerLevel level, @Nullable ServerPlayer player, Consumer<Item> onBreak)
void	hurtAndBreak(int amount, ServerLevel level, @Nullable LivingEntity player, Consumer<Item> onBreak)
void	hurtAndBreak(int amount, LivingEntity owner, EquipmentSlot slot)
void	hurtAndBreak(int amount, LivingEntity owner, InteractionHand hand)
ItemStack	hurtAndConvertOnBreak(int amount, ItemLike newItem, LivingEntity owner, EquipmentSlot slot)
boolean	hurtEnemy(LivingEntity mob, LivingEntity attacker)
void	hurtWithoutBreaking(int amount, Player player)
DataComponentMap	immutableComponents()
InteractionResult	interactLivingEntity(Player player, LivingEntity target, InteractionHand hand)
void	inventoryTick(Level level, Entity owner, @Nullable EquipmentSlot slot)
boolean	is(Predicate<Holder<Item>> item)
boolean	isBarVisible()
boolean	isBroken()
boolean	isComponentsPatchEmpty()
boolean	isCorrectToolForDrops(BlockState state)
boolean	isDamageableItem()
boolean	isDamaged()
boolean	isEmpty()
boolean	isEnchantable()
boolean	isEnchanted()
boolean	isFramed()
boolean	isItemEnabled(FeatureFlagSet enabledFeatures)
static boolean	isSameItem(ItemStack a, @Nullable ItemStackTemplate b)	Returns true if a and b refer to the same item, or if a is empty and b is null.
static boolean	isSameItem(ItemStack a, ItemStack b)
static boolean	isSameItemSameComponents(ItemStack a, @Nullable ItemStackTemplate b)	Compares the item and components of this stack against an ItemStackTemplate.
static boolean	isSameItemSameComponents(ItemStack a, ItemStack b)
boolean	isStackable()
boolean	isValidRepairItem(ItemStack repairItem)
static com.mojang.serialization.MapCodec<ItemStack>	lenientOptionalFieldOf(String name)
void	limitSize(int maxStackSize)
static boolean	listMatches(List<ItemStack> left, List<ItemStack> right)	Deprecated.
static boolean	matches(ItemStack a, @Nullable ItemStackTemplate b)	Compares an itemstack with an ItemStackTemplate as per matches(ItemStack, ItemStack).
static boolean	matches(ItemStack a, ItemStack b)
static boolean	matchesIgnoringComponents(ItemStack a, ItemStack b, Predicate<DataComponentType<?>> ignoredPredicate)
void	mineBlock(Level level, BlockState state, BlockPos pos, Player owner)
boolean	nextDamageWillBreak()
void	onCraftedBy(Player player, int craftCount)
void	onCraftedBySystem(Level level)
void	onDestroyed(ItemEntity itemEntity)	Deprecated. Forge: Use damage source sensitive version
private InteractionResult	onItemUse(UseOnContext context, Function<UseOnContext, InteractionResult> callback)
InteractionResult	onItemUseFirst(UseOnContext context)
void	onUseTick(Level level, LivingEntity livingEntity, int ticksRemaining)
boolean	overrideOtherStackedOnMe(ItemStack other, Slot slot, ClickAction clickAction, Player player, SlotAccess carriedItem)
boolean	overrideStackedOnOther(Slot slot, ClickAction clickAction, Player player)
void	postHurtEnemy(LivingEntity mob, LivingEntity attacker)
private int	processDurabilityChange(int amount, ServerLevel level, @Nullable ServerPlayer player)
private int	processDurabilityChange(int amount, ServerLevel level, @Nullable LivingEntity player)
void	releaseUsing(Level level, LivingEntity entity, int remainingTime)
<T> @Nullable T	remove(DataComponentType<? extends T> type)	Removes a data component.
<T> @Nullable T	set(DataComponentType<T> type, @Nullable T value)	Sets a data component.
<T> @Nullable T	set(TypedDataComponent<T> value)
void	setCount(int count)
void	setDamageValue(int value)
void	setEntityRepresentation(@Nullable Entity entity)
void	setPopTime(int popTime)
void	shrink(int amount)
ItemStack	split(int amount)
String	toString()
ItemStack	transmuteCopy(ItemLike newItem)
ItemStack	transmuteCopy(ItemLike newItem, int newCount)
private ItemStack	transmuteCopyIgnoreEmpty(ItemLike newItem, int newCount)
Holder<Item>	typeHolder()
<T> @Nullable T	update(DataComponentType<T> type, T defaultValue, UnaryOperator<T> function)	Updates a data component if it exists.
<T,U> @Nullable T	update(DataComponentType<T> type, T defaultValue, U value, BiFunction<T,U,T> combiner)	Updates a data component if it exists, using an additional updateContext.
InteractionResult	use(Level level, Player player, InteractionHand hand)
InteractionResult	useOn(UseOnContext context)
boolean	useOnRelease()
static com.mojang.serialization.DataResult<?>	validateComponents(DataComponentMap components)
private static com.mojang.serialization.DataResult<?>	validateContainedItemSizes(Iterable<? extends ItemInstance> items)
static StreamCodec<RegistryFriendlyByteBuf, ItemStack>	validatedStreamCodec(StreamCodec<RegistryFriendlyByteBuf, ItemStack> codec)
static com.mojang.serialization.DataResult<ItemStack>	validateStrict(ItemStack itemStack)

Methods inherited from class Object

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

Methods inherited from interface DataComponentGetter

get, getOrDefault, getTyped, has

Methods inherited from interface DataComponentHolder

get, getAllOfType, getOrDefault, has

Methods inherited from interface IDataComponentHolderExtension

addToTooltip

Methods inherited from interface IItemStackExtension

canEquip, canFitInsideContainerItems, canGrindstoneRepair, canPerformAction, canWalkOnPowderedSnow, doesSneakBypassUse, getAllEnchantments, getAttributeModifiers, getBurnTime, getCapability, getCapability, getCraftingRemainder, getEnchantmentLevel, getEntityLifespan, getEquipmentSlot, getHighlightTip, getSweepHitBox, getXpRepairRatio, isCombineRepairable, isGazeDisguise, isNotReplaceableByPickAction, isPiglinCurrency, isPrimaryItemFor, makesPiglinsNeutral, onAnimalArmorTick, onDestroyed, onDroppedByPlayer, onEntityItemUpdate, onEntitySwing, onStopUsing, shouldCauseBlockBreakReset, supportsEnchantment

Methods inherited from interface MutableDataComponentHolder

copyFrom, copyFrom, copyFrom, remove, set, update, update

Methods inherited from interface TypedInstance

is, is, is, is, is, tags

Field Details

OP_NBT_WARNING

private static final List<Component> OP_NBT_WARNING

UNBREAKABLE_TOOLTIP

private static final Component UNBREAKABLE_TOOLTIP

INTANGIBLE_TOOLTIP

private static final Component INTANGIBLE_TOOLTIP

MAP_CODEC

public static final com.mojang.serialization.MapCodec<ItemStack> MAP_CODEC

CODEC

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

OPTIONAL_CODEC

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

OPTIONAL_STREAM_CODEC

public static final StreamCodec<RegistryFriendlyByteBuf, ItemStack> OPTIONAL_STREAM_CODEC

OPTIONAL_UNTRUSTED_STREAM_CODEC

public static final StreamCodec<RegistryFriendlyByteBuf, ItemStack> OPTIONAL_UNTRUSTED_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

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
private final @Nullable Holder<Item> item

Deprecated.

components

private final PatchedDataComponentMap components

entityRepresentation

private @Nullable Entity entityRepresentation

Constructor Details

ItemStack

public ItemStack(ItemLike item,
 int count)

ItemStack

public ItemStack(ItemLike item)

ItemStack

public ItemStack(Holder<Item> item,
 int count)

ItemStack

public ItemStack(Holder<Item> item)

ItemStack

public ItemStack(Holder<Item> item,
 int count,
 DataComponentPatch components)

ItemStack

private ItemStack(Holder<Item> item,
 int count,
 PatchedDataComponentMap components)

ItemStack

private ItemStack(@Nullable Void nullMarker)

Method Details

validateStrict

public static com.mojang.serialization.DataResult<ItemStack> validateStrict(ItemStack itemStack)

createOptionalStreamCodec

private static StreamCodec<RegistryFriendlyByteBuf, ItemStack> createOptionalStreamCodec(StreamCodec<RegistryFriendlyByteBuf, DataComponentPatch> patchCodec)

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

immutableComponents

public DataComponentMap immutableComponents()

hasNonDefault

public boolean hasNonDefault(DataComponentType<?> type)

isComponentsPatchEmpty

public boolean isComponentsPatchEmpty()

validateComponents

public static com.mojang.serialization.DataResult<?> validateComponents(DataComponentMap components)

validateContainedItemSizes

private static com.mojang.serialization.DataResult<?> validateContainedItemSizes(Iterable<? extends ItemInstance> items)

isEmpty

public boolean isEmpty()

isItemEnabled

public boolean isItemEnabled(FeatureFlagSet enabledFeatures)

split

public ItemStack split(int amount)

copyAndClear

public ItemStack copyAndClear()

getItem

public Item getItem()

typeHolder

public Holder<Item> typeHolder()

Specified by:

typeHolder in interface TypedInstance<Item>

is

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

useOn

public InteractionResult useOn(UseOnContext context)

onItemUseFirst

public InteractionResult onItemUseFirst(UseOnContext context)

Specified by:

onItemUseFirst in interface IItemStackExtension

onItemUse

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

getDestroySpeed

public float getDestroySpeed(BlockState state)

use

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

finishUsingItem

public ItemStack finishUsingItem(Level level,
 LivingEntity livingEntity)

applyAfterUseComponentSideEffects

private ItemStack applyAfterUseComponentSideEffects(LivingEntity user,
 ItemStack stackBeforeUsing)

getMaxStackSize

public int getMaxStackSize()

Specified by:

getMaxStackSize in interface ItemInstance

isStackable

public boolean isStackable()

isDamageableItem

public boolean isDamageableItem()

isDamaged

public boolean isDamaged()

getDamageValue

public int getDamageValue()

setDamageValue

public void setDamageValue(int value)

getMaxDamage

public int getMaxDamage()

isBroken

public boolean isBroken()

nextDamageWillBreak

public boolean nextDamageWillBreak()

hurtAndBreak

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

hurtAndBreak

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

processDurabilityChange

private int processDurabilityChange(int amount,
 ServerLevel level,
 @Nullable ServerPlayer player)

processDurabilityChange

private int processDurabilityChange(int amount,
 ServerLevel level,
 @Nullable LivingEntity player)

applyDamage

private void applyDamage(int newDamage,
 @Nullable ServerPlayer player,
 Consumer<Item> onBreak)

applyDamage

private void applyDamage(int newDamage,
 @Nullable LivingEntity player,
 Consumer<Item> onBreak)

hurtWithoutBreaking

public void hurtWithoutBreaking(int amount,
 Player player)

hurtAndBreak

public void hurtAndBreak(int amount,
 LivingEntity owner,
 InteractionHand hand)

hurtAndBreak

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

hurtAndConvertOnBreak

public ItemStack hurtAndConvertOnBreak(int amount,
 ItemLike newItem,
 LivingEntity owner,
 EquipmentSlot slot)

isBarVisible

public boolean isBarVisible()

getBarWidth

public int getBarWidth()

getBarColor

public int getBarColor()

overrideStackedOnOther

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

overrideOtherStackedOnMe

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

hurtEnemy

public boolean hurtEnemy(LivingEntity mob,
 LivingEntity attacker)

postHurtEnemy

public void postHurtEnemy(LivingEntity mob,
 LivingEntity attacker)

mineBlock

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

isCorrectToolForDrops

public boolean isCorrectToolForDrops(BlockState state)

interactLivingEntity

public InteractionResult interactLivingEntity(Player player,
 LivingEntity target,
 InteractionHand hand)

copy

public ItemStack copy()

copyWithCount

public ItemStack copyWithCount(int count)

transmuteCopy

public ItemStack transmuteCopy(ItemLike newItem)

transmuteCopy

public ItemStack transmuteCopy(ItemLike newItem,
 int newCount)

transmuteCopyIgnoreEmpty

private ItemStack transmuteCopyIgnoreEmpty(ItemLike newItem,
 int newCount)

matches

public static boolean matches(ItemStack a,
 ItemStack b)

matches

public static boolean matches(ItemStack a,
 @Nullable ItemStackTemplate b)

Compares an itemstack with an ItemStackTemplate as per matches(ItemStack, ItemStack).

listMatches

@Deprecated
public static boolean listMatches(List<ItemStack> left,
 List<ItemStack> right)

Deprecated.

isSameItem

public static boolean isSameItem(ItemStack a,
 ItemStack b)

isSameItemSameComponents

public static boolean isSameItemSameComponents(ItemStack a,
 ItemStack b)

isSameItem

public static boolean isSameItem(ItemStack a,
 @Nullable ItemStackTemplate b)

Returns true if a and b refer to the same item, or if a is empty and b is null.

Returns:

true if a and b refer to the same item, or if a is empty and b is null

isSameItemSameComponents

public static boolean isSameItemSameComponents(ItemStack a,
 @Nullable ItemStackTemplate b)

Compares the item and components of this stack against an ItemStackTemplate.

Returns:

True if either this stack is empty and the template is null, or they reference the same item and have equivalent component patches.

matchesIgnoringComponents

public static boolean matchesIgnoringComponents(ItemStack a,
 ItemStack b,
 Predicate<DataComponentType<?>> ignoredPredicate)

lenientOptionalFieldOf

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

hashItemAndComponents

public static int hashItemAndComponents(@Nullable ItemStack item)

hashStackList

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

Deprecated.

toString

public String toString()

Overrides:

toString in class Object

inventoryTick

public void inventoryTick(Level level,
 Entity owner,
 @Nullable EquipmentSlot slot)

onCraftedBy

public void onCraftedBy(Player player,
 int craftCount)

onCraftedBySystem

public void onCraftedBySystem(Level level)

getUseDuration

public int getUseDuration(LivingEntity user)

getUseAnimation

public ItemUseAnimation getUseAnimation()

releaseUsing

public void releaseUsing(Level level,
 LivingEntity entity,
 int remainingTime)

causeUseVibration

public void causeUseVibration(Entity causer,
 Holder.Reference<GameEvent> event)

useOnRelease

public boolean useOnRelease()

set

public <T> @Nullable T set(DataComponentType<T> type,
 @Nullable T value)

Description copied from interface: MutableDataComponentHolder

Sets a data component.

Specified by:

set in interface MutableDataComponentHolder

set

public <T> @Nullable T set(TypedDataComponent<T> value)

copyFrom

public <T> void copyFrom(DataComponentType<T> type,
 DataComponentGetter source)

Description copied from interface: MutableDataComponentHolder

Copies a data component from a component getter.

Specified by:

copyFrom in interface MutableDataComponentHolder

update

public <T,U> @Nullable T update(DataComponentType<T> type,
 T defaultValue,
 U value,
 BiFunction<T,U,T> combiner)

Description copied from interface: MutableDataComponentHolder

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

Specified by:

update in interface MutableDataComponentHolder

update

public <T> @Nullable T update(DataComponentType<T> type,
 T defaultValue,
 UnaryOperator<T> function)

Description copied from interface: MutableDataComponentHolder

Updates a data component if it exists.

Specified by:

update in interface MutableDataComponentHolder

remove

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

Description copied from interface: MutableDataComponentHolder

Removes a data component.

Specified by:

remove in interface MutableDataComponentHolder

applyComponentsAndValidate

public void applyComponentsAndValidate(DataComponentPatch patch)

applyComponents

public void applyComponents(DataComponentPatch patch)

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

getCustomName

public @Nullable Component getCustomName()

getItemName

public Component getItemName()

getStyledHoverName

public Component getStyledHoverName()

addToTooltip

public <T extends TooltipProvider> void addToTooltip(DataComponentType<T> type,
 Item.TooltipContext context,
 TooltipDisplay display,
 Consumer<Component> consumer,
 TooltipFlag flag)

Specified by:

addToTooltip in interface IDataComponentHolderExtension

getTooltipLines

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

addDetailsToTooltip

public void addDetailsToTooltip(Item.TooltipContext context,
 TooltipDisplay display,
 @Nullable Player player,
 TooltipFlag tooltipFlag,
 Consumer<Component> builder)

addUnitComponentToTooltip

private void addUnitComponentToTooltip(DataComponentType<?> dataComponentType,
 Component component,
 TooltipDisplay display,
 Consumer<Component> builder)

addAttributeTooltips

@Deprecated
private void addAttributeTooltips(Consumer<Component> consumer,
 TooltipDisplay display,
 @Nullable Player player)

Deprecated.

Neo: Use AttributeUtil.addAttributeTooltips(ItemStack, Consumer, TooltipDisplay, AttributeTooltipContext)

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(HolderLookup.RegistryLookup) for gameplay logic.

getEnchantments

@Deprecated
public ItemEnchantments getEnchantments()

Deprecated.

Neo: Use getTagEnchantments() for NBT enchantments, or IItemStackExtension.getAllEnchantments(HolderLookup.RegistryLookup) for gameplay.

isFramed

public boolean isFramed()

setEntityRepresentation

public void setEntityRepresentation(@Nullable Entity entity)

getFrame

public @Nullable ItemFrame getFrame()

getEntityRepresentation

public @Nullable Entity getEntityRepresentation()

forEachModifier

public void forEachModifier(EquipmentSlotGroup slot,
 org.apache.commons.lang3.function.TriConsumer<Holder<Attribute>, AttributeModifier, ItemAttributeModifiers.Display> consumer)

forEachModifier

public void forEachModifier(EquipmentSlot slot,
 BiConsumer<Holder<Attribute>, AttributeModifier> consumer)

getDisplayName

public Component getDisplayName()

getSwingAnimation

public SwingAnimation getSwingAnimation()

canPlaceOnBlockInAdventureMode

public boolean canPlaceOnBlockInAdventureMode(BlockInWorld blockInWorld)

canBreakBlockInAdventureMode

public boolean canBreakBlockInAdventureMode(BlockInWorld blockInWorld)

getPopTime

public int getPopTime()

setPopTime

public void setPopTime(int popTime)

getCount

public int getCount()

count

public int count()

Specified by:

count in interface ItemInstance

setCount

public void setCount(int count)

limitSize

public void limitSize(int maxStackSize)

grow

public void grow(int amount)

shrink

public void shrink(int amount)

consume

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

consumeAndReturn

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

onUseTick

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

onDestroyed

@Deprecated
public void onDestroyed(ItemEntity itemEntity)

Deprecated.

Forge: Use damage source sensitive version

canBeHurtBy

public boolean canBeHurtBy(DamageSource source)

isValidRepairItem

public boolean isValidRepairItem(ItemStack repairItem)

canDestroyBlock

public boolean canDestroyBlock(BlockState state,
 Level level,
 BlockPos pos,
 Player player)

getDamageSource

public DamageSource getDamageSource(LivingEntity attacker,
 Supplier<DamageSource> defaultSource)