ItemStack (Forge-1.12.2-14.23.5.2854)

java.lang.Object
- net.minecraft.item.ItemStack

All Implemented Interfaces:

ICapabilityProvider, ICapabilitySerializable<NBTTagCompound>, INBTSerializable<NBTTagCompound>
```
public final class ItemStack
extends java.lang.Object
implements ICapabilitySerializable<NBTTagCompound>
```

Field Summary

Fields
Modifier and Type	Field and Description
`private int`	`animationsToGo`
`private Block`	`canDestroyCacheBlock`
`private boolean`	`canDestroyCacheResult`
`private Block`	`canPlaceOnCacheBlock`
`private boolean`	`canPlaceOnCacheResult`
`private CapabilityDispatcher`	`capabilities`
`private NBTTagCompound`	`capNBT`
`static java.text.DecimalFormat`	`DECIMALFORMAT`
`private IRegistryDelegate<Item>`	`delegate`
`static ItemStack`	`EMPTY`
`private boolean`	`isEmpty`
`private Item`	`item`
`(package private) int`	`itemDamage`
`private EntityItemFrame`	`itemFrame`
`private int`	`stackSize`
`private NBTTagCompound`	`stackTagCompound`

Constructor Summary

Constructors
Constructor and Description
`ItemStack(Block blockIn)`
`ItemStack(Block blockIn, int amount)`
`ItemStack(Block blockIn, int amount, int meta)`
`ItemStack(Item itemIn)`
`ItemStack(Item itemIn, int amount)`
`ItemStack(Item itemIn, int amount, int meta)`
`ItemStack(Item itemIn, int amount, int meta, NBTTagCompound capNBT)`
`ItemStack(NBTTagCompound compound)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addAttributeModifier(java.lang.String attributeName, AttributeModifier modifier, EntityEquipmentSlot equipmentSlot)`
`void`	`addEnchantment(Enchantment ench, int level)`
`boolean`	`areCapsCompatible(ItemStack other)`
`static boolean`	`areItemsEqual(ItemStack stackA, ItemStack stackB)`
`static boolean`	`areItemsEqualIgnoreDurability(ItemStack stackA, ItemStack stackB)`
`static boolean`	`areItemStacksEqual(ItemStack stackA, ItemStack stackB)`
`static boolean`	`areItemStacksEqualUsingNBTShareTag(ItemStack stackA, ItemStack stackB)` Modeled after ItemStack.areItemStacksEqual Uses Item.getNBTShareTag for comparison instead of NBT and capabilities.
`static boolean`	`areItemStackShareTagsEqual(ItemStack stackA, ItemStack stackB)` Modeled after ItemStack.areItemStackTagsEqual Uses Item.getNBTShareTag for comparison instead of NBT and capabilities.
`static boolean`	`areItemStackTagsEqual(ItemStack stackA, ItemStack stackB)`
`boolean`	`attemptDamageItem(int amount, java.util.Random rand, EntityPlayerMP damager)`
`boolean`	`canDestroy(Block blockIn)`
`boolean`	`canEditBlocks()`
`boolean`	`canHarvestBlock(IBlockState blockIn)`
`boolean`	`canPlaceOn(Block blockIn)`
`void`	`clearCustomName()`
`ItemStack`	`copy()`
`void`	`damageItem(int amount, EntityLivingBase entityIn)`
`void`	`deserializeNBT(NBTTagCompound nbt)`
`boolean`	`doesSneakBypassUse(IBlockAccess world, BlockPos pos, EntityPlayer player)` Should this item, when held, allow sneak-clicks to pass through to the underlying block?
`private void`	`forgeInit()` Set up forge's ItemStack additions.
`int`	`getAnimationsToGo()`
`com.google.common.collect.Multimap<java.lang.String,AttributeModifier>`	`getAttributeModifiers(EntityEquipmentSlot equipmentSlot)`
`<T> T`	`getCapability(Capability<T> capability, EnumFacing facing)` Retrieves the handler for the capability requested on the specific side.
`int`	`getCount()`
`float`	`getDestroySpeed(IBlockState blockIn)`
`java.lang.String`	`getDisplayName()`
`NBTTagList`	`getEnchantmentTagList()`
`boolean`	`getHasSubtypes()`
`Item`	`getItem()`
`int`	`getItemDamage()`
`EntityItemFrame`	`getItemFrame()`
`private Item`	`getItemRaw()` Internal call to get the actual item, not the delegate.
`EnumAction`	`getItemUseAction()`
`int`	`getMaxDamage()`
`int`	`getMaxItemUseDuration()`
`int`	`getMaxStackSize()`
`int`	`getMetadata()`
`NBTTagCompound`	`getOrCreateSubCompound(java.lang.String key)`
`EnumRarity`	`getRarity()` Deprecated.
`int`	`getRepairCost()`
`NBTTagCompound`	`getSubCompound(java.lang.String key)`
`NBTTagCompound`	`getTagCompound()`
`ITextComponent`	`getTextComponent()`
`java.util.List<java.lang.String>`	`getTooltip(EntityPlayer playerIn, ITooltipFlag advanced)`
`java.lang.String`	`getUnlocalizedName()`
`void`	`grow(int quantity)`
`boolean`	`hasCapability(Capability<?> capability, EnumFacing facing)` Determines if this object has support for the capability in question on the specific side.
`boolean`	`hasDisplayName()`
`boolean`	`hasEffect()`
`boolean`	`hasTagCompound()`
`void`	`hitEntity(EntityLivingBase entityIn, EntityPlayer playerIn)`
`boolean`	`interactWithEntity(EntityPlayer playerIn, EntityLivingBase entityIn, EnumHand hand)`
`boolean`	`isEmpty()`
`boolean`	`isItemDamaged()`
`boolean`	`isItemEnchantable()`
`boolean`	`isItemEnchanted()`
`boolean`	`isItemEqual(ItemStack other)`
`boolean`	`isItemEqualIgnoreDurability(ItemStack stack)`
`boolean`	`isItemStackDamageable()`
`private boolean`	`isItemStackEqual(ItemStack other)`
`private boolean`	`isItemStackEqualUsingNBTShareTag(ItemStack other)` Modeled after ItemStack.isItemStackEqual Uses Item.getNBTShareTag for comparison instead of NBT and capabilities.
`boolean`	`isOnItemFrame()`
`boolean`	`isStackable()`
`void`	`onBlockDestroyed(World worldIn, IBlockState blockIn, BlockPos pos, EntityPlayer playerIn)`
`void`	`onCrafting(World worldIn, EntityPlayer playerIn, int amount)`
`EnumActionResult`	`onItemUse(EntityPlayer playerIn, World worldIn, BlockPos pos, EnumHand hand, EnumFacing side, float hitX, float hitY, float hitZ)`
`ItemStack`	`onItemUseFinish(World worldIn, EntityLivingBase entityLiving)`
`EnumActionResult`	`onItemUseFirst(EntityPlayer playerIn, World worldIn, BlockPos pos, EnumHand hand, EnumFacing side, float hitX, float hitY, float hitZ)`
`void`	`onPlayerStoppedUsing(World worldIn, EntityLivingBase entityLiving, int timeLeft)`
`static void`	`registerFixes(DataFixer fixer)`
`void`	`removeSubCompound(java.lang.String key)`
`NBTTagCompound`	`serializeNBT()`
`void`	`setAnimationsToGo(int animations)`
`void`	`setCount(int size)`
`void`	`setItemDamage(int meta)`
`void`	`setItemFrame(EntityItemFrame frame)`
`void`	`setRepairCost(int cost)`
`ItemStack`	`setStackDisplayName(java.lang.String displayName)`
`void`	`setTagCompound(NBTTagCompound nbt)`
`void`	`setTagInfo(java.lang.String key, NBTBase value)`
`ItemStack`	`setTranslatableName(java.lang.String p_190924_1_)`
`void`	`shrink(int quantity)`
`ItemStack`	`splitStack(int amount)`
`java.lang.String`	`toString()`
`void`	`updateAnimation(World worldIn, Entity entityIn, int inventorySlot, boolean isCurrentItem)`
`private void`	`updateEmptyState()`
`ActionResult<ItemStack>`	`useItemRightClick(World worldIn, EntityPlayer playerIn, EnumHand hand)`
`NBTTagCompound`	`writeToNBT(NBTTagCompound nbt)`

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

