Item (Forge API 1.8.9-11.15.1.2318)

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

Direct Known Subclasses:

ItemArmor, ItemArmorStand, ItemBed, ItemBlock, ItemBoat, ItemBook, ItemBow, ItemBucket, ItemBucketMilk, ItemCarrotOnAStick, ItemCoal, ItemDoor, ItemDye, ItemEditableBook, ItemEgg, ItemEnchantedBook, ItemEnderEye, ItemEnderPearl, ItemExpBottle, ItemFireball, ItemFirework, ItemFireworkCharge, ItemFishingRod, ItemFlintAndSteel, ItemFluidContainer, ItemFood, ItemGlassBottle, ItemHangingEntity, ItemHoe, ItemLead, ItemMapBase, ItemMinecart, ItemMonsterPlacer, ItemNameTag, ItemPotion, ItemRecord, ItemRedstone, ItemReed, ItemSaddle, ItemSeeds, ItemShears, ItemSign, ItemSimpleFoiled, ItemSkull, ItemSnowball, ItemSword, ItemTool, ItemWritableBook, UniversalBucket
```
public class Item
extends java.lang.Object
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Item.ToolMaterial

Nested Classes
Modifier and Type	Class and Description
`static class`	`Item.ToolMaterial`

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`bFull3D` If true, render the object in full 3D, like weapons and tools.
`protected boolean`	`canRepair`
`RegistryDelegate<Item>`	`delegate`
`protected boolean`	`hasSubtypes` Some items (like dyes) have multiple subtypes on same item, this is field define this behavior
`protected static java.util.UUID`	`itemModifierUUID`
`protected static java.util.Random`	`itemRand` The RNG used by the Item subclasses.
`static RegistryNamespaced<ResourceLocation,Item>`	`itemRegistry`
`protected int`	`maxStackSize` Maximum size of the stack.

Constructor Summary

Constructors
Constructor and Description

Item()

Constructors
Constructor and Description
`Item()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addInformation(ItemStack stack, EntityPlayer playerIn, java.util.List<java.lang.String> tooltip, boolean advanced)` allows items to add custom lines of information to the mouseover description
`boolean`	`canHarvestBlock(Block blockIn)` Check whether this Item can harvest the given Block
`boolean`	`canHarvestBlock(Block par1Block, ItemStack itemStack)` ItemStack sensitive version of `canHarvestBlock(Block)`
`boolean`	`canItemEditBlocks()` Returns true if players can use this item to affect the world (e.g. placing blocks, placing ender eyes in portal) when not in creative
`Entity`	`createEntity(World world, Entity location, ItemStack itemstack)` This function should return a new entity to replace the dropped item.
`boolean`	`doesSneakBypassUse(World world, BlockPos pos, EntityPlayer player)` Should this item, when held, allow sneak-clicks to pass through to the underlying block?
`ModelBiped`	`getArmorModel(EntityLivingBase entityLiving, ItemStack itemStack, int armorSlot)` Deprecated. Use 4-argument version.
`ModelBiped`	`getArmorModel(EntityLivingBase entityLiving, ItemStack itemStack, int armorSlot, ModelBiped _default)` Override this method to have an item handle its own armor rendering.
`java.lang.String`	`getArmorTexture(ItemStack stack, Entity entity, int slot, java.lang.String type)` Called by RenderBiped and RenderPlayer to determine the armor texture that should be use for the currently equipped item.
`<any>`	`getAttributeModifiers(ItemStack stack)` ItemStack sensitive version of getItemAttributeModifiers
`static Item`	`getByNameOrId(java.lang.String id)` Tries to get an Item by it's name (e.g. minecraft:apple) or a String representation of a numerical ID.
`WeightedRandomChestContent`	`getChestGenBase(ChestGenHooks chest, java.util.Random rnd, WeightedRandomChestContent original)` Generates the base Random item for a specific instance of the chest gen, Enchanted books use this to pick a random enchantment.
`int`	`getColorFromItemStack(ItemStack stack, int renderPass)`
`Item`	`getContainerItem()`
`ItemStack`	`getContainerItem(ItemStack itemStack)` ItemStack sensitive version of getContainerItem.
`CreativeTabs`	`getCreativeTab()` gets the CreativeTab this item is displayed on
`CreativeTabs[]`	`getCreativeTabs()` Gets a list of tabs that items belonging to this class can display on, combined properly with getSubItems allows for a single item to span many sub-items across many tabs.
`int`	`getDamage(ItemStack stack)` Return the itemDamage represented by this ItemStack.
`float`	`getDigSpeed(ItemStack itemstack, IBlockState state)` Metadata-sensitive version of getStrVsBlock
`double`	`getDurabilityForDisplay(ItemStack stack)` Queries the percentage of the 'Durability' bar that should be drawn.
`int`	`getEntityLifespan(ItemStack itemStack, World world)` Retrieves the normal 'lifespan' of this item when it is dropped on the ground as a EntityItem.
`FontRenderer`	`getFontRenderer(ItemStack stack)` Returns the font renderer used to render tooltips and overlays for this item.
`int`	`getHarvestLevel(ItemStack stack, java.lang.String toolClass)` Queries the harvest level of this item stack for the specifred tool class, Returns -1 if this tool is not of the specified type
`boolean`	`getHasSubtypes()`
`java.lang.String`	`getHighlightTip(ItemStack item, java.lang.String displayName)` Allow the item one last chance to modify its name used for the tool highlight useful for adding something extra that can't be removed by a user in the displayed name, such as a mode of operation.
`static int`	`getIdFromItem(Item itemIn)`
`boolean`	`getIsRepairable(ItemStack toRepair, ItemStack repair)` Return whether this item is repairable in an anvil.
`<any>`	`getItemAttributeModifiers()` Deprecated.
`static Item`	`getItemById(int id)`
`int`	`getItemEnchantability()` Return the enchantability factor of the item, most of the time is based on material.
`int`	`getItemEnchantability(ItemStack stack)` ItemStack sensitive version of getItemEnchantability
`static Item`	`getItemFromBlock(Block blockIn)`
`java.lang.String`	`getItemStackDisplayName(ItemStack stack)`
`int`	`getItemStackLimit()` Deprecated.
`int`	`getItemStackLimit(ItemStack stack)` Gets the maximum number of items that this stack should be able to hold.
`EnumAction`	`getItemUseAction(ItemStack stack)` returns the action that specifies what animation to play when the items is being used
`int`	`getMaxDamage()` Returns the maximum damage an item can take.
`int`	`getMaxDamage(ItemStack stack)` Return the maxDamage for this ItemStack.
`int`	`getMaxItemUseDuration(ItemStack stack)` How long it takes to use or consume an item
`int`	`getMetadata(int damage)` Converts the given ItemStack damage value into a metadata value to be placed in the world when this Item is placed as a Block (mostly used with ItemBlocks).
`int`	`getMetadata(ItemStack stack)` This used to be 'display damage' but its really just 'aux' data in the ItemStack, usually shares the same variable as damage.
`ModelResourceLocation`	`getModel(ItemStack stack, EntityPlayer player, int useRemaining)` Player, Render pass, and item usage sensitive version of getIconIndex.
`protected MovingObjectPosition`	`getMovingObjectPositionFromPlayer(World worldIn, EntityPlayer playerIn, boolean useLiquids)`
`java.lang.String`	`getPotionEffect(ItemStack stack)`
`EnumRarity`	`getRarity(ItemStack stack)` Return an item rarity from EnumRarity
`java.lang.String`	`getRegistryName()` A unique identifier for this block, if this block is registered in the game registry it will return that name.
`boolean`	`getShareTag()` If this function returns true (or the item is damageable), the ItemStack's NBT tag will be sent to the client.
`float`	`getSmeltingExperience(ItemStack item)` Determines the base experience for a player when they remove this item from a furnace slot.
`float`	`getStrVsBlock(ItemStack stack, Block block)`
`void`	`getSubItems(Item itemIn, CreativeTabs tab, java.util.List<ItemStack> subItems)` returns a list of items with the same ID, but different meta (eg: dye returns 16 items)
`java.util.Set<java.lang.String>`	`getToolClasses(ItemStack stack)`
`java.lang.String`	`getUnlocalizedName()` Returns the unlocalized name of this item.
`java.lang.String`	`getUnlocalizedName(ItemStack stack)` Returns the unlocalized name of this item.
`java.lang.String`	`getUnlocalizedNameInefficiently(ItemStack stack)` Translates the unlocalized name of this item, but without the .name suffix, so the translation fails and the unlocalized name itself is returned.
`boolean`	`hasContainerItem()` Deprecated.
`boolean`	`hasContainerItem(ItemStack stack)` ItemStack sensitive version of hasContainerItem
`boolean`	`hasCustomEntity(ItemStack stack)` Determines if this Item has a special entity for when they are in the world.
`boolean`	`hasEffect(ItemStack stack)`
`boolean`	`hitEntity(ItemStack stack, EntityLivingBase target, EntityLivingBase attacker)` Current implementations of this method in child classes do not use the entry argument beside ev.
`ICapabilityProvider`	`initCapabilities(ItemStack stack, NBTTagCompound nbt)` Called from ItemStack.setItem, will hold extra data for the life of this ItemStack.
`boolean`	`isBeaconPayment(ItemStack stack)` Whether this Item can be used as a payment to activate the vanilla beacon.
`boolean`	`isBookEnchantable(ItemStack stack, ItemStack book)` Allow or forbid the specific book/item combination as an anvil enchant
`boolean`	`isDamageable()`
`boolean`	`isDamaged(ItemStack stack)` Return if this itemstack is damaged.
`boolean`	`isFull3D()` Returns True is the item is renderer in full 3D when hold.
`boolean`	`isItemTool(ItemStack stack)` Checks isDamagable and if it cannot be stacked
`boolean`	`isMap()` false for all Items except sub-classes of ItemMapBase
`boolean`	`isPotionIngredient(ItemStack stack)`
`boolean`	`isRepairable()` Called by CraftingManager to determine if an item is reparable.
`boolean`	`isValidArmor(ItemStack stack, int armorType, Entity entity)` Determines if the specific ItemStack can be placed in the specified armor slot.
`boolean`	`itemInteractionForEntity(ItemStack stack, EntityPlayer playerIn, EntityLivingBase target)` Returns true if the item can be used on the given entity, e.g. shears on sheep.
`void`	`onArmorTick(World world, EntityPlayer player, ItemStack itemStack)` Called to tick armor in the armor slot.
`boolean`	`onBlockDestroyed(ItemStack stack, World worldIn, Block blockIn, BlockPos pos, EntityLivingBase playerIn)` Called when a Block is destroyed using this Item.
`boolean`	`onBlockStartBreak(ItemStack itemstack, BlockPos pos, EntityPlayer player)` Called before a block is broken.
`void`	`onCreated(ItemStack stack, World worldIn, EntityPlayer playerIn)` Called when item is crafted/smelted.
`boolean`	`onDroppedByPlayer(ItemStack item, EntityPlayer player)` Called when a player drops the item into the world, returning false from this will prevent the item from being removed from the players inventory and spawning in the world
`boolean`	`onEntityItemUpdate(EntityItem entityItem)` Called by the default implemetation of EntityItem's onUpdate method, allowing for cleaner control over the update of the item without having to write a subclass.
`boolean`	`onEntitySwing(EntityLivingBase entityLiving, ItemStack stack)` Called when a entity tries to play the 'swing' animation.
`ItemStack`	`onItemRightClick(ItemStack itemStackIn, World worldIn, EntityPlayer playerIn)` Called whenever this item is equipped and the right mouse button is pressed.
`boolean`	`onItemUse(ItemStack stack, EntityPlayer playerIn, World worldIn, BlockPos pos, EnumFacing side, float hitX, float hitY, float hitZ)` Called when a Block is right-clicked with this Item
`ItemStack`	`onItemUseFinish(ItemStack stack, World worldIn, EntityPlayer playerIn)` Called when the player finishes using this Item (E.g. finishes eating.).
`boolean`	`onItemUseFirst(ItemStack stack, EntityPlayer player, World world, BlockPos pos, EnumFacing side, float hitX, float hitY, float hitZ)` This is called when the item is used, before the block is activated.
`boolean`	`onLeftClickEntity(ItemStack stack, EntityPlayer player, Entity entity)` Called when the player Left Clicks (attacks) an entity.
`void`	`onPlayerStoppedUsing(ItemStack stack, World worldIn, EntityPlayer playerIn, int timeLeft)` Called when the player stops using an Item (stops holding the right mouse button).
`void`	`onUpdate(ItemStack stack, World worldIn, Entity entityIn, int itemSlot, boolean isSelected)` Called each tick as long the item is on a player inventory.
`void`	`onUsingTick(ItemStack stack, EntityPlayer player, int count)` Called each tick while using an item.
`protected static void`	`registerItemBlock(Block blockIn, Item itemIn)` Register the given Item as the ItemBlock for the given Block.
`static void`	`registerItems()`
`void`	`renderHelmetOverlay(ItemStack stack, EntityPlayer player, ScaledResolution resolution, float partialTicks)` Called when the client starts rendering the HUD, for whatever item the player currently has as a helmet.
`Item`	`setContainerItem(Item containerItem)`
`Item`	`setCreativeTab(CreativeTabs tab)` returns this;
`void`	`setDamage(ItemStack stack, int damage)` Set the damage for this itemstack.
`Item`	`setFull3D()` Sets bFull3D to True and return the object.
`void`	`setHarvestLevel(java.lang.String toolClass, int level)` Sets or removes the harvest level for the specified tool class.
`Item`	`setHasSubtypes(boolean hasSubtypes)`
`Item`	`setMaxDamage(int maxDamageIn)` set max damage of an Item
`Item`	`setMaxStackSize(int maxStackSize)`
`Item`	`setNoRepair()` Call to disable repair recipes.
`Item`	`setPotionEffect(java.lang.String potionEffect)` Sets the string representing this item's effect on a potion when used as an ingredient.
`Item`	`setRegistryName(ResourceLocation name)`
`Item`	`setRegistryName(java.lang.String name)` Sets a unique name for this Item.
`Item`	`setRegistryName(java.lang.String modID, java.lang.String name)`
`Item`	`setUnlocalizedName(java.lang.String unlocalizedName)` Sets the unlocalized name of this item to the string passed as the parameter, prefixed by "item."
`boolean`	`shouldCauseReequipAnimation(ItemStack oldStack, ItemStack newStack, boolean slotChanged)` Determine if the player switching between these two item stacks
`boolean`	`shouldRotateAroundWhenRendering()` Returns true if this item should be rotated by 180 degrees around the Y axis when being held in an entities hands.
`boolean`	`showDurabilityBar(ItemStack stack)` Determines if the durability bar should be rendered for this item.
`boolean`	`updateItemStackNBT(NBTTagCompound nbt)` Called when an ItemStack with NBT data is read to potentially that ItemStack's NBT data

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

- Field Detail
  - itemRegistry
```
public static final RegistryNamespaced<ResourceLocation,Item> itemRegistry
```
  - itemModifierUUID
```
protected static final java.util.UUID itemModifierUUID
```
  - itemRand
```
protected static java.util.Random itemRand
```
    The RNG used by the Item subclasses.
  - maxStackSize
```
protected int maxStackSize
```
    Maximum size of the stack.
  - bFull3D
```
protected boolean bFull3D
```
    If true, render the object in full 3D, like weapons and tools.
  - hasSubtypes
```
protected boolean hasSubtypes
```
    Some items (like dyes) have multiple subtypes on same item, this is field define this behavior
  - delegate
```
public final RegistryDelegate<Item> delegate
```
  - canRepair
```
protected boolean canRepair
```
- Constructor Detail
  - Item
```
public Item()
```
- Method Detail
  - getIdFromItem
```
public static int getIdFromItem(Item itemIn)
```
  - getItemById
```
public static Item getItemById(int id)
```
  - getItemFromBlock
```
public static Item getItemFromBlock(Block blockIn)
```
  - getByNameOrId
```
public static Item getByNameOrId(java.lang.String id)
```
    Tries to get an Item by it's name (e.g. minecraft:apple) or a String representation of a numerical ID. If both fail, null is returned.
  - updateItemStackNBT
```
public boolean updateItemStackNBT(NBTTagCompound nbt)
```
    Called when an ItemStack with NBT data is read to potentially that ItemStack's NBT data
  - setMaxStackSize
```
public Item setMaxStackSize(int maxStackSize)
```
  - onItemUse
```
public boolean onItemUse(ItemStack stack,
                         EntityPlayer playerIn,
                         World worldIn,
                         BlockPos pos,
                         EnumFacing side,
                         float hitX,
                         float hitY,
                         float hitZ)
