ItemStack (Forge API)

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

public final class ItemStack
extends java.lang.Object

Field Summary

Fields
Modifier and Type	Field and Description
`int`	`animationsToGo` Number of animation frames to go when receiving an item (by walking into it, for example).
`static java.text.DecimalFormat`	`field_111284_a`
`int`	`stackSize` Size of the stack.
`NBTTagCompound`	`stackTagCompound` A NBTTagMap containing data about an ItemStack.

Constructor Summary

Constructors
Constructor and Description
`ItemStack(Block p_i1876_1_)`
`ItemStack(Block p_i1877_1_, int p_i1877_2_)`
`ItemStack(Block p_i1878_1_, int p_i1878_2_, int p_i1878_3_)`
`ItemStack(Item p_i1879_1_)`
`ItemStack(Item p_i1880_1_, int p_i1880_2_)`
`ItemStack(Item p_i1881_1_, int p_i1881_2_, int p_i1881_3_)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addEnchantment(Enchantment p_77966_1_, int p_77966_2_)` Adds an enchantment with a desired level on the ItemStack.
`static boolean`	`areItemStacksEqual(ItemStack p_77989_0_, ItemStack p_77989_1_)` compares ItemStack argument1 with ItemStack argument2; returns true if both ItemStacks are equal
`static boolean`	`areItemStackTagsEqual(ItemStack p_77970_0_, ItemStack p_77970_1_)`
`boolean`	`attemptDamageItem(int p_96631_1_, java.util.Random p_96631_2_)` Attempts to damage the ItemStack with par1 amount of damage, If the ItemStack has the Unbreaking enchantment there is a chance for each point of damage to be negated.
`boolean`	`canEditBlocks()`
`ItemStack`	`copy()` Returns a new stack with the same properties.
`static ItemStack`	`copyItemStack(ItemStack p_77944_0_)` Creates a copy of a ItemStack, a null parameters will return a null.
`void`	`damageItem(int p_77972_1_, EntityLivingBase p_77972_2_)` Damages the item in the ItemStack
`void`	`func_135074_t()`
`void`	`func_150996_a(Item p_150996_1_)`
`float`	`func_150997_a(Block p_150997_1_)`
`boolean`	`func_150998_b(Block p_150998_1_)`
`void`	`func_150999_a(World p_150999_1_, Block p_150999_2_, int p_150999_3_, int p_150999_4_, int p_150999_5_, EntityPlayer p_150999_6_)`
`IChatComponent`	`func_151000_E()`
`com.google.common.collect.Multimap`	`getAttributeModifiers()` Gets the attribute modifiers for this ItemStack.
`java.lang.String`	`getDisplayName()` returns the display name of the itemstack
`NBTTagList`	`getEnchantmentTagList()`
`boolean`	`getHasSubtypes()`
`IIcon`	`getIconIndex()` Returns the icon index of the current stack.
`Item`	`getItem()` Returns the object corresponding to the stack.
`int`	`getItemDamage()` gets the damage of an itemstack
`int`	`getItemDamageForDisplay()` gets the damage of an itemstack, for displaying purposes
`EntityItemFrame`	`getItemFrame()` Return the item frame this stack is on.
`int`	`getItemSpriteNumber()`
`EnumAction`	`getItemUseAction()`
`int`	`getMaxDamage()` Returns the max damage an item in the stack can take.
`int`	`getMaxItemUseDuration()`
`int`	`getMaxStackSize()` Returns maximum size of the stack.
`EnumRarity`	`getRarity()`
`int`	`getRepairCost()` Get this stack's repair cost, or 0 if no repair cost is defined.
`NBTTagCompound`	`getTagCompound()` Returns the NBTTagCompound of the ItemStack.
`java.util.List`	`getTooltip(EntityPlayer p_82840_1_, boolean p_82840_2_)` Return a list of strings containing information about the item
`java.lang.String`	`getUnlocalizedName()`
`boolean`	`hasDisplayName()` Returns true if the itemstack has a display name
`boolean`	`hasEffect()` Deprecated.
`boolean`	`hasEffect(int pass)`
`boolean`	`hasTagCompound()` Returns true if the ItemStack has an NBTTagCompound.
`void`	`hitEntity(EntityLivingBase p_77961_1_, EntityPlayer p_77961_2_)` Calls the corresponding fct in di
`boolean`	`interactWithEntity(EntityPlayer p_111282_1_, EntityLivingBase p_111282_2_)`
`boolean`	`isItemDamaged()` returns true when a damageable item is damaged
`boolean`	`isItemEnchantable()` True if it is a tool and has no enchantments to begin with
`boolean`	`isItemEnchanted()` True if the item has enchantment data
`boolean`	`isItemEqual(ItemStack p_77969_1_)` compares ItemStack argument to the instance ItemStack; returns true if the Items contained in both ItemStacks are equal
`boolean`	`isItemStackDamageable()` true if this itemStack is damageable
`boolean`	`isOnItemFrame()` Return whether this stack is on an item frame.
`boolean`	`isStackable()` Returns true if the ItemStack can hold 2 or more units of the item.
`static ItemStack`	`loadItemStackFromNBT(NBTTagCompound p_77949_0_)`
`void`	`onCrafting(World p_77980_1_, EntityPlayer p_77980_2_, int p_77980_3_)`
`ItemStack`	`onFoodEaten(World p_77950_1_, EntityPlayer p_77950_2_)`
`void`	`onPlayerStoppedUsing(World p_77974_1_, EntityPlayer p_77974_2_, int p_77974_3_)` Called when the player releases the use item button.
`void`	`readFromNBT(NBTTagCompound p_77963_1_)` Read the stack fields from a NBT object.
`void`	`setItemDamage(int p_77964_1_)` Sets the item damage of the ItemStack.
`void`	`setItemFrame(EntityItemFrame p_82842_1_)` Set the item frame this stack is on.
`void`	`setRepairCost(int p_82841_1_)` Set this stack's repair cost.
`ItemStack`	`setStackDisplayName(java.lang.String p_151001_1_)`
`void`	`setTagCompound(NBTTagCompound p_77982_1_)` Assigns a NBTTagCompound to the ItemStack, minecraft validates that only non-stackable items can have it.
`void`	`setTagInfo(java.lang.String p_77983_1_, NBTBase p_77983_2_)`
`ItemStack`	`splitStack(int p_77979_1_)` Remove the argument from the stack size.
`java.lang.String`	`toString()`
`boolean`	`tryPlaceItemIntoWorld(EntityPlayer p_77943_1_, World p_77943_2_, int p_77943_3_, int p_77943_4_, int p_77943_5_, int p_77943_6_, float p_77943_7_, float p_77943_8_, float p_77943_9_)`
`void`	`updateAnimation(World p_77945_1_, Entity p_77945_2_, int p_77945_3_, boolean p_77945_4_)` Called each tick as long the ItemStack in on player inventory.
`ItemStack`	`useItemRightClick(World p_77957_1_, EntityPlayer p_77957_2_)` Called whenever this item stack is equipped and right clicked.
`NBTTagCompound`	`writeToNBT(NBTTagCompound p_77955_1_)` Write the stack fields to a NBT object.

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