Field Detail

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

DECIMALFORMAT

public static final java.text.DecimalFormat DECIMALFORMAT

stackSize
```
private int stackSize
```

animationsToGo
```
private int animationsToGo
```

item
```
private final Item item
```

stackTagCompound

private NBTTagCompound stackTagCompound

isEmpty
```
private boolean isEmpty
```

itemDamage
```
int itemDamage
```

itemFrame
```
private EntityItemFrame itemFrame
```

canDestroyCacheBlock
```
private Block canDestroyCacheBlock
```

canDestroyCacheResult
```
private boolean canDestroyCacheResult
```

canPlaceOnCacheBlock
```
private Block canPlaceOnCacheBlock
```

canPlaceOnCacheResult
```
private boolean canPlaceOnCacheResult
```

delegate

private IRegistryDelegate<Item> delegate

capabilities

private CapabilityDispatcher capabilities

capNBT
```
private NBTTagCompound capNBT
```

Constructor Detail

ItemStack
```
public ItemStack(Block blockIn)
```

ItemStack

public ItemStack(Block blockIn,
                 int amount)

ItemStack

public ItemStack(Block blockIn,
                 int amount,
                 int meta)

ItemStack
```
public ItemStack(Item itemIn)
```

ItemStack

public ItemStack(Item itemIn,
                 int amount)