```
    Called when a Block is right-clicked with this Item
  - getStrVsBlock
```
public float getStrVsBlock(ItemStack stack,
                           Block block)
```
  - onItemRightClick
```
public ItemStack onItemRightClick(ItemStack itemStackIn,
                                  World worldIn,
                                  EntityPlayer playerIn)
```
    Called whenever this item is equipped and the right mouse button is pressed. Args: itemStack, world, entityPlayer
  - onItemUseFinish
```
public ItemStack onItemUseFinish(ItemStack stack,
                                 World worldIn,
                                 EntityPlayer playerIn)
```
    Called when the player finishes using this Item (E.g. finishes eating.). Not called when the player stops using the Item before the action is complete.
  - getItemStackLimit
```
@Deprecated
public int getItemStackLimit()
```
    Deprecated.
    
    Returns the maximum size of the stack for a specific item. *Isn't this more a Set than a Get?*
  - getMetadata
```
public int getMetadata(int damage)
```
    Converts the given ItemStack damage value into a metadata value to be placed in the world when this Item is placed as a Block (mostly used with ItemBlocks).
  - getHasSubtypes
```
public boolean getHasSubtypes()
```
  - setHasSubtypes
```
public Item setHasSubtypes(boolean hasSubtypes)
```
  - getMaxDamage
```
public int getMaxDamage()
```
    Returns the maximum damage an item can take.
  - setMaxDamage
```
public Item setMaxDamage(int maxDamageIn)
```
    set max damage of an Item
  - isDamageable
```
public boolean isDamageable()
```
  - hitEntity
```
public boolean hitEntity(ItemStack stack,
                         EntityLivingBase target,
                         EntityLivingBase attacker)
