ItemStack (forge 1.15.2-31.2.47)

java.lang.Object
- net.minecraftforge.common.capabilities.CapabilityProvider<ItemStack>
- - net.minecraft.item.ItemStack

All Implemented Interfaces:

ICapabilityProvider, ICapabilitySerializable<CompoundNBT>, IForgeItemStack, INBTSerializable<CompoundNBT>
```
public final class ItemStack
extends CapabilityProvider<ItemStack>
implements IForgeItemStack
```

Field Summary

Fields
Modifier and Type	Field and Description
`private int`	`animationsToGo`
`private CachedBlockInfo`	`canDestroyCacheBlock`
`private boolean`	`canDestroyCacheResult`
`private CachedBlockInfo`	`canPlaceOnCacheBlock`
`private boolean`	`canPlaceOnCacheResult`
`private CompoundNBT`	`capNBT`
`private int`	`count`
`static java.text.DecimalFormat`	`DECIMALFORMAT`
`private IRegistryDelegate<Item>`	`delegate`
`static ItemStack`	`EMPTY`
`private boolean`	`isEmpty`
`private Item`	`item` Deprecated.
`private ItemFrameEntity`	`itemFrame`
`private static org.apache.logging.log4j.Logger`	`LOGGER`
`private CompoundNBT`	`tag`

Constructor Summary

Constructors
Modifier	Constructor and Description
`private`	`ItemStack(CompoundNBT compound)`
	`ItemStack(IItemProvider itemIn)`
	`ItemStack(IItemProvider itemIn, int count)`
	`ItemStack(IItemProvider itemIn, int count, CompoundNBT capNBT)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAttributeModifier(java.lang.String attributeName, AttributeModifier modifier, EquipmentSlotType equipmentSlot)`