Field Detail
- field_111284_a
```
public static final java.text.DecimalFormat field_111284_a
```
- stackSize
```
public int stackSize
```
  Size of the stack.
- animationsToGo
```
public int animationsToGo
```
  Number of animation frames to go when receiving an item (by walking into it, for example).
- stackTagCompound
```
public NBTTagCompound stackTagCompound
```
  A NBTTagMap containing data about an ItemStack. Can only be used for non stackable items

Constructor Detail

ItemStack
```
public ItemStack(Block p_i1876_1_)
```

ItemStack

public ItemStack(Block p_i1877_1_,
                 int p_i1877_2_)

ItemStack

public ItemStack(Block p_i1878_1_,
                 int p_i1878_2_,
                 int p_i1878_3_)

ItemStack
```
public ItemStack(Item p_i1879_1_)
```

ItemStack

public ItemStack(Item p_i1880_1_,
                 int p_i1880_2_)

ItemStack

public ItemStack(Item p_i1881_1_,
                 int p_i1881_2_,
                 int p_i1881_3_)

Method Detail

loadItemStackFromNBT

public static ItemStack loadItemStackFromNBT(NBTTagCompound p_77949_0_)

splitStack
```
public ItemStack splitStack(int p_77979_1_)
```
Remove the argument from the stack size. Return a new stack object with argument size.

getItem
```
public Item getItem()
```
Returns the object corresponding to the stack.

getIconIndex
```
public IIcon getIconIndex()
```
Returns the icon index of the current stack.