```
    Current implementations of this method in child classes do not use the entry argument beside ev. They just raise the damage on the stack.
  - onBlockDestroyed
```
public boolean onBlockDestroyed(ItemStack stack,
                                World worldIn,
                                Block blockIn,
                                BlockPos pos,
                                EntityLivingBase playerIn)
```
    Called when a Block is destroyed using this Item. Return true to trigger the "Use Item" statistic.
  - canHarvestBlock
```
public boolean canHarvestBlock(Block blockIn)
```
    Check whether this Item can harvest the given Block
  - itemInteractionForEntity
```
public boolean itemInteractionForEntity(ItemStack stack,
                                        EntityPlayer playerIn,
                                        EntityLivingBase target)
```
    Returns true if the item can be used on the given entity, e.g. shears on sheep.
  - setFull3D
```
public Item setFull3D()
```
    Sets bFull3D to True and return the object.
  - isFull3D
```
public boolean isFull3D()
```
    Returns True is the item is renderer in full 3D when hold.
  - shouldRotateAroundWhenRendering
```
public boolean shouldRotateAroundWhenRendering()
```
    Returns true if this item should be rotated by 180 degrees around the Y axis when being held in an entities hands.
  - setUnlocalizedName
```
public Item setUnlocalizedName(java.lang.String unlocalizedName)
```
    Sets the unlocalized name of this item to the string passed as the parameter, prefixed by "item."
  - getUnlocalizedNameInefficiently
```
public java.lang.String getUnlocalizedNameInefficiently(ItemStack stack)
```
    Translates the unlocalized name of this item, but without the .name suffix, so the translation fails and the unlocalized name itself is returned.
  - getUnlocalizedName
```
public java.lang.String getUnlocalizedName()
```
    Returns the unlocalized name of this item.
  - getUnlocalizedName
```
public java.lang.String getUnlocalizedName(ItemStack stack)
```
    Returns the unlocalized name of this item. This version accepts an ItemStack so different stacks can have different names based on their damage or NBT.
  - setContainerItem
```
public Item setContainerItem(Item containerItem)
```
  - getShareTag
```
public boolean getShareTag()
```
    If this function returns true (or the item is damageable), the ItemStack's NBT tag will be sent to the client.
  - getContainerItem
```
public Item getContainerItem()
```
  - hasContainerItem
```
@Deprecated
public boolean hasContainerItem()
```
    Deprecated.
    
    True if this Item has a container item (a.k.a. crafting result)
  - getColorFromItemStack
```
public int getColorFromItemStack(ItemStack stack,
                                 int renderPass)