`void`	`addEnchantment(Enchantment ench, int level)`
`static void`	`addEnchantmentTooltips(java.util.List<ITextComponent> p_222120_0_, ListNBT p_222120_1_)`
`static boolean`	`areItemsEqual(ItemStack stackA, ItemStack stackB)`
`static boolean`	`areItemsEqualIgnoreDurability(ItemStack stackA, ItemStack stackB)`
`static boolean`	`areItemStacksEqual(ItemStack stackA, ItemStack stackB)`
`static boolean`	`areItemStackTagsEqual(ItemStack stackA, ItemStack stackB)`
`boolean`	`attemptDamageItem(int amount, java.util.Random rand, ServerPlayerEntity damager)`
`boolean`	`canDestroy(NetworkTagManager p_206848_1_, CachedBlockInfo p_206848_2_)`
`boolean`	`canHarvestBlock(BlockState blockIn)`
`boolean`	`canPlaceOn(NetworkTagManager p_206847_1_, CachedBlockInfo p_206847_2_)`
`void`	`clearCustomName()`
`ItemStack`	`copy()`
`private static java.text.DecimalFormat`	`createAttributeModifierDecimalFormat()`
`<T extends LivingEntity> void`	`damageItem(int amount, T entityIn, java.util.function.Consumer<T> onBroken)`
`void`	`deserializeNBT(CompoundNBT nbt)`
`private void`	`forgeInit()` Set up forge's ItemStack additions.
`int`	`getAnimationsToGo()`
`com.google.common.collect.Multimap<java.lang.String,AttributeModifier>`	`getAttributeModifiers(EquipmentSlotType equipmentSlot)`
`CompoundNBT`	`getChildTag(java.lang.String key)`
`int`	`getCount()`
`int`	`getDamage()`
`float`	`getDestroySpeed(BlockState blockIn)`
`ITextComponent`	`getDisplayName()`
`SoundEvent`	`getDrinkSound()`
`SoundEvent`	`getEatSound()`
`ListNBT`	`getEnchantmentTagList()`
`Item`	`getItem()`
`ItemFrameEntity`	`getItemFrame()`
`private Item`	`getItemRaw()` Internal call to get the actual item, not the delegate.
`int`	`getMaxDamage()`
`int`	`getMaxStackSize()`
`CompoundNBT`	`getOrCreateChildTag(java.lang.String key)`
`CompoundNBT`	`getOrCreateTag()`
`private static java.util.Collection<ITextComponent>`	`getPlacementTooltip(java.lang.String stateString)`
`Rarity`	`getRarity()`
`int`	`getRepairCost()`
`CompoundNBT`	`getTag()`
`ITextComponent`	`getTextComponent()`
`java.util.List<ITextComponent>`	`getTooltip(PlayerEntity playerIn, ITooltipFlag advanced)`
`java.lang.String`	`getTranslationKey()`
`UseAction`	`getUseAction()`
`int`	`getUseDuration()`
`void`	`grow(int count)`
`boolean`	`hasDisplayName()`
`boolean`	`hasEffect()`
`boolean`	`hasTag()`
`void`	`hitEntity(LivingEntity entityIn, PlayerEntity playerIn)`
`boolean`	`interactWithEntity(PlayerEntity playerIn, LivingEntity entityIn, Hand hand)`
`void`	`inventoryTick(World worldIn, Entity entityIn, int inventorySlot, boolean isCurrentItem)`
`boolean`	`isCrossbowStack()`
`boolean`	`isDamageable()`
`boolean`	`isDamaged()`
`boolean`	`isEmpty()`
`boolean`	`isEnchantable()`
`boolean`	`isEnchanted()`
`boolean`	`isFood()`
`boolean`	`isItemEqual(ItemStack other)`
`boolean`	`isItemEqualIgnoreDurability(ItemStack stack)`
`private boolean`	`isItemStackEqual(ItemStack other)`
`boolean`	`isOnItemFrame()`
`boolean`	`isStackable()`
`private static boolean`	`isStateAndTileEntityEqual(CachedBlockInfo p_206846_0_, CachedBlockInfo p_206846_1_)`
`void`	`onBlockDestroyed(World worldIn, BlockState blockIn, BlockPos pos, PlayerEntity playerIn)`
`void`	`onCrafting(World worldIn, PlayerEntity playerIn, int amount)`
`ActionResultType`	`onItemUse(ItemUseContext context)`
`private ActionResultType`	`onItemUse(ItemUseContext context, java.util.function.Function<ItemUseContext,ActionResultType> callback)`
`void`	`onItemUsed(World worldIn, LivingEntity livingEntityIn, int countIn)`
`ItemStack`	`onItemUseFinish(World worldIn, LivingEntity entityLiving)`
`ActionResultType`	`onItemUseFirst(ItemUseContext context)`
`void`	`onPlayerStoppedUsing(World worldIn, LivingEntity entityLiving, int timeLeft)`
`static ItemStack`	`read(CompoundNBT compound)`
`void`	`removeChildTag(java.lang.String p_196083_1_)`
`void`	`setAnimationsToGo(int animations)`
`void`	`setCount(int count)`
`void`	`setDamage(int damage)`
`ItemStack`	`setDisplayName(ITextComponent name)`
`void`	`setItemFrame(ItemFrameEntity frame)`
`void`	`setRepairCost(int cost)`
`void`	`setTag(CompoundNBT nbt)`
`void`	`setTagInfo(java.lang.String key, INBT value)`
`void`	`shrink(int count)`
`ItemStack`	`split(int amount)`
`java.lang.String`	`toString()`
`private void`	`updateEmptyState()`
`ActionResult<ItemStack>`	`useItemRightClick(World worldIn, PlayerEntity playerIn, Hand hand)`
`CompoundNBT`	`write(CompoundNBT nbt)`