ItemStack

public ItemStack(Item itemIn,
                 int amount,
                 int meta)

ItemStack

public ItemStack(Item itemIn,
                 int amount,
                 int meta,
                 @Nullable
                 NBTTagCompound capNBT)

ItemStack

public ItemStack(NBTTagCompound compound)

Method Detail

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

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

registerFixes

public static void registerFixes(DataFixer fixer)

splitStack

public ItemStack splitStack(int amount)

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

onItemUse

public EnumActionResult onItemUse(EntityPlayer playerIn,
                                  World worldIn,
                                  BlockPos pos,
                                  EnumHand hand,
                                  EnumFacing side,
                                  float hitX,
                                  float hitY,
                                  float hitZ)

onItemUseFirst

public EnumActionResult onItemUseFirst(EntityPlayer playerIn,
                                       World worldIn,
                                       BlockPos pos,
                                       EnumHand hand,
                                       EnumFacing side,
                                       float hitX,
                                       float hitY,
                                       float hitZ)

getDestroySpeed

public float getDestroySpeed(IBlockState blockIn)

useItemRightClick

public ActionResult<ItemStack> useItemRightClick(World worldIn,
                                                 EntityPlayer playerIn,
                                                 EnumHand hand)

onItemUseFinish

public ItemStack onItemUseFinish(World worldIn,
                                 EntityLivingBase entityLiving)

writeToNBT

public NBTTagCompound writeToNBT(NBTTagCompound nbt)

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

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

isItemStackDamageable

public boolean isItemStackDamageable()

getHasSubtypes
```
public boolean getHasSubtypes()
```

isItemDamaged
```
public boolean isItemDamaged()
```

getItemDamage
```
public int getItemDamage()
```

getMetadata
```
public int getMetadata()
```

setItemDamage
```
public void setItemDamage(int meta)
```

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

attemptDamageItem

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

damageItem