```
  - onUpdate
```
public void onUpdate(ItemStack stack,
                     World worldIn,
                     Entity entityIn,
                     int itemSlot,
                     boolean isSelected)
```
    Called each tick as long the item is on a player inventory. Uses by maps to check if is on a player hand and update it's contents.
  - onCreated
```
public void onCreated(ItemStack stack,
                      World worldIn,
                      EntityPlayer playerIn)
```
    Called when item is crafted/smelted. Used only by maps so far.
  - isMap
```
public boolean isMap()
```
    false for all Items except sub-classes of ItemMapBase
  - getItemUseAction
```
public EnumAction getItemUseAction(ItemStack stack)
```
    returns the action that specifies what animation to play when the items is being used
  - getMaxItemUseDuration
```
public int getMaxItemUseDuration(ItemStack stack)
```
    How long it takes to use or consume an item
  - onPlayerStoppedUsing
```
public void onPlayerStoppedUsing(ItemStack stack,
                                 World worldIn,
                                 EntityPlayer playerIn,
                                 int timeLeft)
```
    Called when the player stops using an Item (stops holding the right mouse button).
  - setPotionEffect
```
public Item setPotionEffect(java.lang.String potionEffect)
```
    Sets the string representing this item's effect on a potion when used as an ingredient.
  - getPotionEffect
```
public java.lang.String getPotionEffect(ItemStack stack)
```
  - isPotionIngredient
```
public boolean isPotionIngredient(ItemStack stack)
```
  - addInformation
```
public void addInformation(ItemStack stack,
                           EntityPlayer playerIn,
                           java.util.List<java.lang.String> tooltip,
                           boolean advanced)