Methods inherited from class net.minecraftforge.common.capabilities.CapabilityProvider
areCapsCompatible, areCapsCompatible, deserializeCaps, gatherCapabilities, gatherCapabilities, getCapabilities, getCapability, invalidateCaps, reviveCaps, serializeCaps

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.minecraftforge.common.extensions.IForgeItemStack
areShareTagsEqual, canApplyAtEnchantingTable, canDisableShield, canElytraFly, canEquip, doesSneakBypassUse, elytraFlightTick, equals, getBurnTime, getContainerItem, getEntityLifespan, getEquipmentSlot, getHarvestLevel, getHighlightTip, getItemEnchantability, getShareTag, getStack, getToolTypes, getXpRepairRatio, hasContainerItem, isBeaconPayment, isBookEnchantable, isRepairable, isShield, onArmorTick, onBlockStartBreak, onDroppedByPlayer, onEntityItemUpdate, onEntitySwing, onHorseArmorTick, onUsingTick, readShareTag, serializeNBT, shouldCauseBlockBreakReset

Methods inherited from interface net.minecraftforge.common.capabilities.ICapabilityProvider
getCapability, getCapability

Field Detail

LOGGER

private static final org.apache.logging.log4j.Logger LOGGER

EMPTY
```
public static final ItemStack EMPTY
```

DECIMALFORMAT

public static final java.text.DecimalFormat DECIMALFORMAT

count
```
private int count
```

animationsToGo
```
private int animationsToGo
```

item
```
@Deprecated
private final Item item
```
Deprecated.

tag
```
private CompoundNBT tag
```

isEmpty
```
private boolean isEmpty
```

itemFrame
```
private ItemFrameEntity itemFrame
```

canDestroyCacheBlock

private CachedBlockInfo canDestroyCacheBlock

canDestroyCacheResult
```
private boolean canDestroyCacheResult
```

canPlaceOnCacheBlock

private CachedBlockInfo canPlaceOnCacheBlock

canPlaceOnCacheResult
```
private boolean canPlaceOnCacheResult
```

delegate

private IRegistryDelegate<Item> delegate

capNBT
```
private CompoundNBT capNBT
```

Constructor Detail

ItemStack

public ItemStack(IItemProvider itemIn)

ItemStack

public ItemStack(IItemProvider itemIn,
                 int count)

ItemStack

public ItemStack(IItemProvider itemIn,
                 int count,
                 @Nullable
                 CompoundNBT capNBT)

ItemStack

private ItemStack(CompoundNBT compound)

Method Detail

createAttributeModifierDecimalFormat

private static java.text.DecimalFormat createAttributeModifierDecimalFormat()

updateEmptyState
```
private void updateEmptyState()
```

read

public static ItemStack read(CompoundNBT compound)

isEmpty
```
public boolean isEmpty()
```

split
```
public ItemStack split(int amount)
```

getItem
```
public Item getItem()
```

onItemUse

public ActionResultType onItemUse(ItemUseContext context)

onItemUseFirst

public ActionResultType onItemUseFirst(ItemUseContext context)

Specified by:: onItemUseFirst in interface IForgeItemStack

onItemUse

private ActionResultType onItemUse(ItemUseContext context,
                                   java.util.function.Function<ItemUseContext,ActionResultType> callback)

getDestroySpeed

public float getDestroySpeed(BlockState blockIn)

useItemRightClick

public ActionResult<ItemStack> useItemRightClick(World worldIn,
                                                 PlayerEntity playerIn,
                                                 Hand hand)

onItemUseFinish

public ItemStack onItemUseFinish(World worldIn,
                                 LivingEntity entityLiving)

write

public CompoundNBT write(CompoundNBT nbt)

getMaxStackSize
```
public int getMaxStackSize()
```

isStackable
```
public boolean isStackable()
```

isDamageable
```
public boolean isDamageable()
```

isDamaged
```
public boolean isDamaged()
```

getDamage
```
public int getDamage()
```

setDamage
```
public void setDamage(int damage)
```

getMaxDamage
```
public int getMaxDamage()
```

attemptDamageItem

public boolean attemptDamageItem(int amount,
                                 java.util.Random rand,
                                 @Nullable
                                 ServerPlayerEntity damager)