public void damageItem(int amount,
                       EntityLivingBase entityIn)

hitEntity

public void hitEntity(EntityLivingBase entityIn,
                      EntityPlayer playerIn)

onBlockDestroyed

public void onBlockDestroyed(World worldIn,
                             IBlockState blockIn,
                             BlockPos pos,
                             EntityPlayer playerIn)

canHarvestBlock

public boolean canHarvestBlock(IBlockState blockIn)

interactWithEntity

public boolean interactWithEntity(EntityPlayer playerIn,
                                  EntityLivingBase entityIn,
                                  EnumHand 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)

getUnlocalizedName

public java.lang.String getUnlocalizedName()

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

toString in class java.lang.Object

updateAnimation

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

onCrafting

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

getMaxItemUseDuration
```
public int getMaxItemUseDuration()
```

getItemUseAction
```
public EnumAction getItemUseAction()
```

onPlayerStoppedUsing

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

hasTagCompound
```
public boolean hasTagCompound()
```

getTagCompound

@Nullable
public NBTTagCompound getTagCompound()

getOrCreateSubCompound

public NBTTagCompound getOrCreateSubCompound(java.lang.String key)

getSubCompound

@Nullable
public NBTTagCompound getSubCompound(java.lang.String key)

removeSubCompound

public void removeSubCompound(java.lang.String key)

getEnchantmentTagList

public NBTTagList getEnchantmentTagList()

setTagCompound

public void setTagCompound(@Nullable
                           NBTTagCompound nbt)

getDisplayName

public java.lang.String getDisplayName()

setTranslatableName

public ItemStack setTranslatableName(java.lang.String p_190924_1_)

setStackDisplayName

public ItemStack setStackDisplayName(java.lang.String displayName)

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

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

getTooltip

public java.util.List<java.lang.String> getTooltip(@Nullable
                                                   EntityPlayer playerIn,
                                                   ITooltipFlag advanced)

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

getRarity

@Deprecated
public EnumRarity getRarity()

Deprecated.

isItemEnchantable
```
public boolean isItemEnchantable()
```

addEnchantment

public void addEnchantment(Enchantment ench,
                           int level)

isItemEnchanted
```
public boolean isItemEnchanted()
```

setTagInfo

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

canEditBlocks
```
public boolean canEditBlocks()
```

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

setItemFrame

public void setItemFrame(EntityItemFrame frame)

getItemFrame

@Nullable
public EntityItemFrame getItemFrame()

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

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

getAttributeModifiers

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

addAttributeModifier

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

getTextComponent

public ITextComponent getTextComponent()

canDestroy

public boolean canDestroy(Block blockIn)

canPlaceOn

public boolean canPlaceOn(Block blockIn)

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

setAnimationsToGo

public void setAnimationsToGo(int animations)

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

setCount
```
public void setCount(int size)
```

grow
```
public void grow(int quantity)
```

shrink
```
public void shrink(int quantity)
```

hasCapability
```
public boolean hasCapability(Capability<?> capability,
                             @Nullable
                             EnumFacing facing)
```
Description copied from interface: ICapabilityProvider

Determines if this object has support for the capability in question on the specific side. The return value of this MIGHT change during runtime if this object gains or loses support for a capability. It is not required to call this function before calling ICapabilityProvider.getCapability(Capability, EnumFacing).
Basically, this method functions analogously to Map.containsKey(Object).
Example: A Pipe getting a cover placed on one side causing it lose the Inventory attachment function for that side.
This is a light weight version of getCapability, intended for metadata uses.

Specified by:

hasCapability in interface ICapabilityProvider

Parameters:

capability - The capability to check

facing - The Side to check from: CAN BE NULL. Null is defined to represent 'internal' or 'self'

Returns:

True if this object supports the capability. If true, then ICapabilityProvider.getCapability(Capability, EnumFacing) must not return null.