```
    allows items to add custom lines of information to the mouseover description
  - getItemStackDisplayName
```
public java.lang.String getItemStackDisplayName(ItemStack stack)
```
  - hasEffect
```
public boolean hasEffect(ItemStack stack)
```
  - getRarity
```
public EnumRarity getRarity(ItemStack stack)
```
    Return an item rarity from EnumRarity
  - isItemTool
```
public boolean isItemTool(ItemStack stack)
```
    Checks isDamagable and if it cannot be stacked
  - getMovingObjectPositionFromPlayer
```
protected MovingObjectPosition getMovingObjectPositionFromPlayer(World worldIn,
                                                                 EntityPlayer playerIn,
                                                                 boolean useLiquids)
```
  - getItemEnchantability
```
public int getItemEnchantability()
```
    Return the enchantability factor of the item, most of the time is based on material.
  - getSubItems
```
public void getSubItems(Item itemIn,
                        CreativeTabs tab,
                        java.util.List<ItemStack> subItems)
```
    returns a list of items with the same ID, but different meta (eg: dye returns 16 items)
  - setCreativeTab
```
public Item setCreativeTab(CreativeTabs tab)
```
    returns this;
  - getCreativeTab
```
public CreativeTabs getCreativeTab()
```
    gets the CreativeTab this item is displayed on
  - canItemEditBlocks
```
public boolean canItemEditBlocks()
```
    Returns true if players can use this item to affect the world (e.g. placing blocks, placing ender eyes in portal) when not in creative
  - getIsRepairable
```
public boolean getIsRepairable(ItemStack toRepair,
                               ItemStack repair)
```
    Return whether this item is repairable in an anvil.
  - getItemAttributeModifiers
```
@Deprecated
public <any> getItemAttributeModifiers()
```
    Deprecated.
  - getAttributeModifiers
```
public <any> getAttributeModifiers(ItemStack stack)
```
    ItemStack sensitive version of getItemAttributeModifiers
  - onDroppedByPlayer
```
public boolean onDroppedByPlayer(ItemStack item,
                                 EntityPlayer player)
```
    Called when a player drops the item into the world, returning false from this will prevent the item from being removed from the players inventory and spawning in the world
    
    Parameters:
    
    player - The player that dropped the item
    
    item - The item stack, before the item is removed.
  - getHighlightTip
```
public java.lang.String getHighlightTip(ItemStack item,
                                        java.lang.String displayName)
```
    Allow the item one last chance to modify its name used for the tool highlight useful for adding something extra that can't be removed by a user in the displayed name, such as a mode of operation.
    
    Parameters:
    
    item - the ItemStack for the item.
    
    the - name that will be displayed unless it is changed in this method.
  - onItemUseFirst
```
public boolean onItemUseFirst(ItemStack stack,
                              EntityPlayer player,
                              World world,
                              BlockPos pos,
                              EnumFacing side,
                              float hitX,
                              float hitY,
                              float hitZ)
```
    This is called when the item is used, before the block is activated.
    
    Parameters:
    
    stack - The Item Stack
    
    player - The Player that used the item
    
    world - The Current World
    
    pos - Target position
    
    side - The side of the target hit
    
    Returns:
    
    Return true to prevent any further processing.
  - getDigSpeed
```
public float getDigSpeed(ItemStack itemstack,
                         IBlockState state)
```
    Metadata-sensitive version of getStrVsBlock
    
    Parameters:
    
    itemstack - The Item Stack
    
    state - The block state
    
    Returns:
    
    The damage strength
  - isRepairable
```
public boolean isRepairable()
```
    Called by CraftingManager to determine if an item is reparable.
    
    Returns:
    
    True if reparable
  - setNoRepair
```
public Item setNoRepair()
```
    Call to disable repair recipes.
    
    Returns:
    
    The current Item instance
  - onBlockStartBreak
```
public boolean onBlockStartBreak(ItemStack itemstack,
                                 BlockPos pos,
                                 EntityPlayer player)
```
    Called before a block is broken. Return true to prevent default block harvesting. Note: In SMP, this is called on both client and server sides!
    
    Parameters:
    
    itemstack - The current ItemStack
    
    pos - Block's position in world
    
    player - The Player that is wielding the item
    
    Returns:
    
    True to prevent harvesting, false to continue as normal
  - onUsingTick
```
public void onUsingTick(ItemStack stack,
                        EntityPlayer player,
                        int count)