damageItem

public <T extends LivingEntity> void damageItem(int amount,
                                                T entityIn,
                                                java.util.function.Consumer<T> onBroken)

hitEntity

public void hitEntity(LivingEntity entityIn,
                      PlayerEntity playerIn)

onBlockDestroyed

public void onBlockDestroyed(World worldIn,
                             BlockState blockIn,
                             BlockPos pos,
                             PlayerEntity playerIn)

canHarvestBlock

public boolean canHarvestBlock(BlockState blockIn)

interactWithEntity

public boolean interactWithEntity(PlayerEntity playerIn,
                                  LivingEntity entityIn,
                                  Hand hand)

copy
```
public ItemStack copy()
```

areItemStackTagsEqual

public static boolean areItemStackTagsEqual(ItemStack stackA,
                                            ItemStack stackB)

areItemStacksEqual

public static boolean areItemStacksEqual(ItemStack stackA,
                                         ItemStack stackB)

isItemStackEqual

private boolean isItemStackEqual(ItemStack other)

areItemsEqual

public static boolean areItemsEqual(ItemStack stackA,
                                    ItemStack stackB)

areItemsEqualIgnoreDurability

public static boolean areItemsEqualIgnoreDurability(ItemStack stackA,
                                                    ItemStack stackB)

isItemEqual

public boolean isItemEqual(ItemStack other)

isItemEqualIgnoreDurability

public boolean isItemEqualIgnoreDurability(ItemStack stack)

getTranslationKey

public java.lang.String getTranslationKey()

toString
```
public java.lang.String toString()
```
Overrides:

toString in class java.lang.Object

inventoryTick

public void inventoryTick(World worldIn,
                          Entity entityIn,
                          int inventorySlot,
                          boolean isCurrentItem)

onCrafting

public void onCrafting(World worldIn,
                       PlayerEntity playerIn,
                       int amount)

getUseDuration
```
public int getUseDuration()
```

getUseAction
```
public UseAction getUseAction()
```

onPlayerStoppedUsing

public void onPlayerStoppedUsing(World worldIn,
                                 LivingEntity entityLiving,
                                 int timeLeft)

isCrossbowStack
```
public boolean isCrossbowStack()
```

hasTag
```
public boolean hasTag()
```

getTag
```
@Nullable
public CompoundNBT getTag()
```

getOrCreateTag
```
public CompoundNBT getOrCreateTag()
```

getOrCreateChildTag

public CompoundNBT getOrCreateChildTag(java.lang.String key)

getChildTag

@Nullable
public CompoundNBT getChildTag(java.lang.String key)

removeChildTag

public void removeChildTag(java.lang.String p_196083_1_)

getEnchantmentTagList

public ListNBT getEnchantmentTagList()

setTag

public void setTag(@Nullable
                   CompoundNBT nbt)

getDisplayName

public ITextComponent getDisplayName()

setDisplayName

public ItemStack setDisplayName(@Nullable
                                ITextComponent name)

clearCustomName
```
public void clearCustomName()
```

hasDisplayName
```
public boolean hasDisplayName()
```

getTooltip

public java.util.List<ITextComponent> getTooltip(@Nullable
                                                 PlayerEntity playerIn,
                                                 ITooltipFlag advanced)

addEnchantmentTooltips

public static void addEnchantmentTooltips(java.util.List<ITextComponent> p_222120_0_,
                                          ListNBT p_222120_1_)

getPlacementTooltip

private static java.util.Collection<ITextComponent> getPlacementTooltip(java.lang.String stateString)

hasEffect
```
public boolean hasEffect()
```

getRarity
```
public Rarity getRarity()
```

isEnchantable
```
public boolean isEnchantable()
```

addEnchantment

public void addEnchantment(Enchantment ench,
                           int level)

isEnchanted
```
public boolean isEnchanted()
```

setTagInfo

public void setTagInfo(java.lang.String key,
                       INBT value)

isOnItemFrame
```
public boolean isOnItemFrame()
```