getCapability
```
@Nullable
public <T> T getCapability(Capability<T> capability,
                                     @Nullable
                                     EnumFacing facing)
```
Description copied from interface: ICapabilityProvider
Retrieves the handler for the capability requested on the specific side.
- The return value CAN be null if the object does not support the capability.
- The return value CAN be the same for multiple faces.
Basically, this method functions analogously to Map.get(Object).
Specified by:

getCapability in interface ICapabilityProvider

Parameters:

capability - The capability to check

facing - The Side to check from, CAN BE NULL. Null is defined to represent 'internal' or 'self'

Returns:

The requested capability. Must NOT be null when ICapabilityProvider.hasCapability(Capability, EnumFacing) would return true.

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

deserializeNBT in interface INBTSerializable<NBTTagCompound>

serializeNBT
```
public NBTTagCompound serializeNBT()
```
Specified by:

serializeNBT in interface INBTSerializable<NBTTagCompound>

areCapsCompatible

public boolean areCapsCompatible(ItemStack other)

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.

areItemStacksEqualUsingNBTShareTag
```
public static boolean areItemStacksEqualUsingNBTShareTag(ItemStack stackA,
                                                         ItemStack stackB)
```
Modeled after ItemStack.areItemStacksEqual Uses Item.getNBTShareTag for comparison instead of NBT and capabilities. Only used for comparing itemStacks that were transferred from server to client using Item.getNBTShareTag.

isItemStackEqualUsingNBTShareTag
```
private boolean isItemStackEqualUsingNBTShareTag(ItemStack other)
```
Modeled after ItemStack.isItemStackEqual Uses Item.getNBTShareTag for comparison instead of NBT and capabilities. Only used for comparing itemStacks that were transferred from server to client using Item.getNBTShareTag.

areItemStackShareTagsEqual
```
public static boolean areItemStackShareTagsEqual(ItemStack stackA,
                                                 ItemStack stackB)
```
Modeled after ItemStack.areItemStackTagsEqual Uses Item.getNBTShareTag for comparison instead of NBT and capabilities. Only used for comparing itemStacks that were transferred from server to client using Item.getNBTShareTag.

doesSneakBypassUse

public boolean doesSneakBypassUse(IBlockAccess world,
                                  BlockPos pos,
                                  EntityPlayer player)

Should this item, when held, allow sneak-clicks to pass through to the underlying block?

Parameters:: world - The world; pos - Block position in world; player - The Player that is wielding the item
Returns:

Class ItemStack

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EMPTY

DECIMALFORMAT

stackSize

animationsToGo

item

stackTagCompound

isEmpty

itemDamage

itemFrame

canDestroyCacheBlock

canDestroyCacheResult

canPlaceOnCacheBlock

canPlaceOnCacheResult

delegate

capabilities

capNBT

Constructor Detail

ItemStack

ItemStack

ItemStack

ItemStack

ItemStack

ItemStack

ItemStack

ItemStack

Method Detail

updateEmptyState

isEmpty

registerFixes

splitStack

getItem

onItemUse

onItemUseFirst

getDestroySpeed

useItemRightClick

onItemUseFinish

writeToNBT

getMaxStackSize

isStackable

isItemStackDamageable

getHasSubtypes

isItemDamaged

getItemDamage

getMetadata

setItemDamage

getMaxDamage

attemptDamageItem

damageItem

hitEntity

onBlockDestroyed

canHarvestBlock

interactWithEntity

copy

areItemStackTagsEqual

areItemStacksEqual

isItemStackEqual

areItemsEqual

areItemsEqualIgnoreDurability

isItemEqual

isItemEqualIgnoreDurability

getUnlocalizedName

toString

updateAnimation

onCrafting

getMaxItemUseDuration

getItemUseAction

onPlayerStoppedUsing

hasTagCompound

getTagCompound

getOrCreateSubCompound

getSubCompound

removeSubCompound

getEnchantmentTagList

setTagCompound