ItemStack (Forge 1.11.2 API v13.20.1.2386 mappings snapshot

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

static java.text.DecimalFormat DECIMALFORMAT

static ItemStack EMPTY

Fields
Modifier and Type	Field and Description
`static java.text.DecimalFormat`	`DECIMALFORMAT`
`static ItemStack`	`EMPTY`

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
Modifier and Type	Method and Description
`void`	`addAttributeModifier(java.lang.String attributeName, AttributeModifier modifier, EntityEquipmentSlot equipmentSlot)`
`void`	`addEnchantment(Enchantment ench, int level)` Adds an enchantment with a desired level on the ItemStack.
`boolean`	`areCapsCompatible(ItemStack other)`
`static boolean`	`areItemsEqual(ItemStack stackA, ItemStack stackB)` Compares Item and damage value of the two stacks
`static boolean`	`areItemsEqualIgnoreDurability(ItemStack stackA, ItemStack stackB)`
`static boolean`	`areItemStacksEqual(ItemStack stackA, ItemStack stackB)` compares ItemStack argument1 with ItemStack argument2; returns true if both ItemStacks are equal
`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)` 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`	`canDestroy(Block blockIn)`
`boolean`	`canEditBlocks()`
`boolean`	`canHarvestBlock(IBlockState blockIn)` Check whether the given Block can be harvested using this ItemStack.
`boolean`	`canPlaceOn(Block blockIn)`
`void`	`clearCustomName()` Clear any custom name set for this ItemStack
`ItemStack`	`copy()` Returns a new stack with the same properties.
`void`	`damageItem(int amount, EntityLivingBase entityIn)` Damages the item in the ItemStack
`void`	`deserializeNBT(NBTTagCompound nbt)`
`int`	`getAnimationsToGo()`
`<any>`	`getAttributeModifiers(EntityEquipmentSlot equipmentSlot)` Gets the attribute modifiers for this ItemStack.
`<T> T`	`getCapability(Capability<T> capability, EnumFacing facing)` Retrieves the handler for the capability requested on the specific side.
`int`	`getCount()`
`java.lang.String`	`getDisplayName()` returns the display name of the itemstack
`NBTTagList`	`getEnchantmentTagList()`
`boolean`	`getHasSubtypes()`
`Item`	`getItem()` Returns the object corresponding to the stack.
`int`	`getItemDamage()`
`EntityItemFrame`	`getItemFrame()` Return the item frame this stack is on.
`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.
`int`	`getMetadata()`
`NBTTagCompound`	`getOrCreateSubCompound(java.lang.String key)`
`EnumRarity`	`getRarity()`
`int`	`getRepairCost()` Get this stack's repair cost, or 0 if no repair cost is defined.
`float`	`getStrVsBlock(IBlockState blockIn)`
`NBTTagCompound`	`getSubCompound(java.lang.String key)` Get an NBTTagCompound from this stack's NBT data.
`NBTTagCompound`	`getTagCompound()` Returns the NBTTagCompound of the ItemStack.
`ITextComponent`	`getTextComponent()` Get a ChatComponent for this Item's display name that shows this Item on hover
`java.util.List<java.lang.String>`	`getTooltip(EntityPlayer playerIn, boolean advanced)` Return a list of strings containing information about the item
`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()` Returns true if the itemstack has a display name
`boolean`	`hasEffect()`
`boolean`	`hasTagCompound()` Returns true if the ItemStack has an NBTTagCompound.
`void`	`hitEntity(EntityLivingBase entityIn, EntityPlayer playerIn)` Calls the delegated method to the Item to damage the incoming Entity, and if necessary, triggers a stats increase.
`boolean`	`interactWithEntity(EntityPlayer playerIn, EntityLivingBase entityIn, EnumHand hand)`
`boolean`	`isEmpty()`
`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 other)` compares ItemStack argument to the instance ItemStack; returns true if the Items contained in both ItemStacks are equal
`boolean`	`isItemEqualIgnoreDurability(ItemStack stack)`
`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.
`void`	`onBlockDestroyed(World worldIn, IBlockState blockIn, BlockPos pos, EntityPlayer playerIn)` Called when a Block is destroyed using this ItemStack
`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)` Called when the player uses this ItemStack on a Block (right-click).
`ItemStack`	`onItemUseFinish(World worldIn, EntityLivingBase entityLiving)` Called when the item in use count reach 0, e.g.
`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)` Called when the player releases the use item button.
`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)` Set the item frame this stack is on.
`void`	`setRepairCost(int cost)` Set this stack's repair cost.
`ItemStack`	`setStackDisplayName(java.lang.String displayName)`
`void`	`setTagCompound(NBTTagCompound nbt)` Assigns a NBTTagCompound to the ItemStack, minecraft validates that only non-stackable items can have it.
`void`	`setTagInfo(java.lang.String key, NBTBase value)`
`ItemStack`	`setTranslatableName(java.lang.String p_190924_1_)`
`void`	`shrink(int quantity)`
`ItemStack`	`splitStack(int amount)` Splits off a stack of the given amount of this stack and reduces this stack by the amount.
`java.lang.String`	`toString()`
`void`	`updateAnimation(World worldIn, Entity entityIn, int inventorySlot, boolean isCurrentItem)` Called each tick as long the ItemStack in on player inventory.
`ActionResult<ItemStack>`	`useItemRightClick(World worldIn, EntityPlayer playerIn, EnumHand hand)` Called whenr the item stack is equipped and right clicked.
`NBTTagCompound`	`writeToNBT(NBTTagCompound nbt)` 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

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

DECIMALFORMAT

public static final java.text.DecimalFormat DECIMALFORMAT

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,
                 NBTTagCompound capNBT)

ItemStack

public ItemStack(NBTTagCompound compound)

Method Detail

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

registerFixes

public static void registerFixes(DataFixer fixer)

splitStack
```
public ItemStack splitStack(int amount)
```
Splits off a stack of the given amount of this stack and reduces this stack by the amount.

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

onItemUse

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

Called when the player uses this ItemStack on a Block (right-click). Places blocks, etc. (Legacy name: tryPlaceItemIntoWorld)

onItemUseFirst

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

getStrVsBlock

public float getStrVsBlock(IBlockState blockIn)

useItemRightClick

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

Called whenr the item stack is equipped and right clicked. Replaces the item stack with the return value.

onItemUseFinish

public ItemStack onItemUseFinish(World worldIn,
                                 EntityLivingBase entityLiving)

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

writeToNBT
```
public NBTTagCompound writeToNBT(NBTTagCompound nbt)
```
Write the stack fields to a NBT object. Return the new 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

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

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

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

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

attemptDamageItem
```
public boolean attemptDamageItem(int amount,
                                 java.util.Random rand)