setItemFrame

public void setItemFrame(@Nullable
                         ItemFrameEntity frame)

getItemFrame

@Nullable
public ItemFrameEntity getItemFrame()

getRepairCost
```
public int getRepairCost()
```

setRepairCost
```
public void setRepairCost(int cost)
```

getAttributeModifiers

public com.google.common.collect.Multimap<java.lang.String,AttributeModifier> getAttributeModifiers(EquipmentSlotType equipmentSlot)

addAttributeModifier

public void addAttributeModifier(java.lang.String attributeName,
                                 AttributeModifier modifier,
                                 @Nullable
                                 EquipmentSlotType equipmentSlot)

getTextComponent

public ITextComponent getTextComponent()

isStateAndTileEntityEqual

private static boolean isStateAndTileEntityEqual(CachedBlockInfo p_206846_0_,
                                                 @Nullable
                                                 CachedBlockInfo p_206846_1_)

canDestroy

public boolean canDestroy(NetworkTagManager p_206848_1_,
                          CachedBlockInfo p_206848_2_)

canPlaceOn

public boolean canPlaceOn(NetworkTagManager p_206847_1_,
                          CachedBlockInfo p_206847_2_)

getAnimationsToGo
```
public int getAnimationsToGo()
```

setAnimationsToGo

public void setAnimationsToGo(int animations)

getCount
```
public int getCount()
```

setCount
```
public void setCount(int count)
```

grow
```
public void grow(int count)
```

shrink
```
public void shrink(int count)
```

onItemUsed

public void onItemUsed(World worldIn,
                       LivingEntity livingEntityIn,
                       int countIn)

isFood
```
public boolean isFood()
```

deserializeNBT
```
public void deserializeNBT(CompoundNBT nbt)
```
Specified by:

deserializeNBT in interface INBTSerializable<CompoundNBT>

forgeInit
```
private void forgeInit()
```
Set up forge's ItemStack additions.

getItemRaw
```
@Nullable
private Item getItemRaw()
```
Internal call to get the actual item, not the delegate. In all other methods, FML replaces calls to this.item with the item delegate.

getDrinkSound
```
public SoundEvent getDrinkSound()
```

getEatSound
```
public SoundEvent getEatSound()
```

Class ItemStack

Field Summary

Constructor Summary

Method Summary

Methods inherited from class net.minecraftforge.common.capabilities.CapabilityProvider

Methods inherited from class java.lang.Object

Methods inherited from interface net.minecraftforge.common.extensions.IForgeItemStack

Methods inherited from interface net.minecraftforge.common.capabilities.ICapabilityProvider

Field Detail

LOGGER

EMPTY

DECIMALFORMAT

count

animationsToGo

item

tag

isEmpty

itemFrame

canDestroyCacheBlock

canDestroyCacheResult

canPlaceOnCacheBlock

canPlaceOnCacheResult

delegate

capNBT

Constructor Detail

ItemStack

ItemStack

ItemStack

ItemStack

Method Detail

createAttributeModifierDecimalFormat

updateEmptyState

read

isEmpty

split

getItem

onItemUse

onItemUseFirst

onItemUse

getDestroySpeed

useItemRightClick

onItemUseFinish

write

getMaxStackSize

isStackable

isDamageable

isDamaged

getDamage

setDamage

getMaxDamage

attemptDamageItem

damageItem

hitEntity

onBlockDestroyed

canHarvestBlock

interactWithEntity

copy

areItemStackTagsEqual

areItemStacksEqual

isItemStackEqual

areItemsEqual

areItemsEqualIgnoreDurability

isItemEqual

isItemEqualIgnoreDurability

getTranslationKey

toString

inventoryTick

onCrafting

getUseDuration

getUseAction

onPlayerStoppedUsing

isCrossbowStack

hasTag

getTag

getOrCreateTag

getOrCreateChildTag

getChildTag

removeChildTag

getEnchantmentTagList

setTag