```
    Called each tick while using an item.
    
    Parameters:
    
    stack - The Item being used
    
    player - The Player using the item
    
    count - The amount of time in tick the item has been used for continuously
  - onLeftClickEntity
```
public boolean onLeftClickEntity(ItemStack stack,
                                 EntityPlayer player,
                                 Entity entity)
```
    Called when the player Left Clicks (attacks) an entity. Processed before damage is done, if return value is true further processing is canceled and the entity is not attacked.
    
    Parameters:
    
    stack - The Item being used
    
    player - The player that is attacking
    
    entity - The entity being attacked
    
    Returns:
    
    True to cancel the rest of the interaction.
  - getModel
```
public ModelResourceLocation getModel(ItemStack stack,
                                      EntityPlayer player,
                                      int useRemaining)
```
    Player, Render pass, and item usage sensitive version of getIconIndex.
    
    Parameters:
    
    stack - The item stack to get the icon for.
    
    player - The player holding the item
    
    useRemaining - The ticks remaining for the active item.
    
    Returns:
    
    Null to use default model, or a custom ModelResourceLocation for the stage of use.
  - getContainerItem
```
public ItemStack getContainerItem(ItemStack itemStack)
```
    ItemStack sensitive version of getContainerItem. Returns a full ItemStack instance of the result.
    
    Parameters:
    
    itemStack - The current ItemStack
    
    Returns:
    
    The resulting ItemStack
  - hasContainerItem
```
public boolean hasContainerItem(ItemStack stack)
```
    ItemStack sensitive version of hasContainerItem
    
    Parameters:
    
    stack - The current item stack
    
    Returns:
    
    True if this item has a 'container'
  - getEntityLifespan
```
public int getEntityLifespan(ItemStack itemStack,
                             World world)
```
    Retrieves the normal 'lifespan' of this item when it is dropped on the ground as a EntityItem. This is in ticks, standard result is 6000, or 5 mins.
    
    Parameters:
    
    itemStack - The current ItemStack
    
    world - The world the entity is in
    
    Returns:
    
    The normal lifespan in ticks.
  - hasCustomEntity
```
public boolean hasCustomEntity(ItemStack stack)
```
    Determines if this Item has a special entity for when they are in the world. Is called when a EntityItem is spawned in the world, if true and Item#createCustomEntity returns non null, the EntityItem will be destroyed and the new Entity will be added to the world.
    
    Parameters:
    
    stack - The current item stack
    
    Returns:
    
    True of the item has a custom entity, If true, Item#createCustomEntity will be called
  - createEntity
```
public Entity createEntity(World world,
                           Entity location,
                           ItemStack itemstack)
```
    This function should return a new entity to replace the dropped item. Returning null here will not kill the EntityItem and will leave it to function normally. Called when the item it placed in a world.
    
    Parameters:
    
    world - The world object
    
    location - The EntityItem object, useful for getting the position of the entity
    
    itemstack - The current item stack
    
    Returns:
    
    A new Entity object to spawn or null
  - onEntityItemUpdate
```
public boolean onEntityItemUpdate(EntityItem entityItem)
```
    Called by the default implemetation of EntityItem's onUpdate method, allowing for cleaner control over the update of the item without having to write a subclass.
    
    Parameters:
    
    entityItem - The entity Item
    
    Returns:
    
    Return true to skip any further update code.
  - getCreativeTabs
```
public CreativeTabs[] getCreativeTabs()
```
    Gets a list of tabs that items belonging to this class can display on, combined properly with getSubItems allows for a single item to span many sub-items across many tabs.
    
    Returns:
    
    A list of all tabs that this item could possibly be one.
  - getSmeltingExperience
```
public float getSmeltingExperience(ItemStack item)
```
    Determines the base experience for a player when they remove this item from a furnace slot. This number must be between 0 and 1 for it to be valid. This number will be multiplied by the stack size to get the total experience.
    
    Parameters:
    
    item - The item stack the player is picking up.
    
    Returns:
    
    The amount to award for each item.
  - getChestGenBase
```
public WeightedRandomChestContent getChestGenBase(ChestGenHooks chest,
                                                  java.util.Random rnd,
                                                  WeightedRandomChestContent original)