```
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 amount,
                       EntityLivingBase entityIn)

Damages the item in the ItemStack

hitEntity

public void hitEntity(EntityLivingBase entityIn,
                      EntityPlayer playerIn)

Calls the delegated method to the Item to damage the incoming Entity, and if necessary, triggers a stats increase.

onBlockDestroyed

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

Called when a Block is destroyed using this ItemStack

canHarvestBlock
```
public boolean canHarvestBlock(IBlockState blockIn)
```
Check whether the given Block can be harvested using this ItemStack.

interactWithEntity

public boolean interactWithEntity(EntityPlayer playerIn,
                                  EntityLivingBase entityIn,
                                  EnumHand hand)

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

areItemStackTagsEqual

public static boolean areItemStackTagsEqual(ItemStack stackA,
                                            ItemStack stackB)

areItemStacksEqual

public static boolean areItemStacksEqual(ItemStack stackA,
                                         ItemStack stackB)

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

areItemsEqual

public static boolean areItemsEqual(ItemStack stackA,
                                    ItemStack stackB)

Compares Item and damage value of the two stacks

areItemsEqualIgnoreDurability

public static boolean areItemsEqualIgnoreDurability(ItemStack stackA,
                                                    ItemStack stackB)

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

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)

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 worldIn,
                       EntityPlayer playerIn,
                       int amount)

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

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

onPlayerStoppedUsing

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

Called when the player releases the use item button.

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.

getOrCreateSubCompound

public NBTTagCompound getOrCreateSubCompound(java.lang.String key)

getSubCompound

public NBTTagCompound getSubCompound(java.lang.String key)

Get an NBTTagCompound from this stack's NBT data.

removeSubCompound

public void removeSubCompound(java.lang.String key)

getEnchantmentTagList

public NBTTagList getEnchantmentTagList()

setTagCompound
```
public void setTagCompound(NBTTagCompound nbt)
```
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

setTranslatableName

public ItemStack setTranslatableName(java.lang.String p_190924_1_)

setStackDisplayName

public ItemStack setStackDisplayName(java.lang.String displayName)

clearCustomName
```
public void clearCustomName()
```
Clear any custom name set for this ItemStack

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

getTooltip

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

Return a list of strings containing information about the item

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

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 ench,
                           int level)

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 key,
                       NBTBase value)

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

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

setItemFrame

public void setItemFrame(EntityItemFrame frame)

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 cost)
```
Set this stack's repair cost.

getAttributeModifiers
```
public <any> getAttributeModifiers(EntityEquipmentSlot equipmentSlot)
```
Gets the attribute modifiers for this ItemStack. Will check for an NBT tag list containing modifiers for the stack.

addAttributeModifier

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

getTextComponent
```
public ITextComponent getTextComponent()
```
Get a ChatComponent for this Item's display name that shows this Item on hover

canDestroy

public boolean canDestroy(Block blockIn)

canPlaceOn

public boolean canPlaceOn(Block blockIn)

hasCapability
```
public boolean hasCapability(Capability<?> capability,
                             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 looses support for a capability. Example: A Pipe getting a cover placed on one side causing it loose 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.

getCapability
```
public <T> T getCapability(Capability<T> capability,
                           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.

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. Returns null when ICapabilityProvider.hasCapability(Capability, EnumFacing) would return false.

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)

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

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.

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.

Class ItemStack

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EMPTY

DECIMALFORMAT

Constructor Detail

ItemStack

ItemStack

ItemStack

ItemStack

ItemStack

ItemStack

ItemStack

ItemStack

Method Detail

isEmpty

registerFixes

splitStack

getItem

onItemUse

onItemUseFirst

getStrVsBlock

useItemRightClick

onItemUseFinish

writeToNBT

getMaxStackSize

isStackable

isItemStackDamageable

getHasSubtypes

isItemDamaged

getItemDamage

getMetadata

setItemDamage

getMaxDamage

attemptDamageItem

damageItem

hitEntity

onBlockDestroyed

canHarvestBlock

interactWithEntity

copy

areItemStackTagsEqual

areItemStacksEqual

areItemsEqual

areItemsEqualIgnoreDurability

isItemEqual

isItemEqualIgnoreDurability

getUnlocalizedName

toString

updateAnimation

onCrafting

getMaxItemUseDuration

getItemUseAction

onPlayerStoppedUsing

hasTagCompound

getTagCompound

getOrCreateSubCompound

getSubCompound

removeSubCompound

getEnchantmentTagList

setTagCompound

getDisplayName

setTranslatableName

setStackDisplayName

clearCustomName

hasDisplayName

getTooltip

hasEffect

getRarity

isItemEnchantable

addEnchantment

isItemEnchanted

setTagInfo

canEditBlocks

isOnItemFrame

setItemFrame

getItemFrame