getItemSpriteNumber
```
public int getItemSpriteNumber()
```

tryPlaceItemIntoWorld

public boolean tryPlaceItemIntoWorld(EntityPlayer p_77943_1_,
                                     World p_77943_2_,
                                     int p_77943_3_,
                                     int p_77943_4_,
                                     int p_77943_5_,
                                     int p_77943_6_,
                                     float p_77943_7_,
                                     float p_77943_8_,
                                     float p_77943_9_)

func_150997_a

public float func_150997_a(Block p_150997_1_)

useItemRightClick
```
public ItemStack useItemRightClick(World p_77957_1_,
                                   EntityPlayer p_77957_2_)
```
Called whenever this item stack is equipped and right clicked. Returns the new item stack to put in the position where this item is. Args: world, player

onFoodEaten

public ItemStack onFoodEaten(World p_77950_1_,
                             EntityPlayer p_77950_2_)

writeToNBT
```
public NBTTagCompound writeToNBT(NBTTagCompound p_77955_1_)
```
Write the stack fields to a NBT object. Return the new NBT object.

readFromNBT

public void readFromNBT(NBTTagCompound p_77963_1_)

Read the stack fields from a NBT object.

getMaxStackSize
```
public int getMaxStackSize()
```
Returns maximum size of the stack.

isStackable
```
public boolean isStackable()
```
Returns true if the ItemStack can hold 2 or more units of the item.

isItemStackDamageable
```
public boolean isItemStackDamageable()
```
true if this itemStack is damageable

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

isItemDamaged
```
public boolean isItemDamaged()
```
returns true when a damageable item is damaged

getItemDamageForDisplay
```
public int getItemDamageForDisplay()
```
gets the damage of an itemstack, for displaying purposes

getItemDamage
```
public int getItemDamage()
```
gets the damage of an itemstack

setItemDamage
```
public void setItemDamage(int p_77964_1_)
```
Sets the item damage of the ItemStack.

getMaxDamage
```
public int getMaxDamage()
```
Returns the max damage an item in the stack can take.

attemptDamageItem
```
public boolean attemptDamageItem(int p_96631_1_,
                                 java.util.Random p_96631_2_)
```
Attempts to damage the ItemStack with par1 amount of damage, If the ItemStack has the Unbreaking enchantment there is a chance for each point of damage to be negated. Returns true if it takes more damage than getMaxDamage(). Returns false otherwise or if the ItemStack can't be damaged or if all points of damage are negated.

damageItem

public void damageItem(int p_77972_1_,
                       EntityLivingBase p_77972_2_)

Damages the item in the ItemStack

hitEntity

public void hitEntity(EntityLivingBase p_77961_1_,
                      EntityPlayer p_77961_2_)

Calls the corresponding fct in di

func_150999_a

public void func_150999_a(World p_150999_1_,
                          Block p_150999_2_,
                          int p_150999_3_,
                          int p_150999_4_,
                          int p_150999_5_,
                          EntityPlayer p_150999_6_)

func_150998_b

public boolean func_150998_b(Block p_150998_1_)

interactWithEntity

public boolean interactWithEntity(EntityPlayer p_111282_1_,
                                  EntityLivingBase p_111282_2_)

copy
```
public ItemStack copy()
```
Returns a new stack with the same properties.

areItemStackTagsEqual

public static boolean areItemStackTagsEqual(ItemStack p_77970_0_,
                                            ItemStack p_77970_1_)

areItemStacksEqual

public static boolean areItemStacksEqual(ItemStack p_77989_0_,
                                         ItemStack p_77989_1_)

compares ItemStack argument1 with ItemStack argument2; returns true if both ItemStacks are equal

isItemEqual
```
public boolean isItemEqual(ItemStack p_77969_1_)
```
compares ItemStack argument to the instance ItemStack; returns true if the Items contained in both ItemStacks are equal

getUnlocalizedName

public java.lang.String getUnlocalizedName()

copyItemStack
```
public static ItemStack copyItemStack(ItemStack p_77944_0_)
```
Creates a copy of a ItemStack, a null parameters will return a null.

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

toString in class java.lang.Object

updateAnimation

public void updateAnimation(World p_77945_1_,
                            Entity p_77945_2_,
                            int p_77945_3_,
                            boolean p_77945_4_)

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

onCrafting

public void onCrafting(World p_77980_1_,
                       EntityPlayer p_77980_2_,
                       int p_77980_3_)

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

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