```
    Generates the base Random item for a specific instance of the chest gen, Enchanted books use this to pick a random enchantment.
    
    Parameters:
    
    chest - The chest category to generate for
    
    rnd - World RNG
    
    original - Original result registered with the chest gen hooks.
    
    Returns:
    
    New values to use as the random item, typically this will be original
  - doesSneakBypassUse
```
public boolean doesSneakBypassUse(World 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:
  - onArmorTick
```
public void onArmorTick(World world,
                        EntityPlayer player,
                        ItemStack itemStack)
```
    Called to tick armor in the armor slot. Override to do something
  - isValidArmor
```
public boolean isValidArmor(ItemStack stack,
                            int armorType,
                            Entity entity)
```
    Determines if the specific ItemStack can be placed in the specified armor slot.
    
    Parameters:
    
    stack - The ItemStack
    
    armorType - Armor slot ID: 0: Helmet, 1: Chest, 2: Legs, 3: Boots
    
    entity - The entity trying to equip the armor
    
    Returns:
    
    True if the given ItemStack can be inserted in the slot
  - isBookEnchantable
```
public boolean isBookEnchantable(ItemStack stack,
                                 ItemStack book)
```
    Allow or forbid the specific book/item combination as an anvil enchant
    
    Parameters:
    
    stack - The item
    
    book - The book
    
    Returns:
    
    if the enchantment is allowed
  - getArmorTexture
```
public java.lang.String getArmorTexture(ItemStack stack,
                                        Entity entity,
                                        int slot,
                                        java.lang.String type)
```
    Called by RenderBiped and RenderPlayer to determine the armor texture that should be use for the currently equipped item. This will only be called on instances of ItemArmor. Returning null from this function will use the default value.
    
    Parameters:
    
    stack - ItemStack for the equipped armor
    
    entity - The entity wearing the armor
    
    slot - The slot the armor is in
    
    type - The subtype, can be null or "overlay"
    
    Returns:
    
    Path of texture to bind, or null to use default
  - getFontRenderer
```
public FontRenderer getFontRenderer(ItemStack stack)
```
    Returns the font renderer used to render tooltips and overlays for this item. Returning null will use the standard font renderer.
    
    Parameters:
    
    stack - The current item stack
    
    Returns:
    
    A instance of FontRenderer or null to use default
  - getArmorModel
```
@Deprecated
public ModelBiped getArmorModel(EntityLivingBase entityLiving,
                                             ItemStack itemStack,
                                             int armorSlot)
```
    Deprecated. Use 4-argument version.
  - getArmorModel
```
public ModelBiped getArmorModel(EntityLivingBase entityLiving,
                                ItemStack itemStack,
                                int armorSlot,
                                ModelBiped _default)
```
    Override this method to have an item handle its own armor rendering.
    
    Parameters:
    
    entityLiving - The entity wearing the armor
    
    itemStack - The itemStack to render the model of
    
    armorSlot - 0=head, 1=torso, 2=legs, 3=feet
    
    _default - Original armor model. Will have attributes set.
    
    Returns:
    
    A ModelBiped to render instead of the default
  - onEntitySwing
```
public boolean onEntitySwing(EntityLivingBase entityLiving,
                             ItemStack stack)
```
    Called when a entity tries to play the 'swing' animation.
    
    Parameters:
    
    entityLiving - The entity swinging the item.
    
    stack - The Item stack
    
    Returns:
    
    True to cancel any further processing by EntityLiving
  - renderHelmetOverlay
```
public void renderHelmetOverlay(ItemStack stack,
                                EntityPlayer player,
                                ScaledResolution resolution,
                                float partialTicks)
```
    Called when the client starts rendering the HUD, for whatever item the player currently has as a helmet. This is where pumpkins would render there overlay.
    
    Parameters:
    
    stack - The ItemStack that is equipped
    
    player - Reference to the current client entity
    
    resolution - Resolution information about the current viewport and configured GUI Scale
    
    partialTicks - Partial ticks for the renderer, useful for interpolation
  - getDamage
```
public int getDamage(ItemStack stack)
```
    Return the itemDamage represented by this ItemStack. Defaults to the itemDamage field on ItemStack, but can be overridden here for other sources such as NBT.
    
    Parameters:
    
    stack - The itemstack that is damaged
    
    Returns:
    
    the damage value
  - getMetadata
```
public int getMetadata(ItemStack stack)
```
    This used to be 'display damage' but its really just 'aux' data in the ItemStack, usually shares the same variable as damage.
    
    Parameters:
    
    stack -
    
    Returns:
  - showDurabilityBar
```
public boolean showDurabilityBar(ItemStack stack)
```
    Determines if the durability bar should be rendered for this item. Defaults to vanilla stack.isDamaged behavior. But modders can use this for any data they wish.
    
    Parameters:
    
    stack - The current Item Stack
    
    Returns:
    
    True if it should render the 'durability' bar.
  - getDurabilityForDisplay
```
public double getDurabilityForDisplay(ItemStack stack)
```
    Queries the percentage of the 'Durability' bar that should be drawn.
    
    Parameters:
    
    stack - The current ItemStack
    
    Returns:
    
    1.0 for 100% 0 for 0%
  - getMaxDamage
```
public int getMaxDamage(ItemStack stack)
```
    Return the maxDamage for this ItemStack. Defaults to the maxDamage field in this item, but can be overridden here for other sources such as NBT.
    
    Parameters:
    
    stack - The itemstack that is damaged
    
    Returns:
    
    the damage value
  - isDamaged
```
public boolean isDamaged(ItemStack stack)
```
    Return if this itemstack is damaged. Note only called if isDamageable() is true.
    
    Parameters:
    
    stack - the stack
    
    Returns:
    
    if the stack is damaged
  - setDamage
```
public void setDamage(ItemStack stack,
                      int damage)
```
    Set the damage for this itemstack. Note, this method is responsible for zero checking.
    
    Parameters:
    
    stack - the stack
    
    damage - the new damage value
  - canHarvestBlock
```
public boolean canHarvestBlock(Block par1Block,
                               ItemStack itemStack)
```
    ItemStack sensitive version of canHarvestBlock(Block)
    
    Parameters:
    
    par1Block - The block trying to harvest
    
    itemStack - The itemstack used to harvest the block
    
    Returns:
    
    true if can harvest the block
  - getItemStackLimit
```
public int getItemStackLimit(ItemStack stack)
```
    Gets the maximum number of items that this stack should be able to hold. This is a ItemStack (and thus NBT) sensitive version of Item.getItemStackLimit()
    
    Parameters:
    
    stack - The ItemStack
    
    Returns:
    
    THe maximum number this item can be stacked to
  - setHarvestLevel
```
public void setHarvestLevel(java.lang.String toolClass,
                            int level)
```
    Sets or removes the harvest level for the specified tool class.
    
    Parameters:
    
    toolClass - Class
    
    level - Harvest level: Wood: 0 Stone: 1 Iron: 2 Diamond: 3 Gold: 0
  - getToolClasses
```
public java.util.Set<java.lang.String> getToolClasses(ItemStack stack)
```
  - getHarvestLevel
```
public int getHarvestLevel(ItemStack stack,
                           java.lang.String toolClass)
```
    Queries the harvest level of this item stack for the specifred tool class, Returns -1 if this tool is not of the specified type
    
    Parameters:
    
    stack - This item stack instance
    
    toolClass - Tool Class
    
    Returns:
    
    Harvest level, or -1 if not the specified tool type.
  - getItemEnchantability
```
public int getItemEnchantability(ItemStack stack)
```
    ItemStack sensitive version of getItemEnchantability
    
    Parameters:
    
    stack - The ItemStack
    
    Returns:
    
    the item echantability value
  - isBeaconPayment
```
public boolean isBeaconPayment(ItemStack stack)
```
    Whether this Item can be used as a payment to activate the vanilla beacon.
    
    Parameters:
    
    stack - the ItemStack
    
    Returns:
    
    true if this Item can be used
  - shouldCauseReequipAnimation
```
public boolean shouldCauseReequipAnimation(ItemStack oldStack,
                                           ItemStack newStack,
                                           boolean slotChanged)
```
    Determine if the player switching between these two item stacks
    
    Parameters:
    
    oldStack - The old stack that was equipped
    
    newStack - The new stack
    
    slotChanged - If the current equipped slot was changed, Vanilla does not play the animation if you switch between two slots that hold the exact same item.
    
    Returns:
    
    True to play the item change animation
  - setRegistryName
```
public final Item setRegistryName(java.lang.String name)
```
    Sets a unique name for this Item. This should be used for uniquely identify the instance of the Item. This is the valid replacement for the atrocious 'getUnlocalizedName().substring(6)' stuff that everyone does. Unlocalized names have NOTHING to do with unique identifiers. As demonstrated by vanilla blocks and items. The supplied name will be prefixed with the currently active mod's modId. If the supplied name already has a prefix that is different, it will be used and a warning will be logged. If a name already exists, or this Item is already registered in a registry, then an IllegalStateException is thrown. Returns 'this' to allow for chaining.
    
    Parameters:
    
    name - Unique registry name
    
    Returns:
    
    This instance
  - setRegistryName
```
public final Item setRegistryName(ResourceLocation name)
```
  - setRegistryName
```
public final Item setRegistryName(java.lang.String modID,
                                  java.lang.String name)
```
  - getRegistryName
```
public final java.lang.String getRegistryName()
```
    A unique identifier for this block, if this block is registered in the game registry it will return that name. Otherwise it will return the name set in setRegistryName(). If neither are valid null is returned.
    
    Returns:
    
    Unique identifier or null.
  - initCapabilities
```
public ICapabilityProvider initCapabilities(ItemStack stack,
                                            NBTTagCompound nbt)
```
    Called from ItemStack.setItem, will hold extra data for the life of this ItemStack. Can be retrieved from stack.getCapabilities() The NBT can be null if this is not called from readNBT or if the item the stack is changing FROM is different then this item, or the previous item had no capabilities. This is called BEFORE the stacks item is set so you can use stack.getItem() to see the OLD item. Remember that getItem CAN return null.
    
    Parameters:
    
    stack - The ItemStack
    
    nbt - NBT of this item serialized, or null.
    
    Returns:
    
    A holder instance associated with this ItemStack where you can hold capabilities for the life of this item.
  - registerItems
```
public static void registerItems()
```
  - registerItemBlock
```
protected static void registerItemBlock(Block blockIn,
                                        Item itemIn)
```
    Register the given Item as the ItemBlock for the given Block.

Class Item

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

itemRegistry

itemModifierUUID

itemRand

maxStackSize

bFull3D

hasSubtypes

delegate

canRepair

Constructor Detail

Item

Method Detail

getIdFromItem

getItemById

getItemFromBlock

getByNameOrId

updateItemStackNBT

setMaxStackSize

onItemUse

getStrVsBlock

onItemRightClick

onItemUseFinish

getItemStackLimit

getMetadata

getHasSubtypes

setHasSubtypes

getMaxDamage

setMaxDamage

isDamageable

hitEntity

onBlockDestroyed

canHarvestBlock

itemInteractionForEntity

setFull3D

isFull3D

shouldRotateAroundWhenRendering

setUnlocalizedName

getUnlocalizedNameInefficiently

getUnlocalizedName

getUnlocalizedName

setContainerItem

getShareTag

getContainerItem

hasContainerItem

getColorFromItemStack

onUpdate

onCreated

isMap

getItemUseAction

getMaxItemUseDuration

onPlayerStoppedUsing

setPotionEffect

getPotionEffect

isPotionIngredient

addInformation

getItemStackDisplayName

hasEffect

getRarity

isItemTool

getMovingObjectPositionFromPlayer

getItemEnchantability

getSubItems

setCreativeTab

getCreativeTab

canItemEditBlocks

getIsRepairable

getItemAttributeModifiers

getAttributeModifiers

onDroppedByPlayer

getHighlightTip

onItemUseFirst

getDigSpeed

isRepairable

setNoRepair