onPlayerStoppedUsing

public void onPlayerStoppedUsing(World p_77974_1_,
                                 EntityPlayer p_77974_2_,
                                 int p_77974_3_)

Called when the player releases the use item button. Args: world, entityplayer, itemInUseCount

hasTagCompound
```
public boolean hasTagCompound()
```
Returns true if the ItemStack has an NBTTagCompound. Currently used to store enchantments.

getTagCompound
```
public NBTTagCompound getTagCompound()
```
Returns the NBTTagCompound of the ItemStack.

getEnchantmentTagList

public NBTTagList getEnchantmentTagList()

setTagCompound
```
public void setTagCompound(NBTTagCompound p_77982_1_)
```
Assigns a NBTTagCompound to the ItemStack, minecraft validates that only non-stackable items can have it.

getDisplayName
```
public java.lang.String getDisplayName()
```
returns the display name of the itemstack

setStackDisplayName

public ItemStack setStackDisplayName(java.lang.String p_151001_1_)

func_135074_t
```
public void func_135074_t()
```

hasDisplayName
```
public boolean hasDisplayName()
```
Returns true if the itemstack has a display name

getTooltip

public java.util.List getTooltip(EntityPlayer p_82840_1_,
                                 boolean p_82840_2_)

Return a list of strings containing information about the item

hasEffect

@Deprecated
public boolean hasEffect()

Deprecated.

hasEffect
```
public boolean hasEffect(int pass)
```

getRarity
```
public EnumRarity getRarity()
```

isItemEnchantable
```
public boolean isItemEnchantable()
```
True if it is a tool and has no enchantments to begin with

addEnchantment

public void addEnchantment(Enchantment p_77966_1_,
                           int p_77966_2_)

Adds an enchantment with a desired level on the ItemStack.

isItemEnchanted
```
public boolean isItemEnchanted()
```
True if the item has enchantment data

setTagInfo

public void setTagInfo(java.lang.String p_77983_1_,
                       NBTBase p_77983_2_)

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

isOnItemFrame
```
public boolean isOnItemFrame()
```
Return whether this stack is on an item frame.

setItemFrame

public void setItemFrame(EntityItemFrame p_82842_1_)

Set the item frame this stack is on.

getItemFrame
```
public EntityItemFrame getItemFrame()
```
Return the item frame this stack is on. Returns null if not on an item frame.

getRepairCost
```
public int getRepairCost()
```
Get this stack's repair cost, or 0 if no repair cost is defined.

setRepairCost

public void setRepairCost(int p_82841_1_)

Set this stack's repair cost.

getAttributeModifiers
```
public com.google.common.collect.Multimap getAttributeModifiers()
```
Gets the attribute modifiers for this ItemStack. Will check for an NBT tag list containing modifiers for the stack.

func_150996_a

public void func_150996_a(Item p_150996_1_)

func_151000_E
```
public IChatComponent func_151000_E()
```

Class ItemStack

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

field_111284_a

stackSize

animationsToGo

stackTagCompound

Constructor Detail

ItemStack

ItemStack

ItemStack

ItemStack

ItemStack

ItemStack

Method Detail

loadItemStackFromNBT

splitStack

getItem

getIconIndex

getItemSpriteNumber

tryPlaceItemIntoWorld

func_150997_a

useItemRightClick

onFoodEaten

writeToNBT

readFromNBT

getMaxStackSize

isStackable

isItemStackDamageable

getHasSubtypes

isItemDamaged

getItemDamageForDisplay

getItemDamage

setItemDamage

getMaxDamage

attemptDamageItem

damageItem

hitEntity

func_150999_a

func_150998_b

interactWithEntity

copy

areItemStackTagsEqual

areItemStacksEqual

isItemEqual

getUnlocalizedName

copyItemStack

toString

updateAnimation

onCrafting

getMaxItemUseDuration

getItemUseAction

onPlayerStoppedUsing

hasTagCompound

getTagCompound

getEnchantmentTagList

setTagCompound

getDisplayName

setStackDisplayName

func_135074_t

hasDisplayName

getTooltip

hasEffect

hasEffect

getRarity

isItemEnchantable

addEnchantment

isItemEnchanted

setTagInfo

canEditBlocks

isOnItemFrame

setItemFrame

getItemFrame

getRepairCost

setRepairCost

getAttributeModifiers

func_150996_a