Item (Forge API)

java.lang.Object
- net.minecraftforge.registries.IForgeRegistryEntry.Impl<Item>
- - net.minecraft.item.Item

All Implemented Interfaces:

IForgeRegistryEntry<Item>

Direct Known Subclasses:

ItemAir, ItemArmor, ItemArmorStand, ItemArrow, ItemBed, ItemBlock, ItemBlockSpecial, ItemBoat, ItemBook, ItemBow, ItemBucket, ItemBucketMilk, ItemCarrotOnAStick, ItemClock, ItemCoal, ItemCompass, ItemDoor, ItemDye, ItemEgg, ItemElytra, ItemEnchantedBook, ItemEndCrystal, ItemEnderEye, ItemEnderPearl, ItemExpBottle, ItemFireball, ItemFirework, ItemFireworkCharge, ItemFishingRod, ItemFlintAndSteel, ItemFluidContainer, ItemFood, ItemGlassBottle, ItemHangingEntity, ItemHoe, ItemKnowledgeBook, ItemLead, ItemMapBase, ItemMinecart, ItemMonsterPlacer, ItemNameTag, ItemPotion, ItemRecord, ItemRedstone, ItemSaddle, ItemSeeds, ItemShears, ItemShield, ItemSign, ItemSimpleFoiled, ItemSkull, ItemSnowball, ItemSword, ItemTool, ItemWritableBook, ItemWrittenBook, UniversalBucket
```
public class Item
extends IForgeRegistryEntry.Impl<Item>
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Item.ToolMaterial
- Nested classes/interfaces inherited from interface net.minecraftforge.registries.IForgeRegistryEntry
  IForgeRegistryEntry.Impl<T extends IForgeRegistryEntry<T>>

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected static java.util.UUID`	`ATTACK_DAMAGE_MODIFIER`
`protected static java.util.UUID`	`ATTACK_SPEED_MODIFIER`
`protected boolean`	`bFull3D`
`protected boolean`	`canRepair`
`protected boolean`	`hasSubtypes`
`protected static java.util.Random`	`itemRand`
`protected int`	`maxStackSize`
`static RegistryNamespaced<ResourceLocation,Item>`	`REGISTRY`

Fields inherited from class net.minecraftforge.registries.IForgeRegistryEntry.Impl
delegate

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, World worldIn, java.util.List<java.lang.String> tooltip, ITooltipFlag flagIn)`
`void`	`addPropertyOverride(ResourceLocation key, IItemPropertyGetter getter)`
`boolean`	`canApplyAtEnchantingTable(ItemStack stack, Enchantment enchantment)` Checks whether an item can be enchanted with a certain enchantment.
`boolean`	`canDestroyBlockInCreative(World world, BlockPos pos, ItemStack stack, EntityPlayer player)` Checked from `PlayerControllerMP.onPlayerDestroyBlock()` when a creative player left-clicks a block with this item.
`boolean`	`canDisableShield(ItemStack stack, ItemStack shield, EntityLivingBase entity, EntityLivingBase attacker)` Can this Item disable a shield
`boolean`	`canHarvestBlock(IBlockState blockIn)`
`boolean`	`canHarvestBlock(IBlockState state, ItemStack stack)` ItemStack sensitive version of `canHarvestBlock(IBlockState)`
`boolean`	`canItemEditBlocks()`
`Entity`	`createEntity(World world, Entity location, ItemStack itemstack)` This function should return a new entity to replace the dropped item.
`boolean`	`doesSneakBypassUse(ItemStack stack, IBlockAccess world, BlockPos pos, EntityPlayer player)` Should this item, when held, allow sneak-clicks to pass through to the underlying block?
`com.google.common.collect.ImmutableMap<java.lang.String,ITimeValue>`	`getAnimationParameters(ItemStack stack, World world, EntityLivingBase entity)`
`ModelBiped`	`getArmorModel(EntityLivingBase entityLiving, ItemStack itemStack, EntityEquipmentSlot armorSlot, ModelBiped _default)` Override this method to have an item handle its own armor rendering.
`java.lang.String`	`getArmorTexture(ItemStack stack, Entity entity, EntityEquipmentSlot slot, java.lang.String type)` Called by RenderBiped and RenderPlayer to determine the armor texture that should be use for the currently equipped item.
`com.google.common.collect.Multimap<java.lang.String,AttributeModifier>`	`getAttributeModifiers(EntityEquipmentSlot slot, ItemStack stack)` ItemStack sensitive version of getItemAttributeModifiers
`static Item`	`getByNameOrId(java.lang.String id)`
`Item`	`getContainerItem()`
`ItemStack`	`getContainerItem(ItemStack itemStack)` ItemStack sensitive version of getContainerItem.
`CreativeTabs`	`getCreativeTab()`
`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.
`java.lang.String`	`getCreatorModId(ItemStack itemStack)` Called to get the Mod ID of the mod that created the ItemStack, instead of the real Mod ID that registered it.
`int`	`getDamage(ItemStack stack)` Return the itemDamage represented by this ItemStack.
`ItemStack`	`getDefaultInstance()`
`float`	`getDestroySpeed(ItemStack stack, IBlockState state)`
`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.
`EntityEquipmentSlot`	`getEquipmentSlot(ItemStack stack)` Override this to set a non-default armor slot for an ItemStack, but do not use this to get the armor slot of said stack; for that, use `EntityLiving.getSlotForItemStack(ItemStack)`.
`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, EntityPlayer player, IBlockState blockState)` Queries the harvest level of this item stack for the specified 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)`
`com.google.common.collect.Multimap<java.lang.String,AttributeModifier>`	`getItemAttributeModifiers(EntityEquipmentSlot equipmentSlot)` Deprecated.
`int`	`getItemBurnTime(ItemStack itemStack)`
`static Item`	`getItemById(int id)`
`int`	`getItemEnchantability()`
`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)`
`int`	`getMaxDamage()` Deprecated.
`int`	`getMaxDamage(ItemStack stack)` Return the maxDamage for this ItemStack.
`int`	`getMaxItemUseDuration(ItemStack stack)`
`int`	`getMetadata(int damage)`
`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.
`NBTTagCompound`	`getNBTShareTag(ItemStack stack)` Override this method to change the NBT data being sent to the client.
`IItemPropertyGetter`	`getPropertyGetter(ResourceLocation key)`
`EnumRarity`	`getRarity(ItemStack stack)`
`int`	`getRGBDurabilityForDisplay(ItemStack stack)` Returns the packed int RGB value used to render the durability bar in the GUI.
`boolean`	`getShareTag()`
`float`	`getSmeltingExperience(ItemStack item)` Determines the base experience for a player when they remove this item from a furnace slot.
`void`	`getSubItems(CreativeTabs tab, NonNullList<ItemStack> items)`
`java.util.Set<java.lang.String>`	`getToolClasses(ItemStack stack)`
`java.lang.String`	`getUnlocalizedName()`
`java.lang.String`	`getUnlocalizedName(ItemStack stack)`
`java.lang.String`	`getUnlocalizedNameInefficiently(ItemStack stack)`
`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`	`hasCustomProperties()`
`boolean`	`hasEffect(ItemStack stack)`
`boolean`	`hitEntity(ItemStack stack, EntityLivingBase target, EntityLivingBase attacker)`
`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`	`isEnchantable(ItemStack stack)`
`boolean`	`isFull3D()`
`protected boolean`	`isInCreativeTab(CreativeTabs targetTab)`
`boolean`	`isMap()`
`boolean`	`isRepairable()` Called by CraftingManager to determine if an item is reparable.
`boolean`	`isShield(ItemStack stack, EntityLivingBase entity)` Is this Item a shield
`boolean`	`isValidArmor(ItemStack stack, EntityEquipmentSlot armorType, Entity entity)` Determines if the specific ItemStack can be placed in the specified armor slot, for the entity.
`boolean`	`itemInteractionForEntity(ItemStack stack, EntityPlayer playerIn, EntityLivingBase target, EnumHand hand)`
`void`	`onArmorTick(World world, EntityPlayer player, ItemStack itemStack)` Called to tick armor in the armor slot.
`boolean`	`onBlockDestroyed(ItemStack stack, World worldIn, IBlockState state, BlockPos pos, EntityLivingBase entityLiving)`
`boolean`	`onBlockStartBreak(ItemStack itemstack, BlockPos pos, EntityPlayer player)` Called before a block is broken.
`void`	`onCreated(ItemStack stack, World worldIn, EntityPlayer playerIn)`
`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.
`ActionResult<ItemStack>`	`onItemRightClick(World worldIn, EntityPlayer playerIn, EnumHand handIn)`
`EnumActionResult`	`onItemUse(EntityPlayer player, World worldIn, BlockPos pos, EnumHand hand, EnumFacing facing, float hitX, float hitY, float hitZ)`
`ItemStack`	`onItemUseFinish(ItemStack stack, World worldIn, EntityLivingBase entityLiving)`
`EnumActionResult`	`onItemUseFirst(EntityPlayer player, World world, BlockPos pos, EnumFacing side, float hitX, float hitY, float hitZ, EnumHand hand)` 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, EntityLivingBase entityLiving, int timeLeft)`
`void`	`onUpdate(ItemStack stack, World worldIn, Entity entityIn, int itemSlot, boolean isSelected)`
`void`	`onUsingTick(ItemStack stack, EntityLivingBase player, int count)` Called each tick while using an item.
`protected RayTraceResult`	`rayTrace(World worldIn, EntityPlayer playerIn, boolean useLiquids)`
`protected static void`	`registerItemBlock(Block blockIn, Item itemIn)`
`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)`
`void`	`setDamage(ItemStack stack, int damage)` Set the damage for this itemstack.
`Item`	`setFull3D()`
`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)`
`Item`	`setMaxStackSize(int maxStackSize)`
`Item`	`setNoRepair()` Call to disable repair recipes.
`Item`	`setUnlocalizedName(java.lang.String unlocalizedName)`
`boolean`	`shouldCauseBlockBreakReset(ItemStack oldStack, ItemStack newStack)` Called when the player is mining a block and the item in his hand changes.
`boolean`	`shouldCauseReequipAnimation(ItemStack oldStack, ItemStack newStack, boolean slotChanged)` Determine if the player switching between these two item stacks
`boolean`	`shouldRotateAroundWhenRendering()`
`boolean`	`showDurabilityBar(ItemStack stack)` Determines if the durability bar should be rendered for this item.
`boolean`	`updateItemStackNBT(NBTTagCompound nbt)`

Methods inherited from class net.minecraftforge.registries.IForgeRegistryEntry.Impl
getRegistryName, getRegistryType, setRegistryName, setRegistryName, setRegistryName

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

- Field Detail
  - REGISTRY
```
public static final RegistryNamespaced<ResourceLocation,Item> REGISTRY
```
  - ATTACK_DAMAGE_MODIFIER
```
protected static final java.util.UUID ATTACK_DAMAGE_MODIFIER
```
  - ATTACK_SPEED_MODIFIER
```
protected static final java.util.UUID ATTACK_SPEED_MODIFIER
```
  - itemRand
```
protected static java.util.Random itemRand
```
  - maxStackSize
```
protected int maxStackSize
```
  - bFull3D
```
protected boolean bFull3D
```
  - hasSubtypes
```
protected boolean hasSubtypes
```
  - 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
```
@Nullable
public static Item getByNameOrId(java.lang.String id)
```
  - addPropertyOverride
```
public final void addPropertyOverride(ResourceLocation key,
                                      IItemPropertyGetter getter)
```
  - getPropertyGetter
```
@Nullable
public IItemPropertyGetter getPropertyGetter(ResourceLocation key)
```
  - updateItemStackNBT
```
public boolean updateItemStackNBT(NBTTagCompound nbt)
```
  - hasCustomProperties
```
public boolean hasCustomProperties()
```
  - setMaxStackSize
```
public Item setMaxStackSize(int maxStackSize)
```
  - onItemUse
```
public EnumActionResult onItemUse(EntityPlayer player,
                                  World worldIn,
                                  BlockPos pos,
                                  EnumHand hand,
                                  EnumFacing facing,
                                  float hitX,
                                  float hitY,
                                  float hitZ)
```
  - getDestroySpeed
```
public float getDestroySpeed(ItemStack stack,
                             IBlockState state)
```
  - onItemRightClick
```
public ActionResult<ItemStack> onItemRightClick(World worldIn,
                                                EntityPlayer playerIn,
                                                EnumHand handIn)
```
  - onItemUseFinish
```
public ItemStack onItemUseFinish(ItemStack stack,
                                 World worldIn,
                                 EntityLivingBase entityLiving)
```
  - getItemStackLimit
```
@Deprecated
public int getItemStackLimit()
```
    Deprecated.
  - getMetadata
```
public int getMetadata(int damage)
```
  - getHasSubtypes
```
public boolean getHasSubtypes()
```
  - setHasSubtypes
```
public Item setHasSubtypes(boolean hasSubtypes)
```
  - getMaxDamage
```
@Deprecated
public int getMaxDamage()
```
    Deprecated.
  - setMaxDamage
```
public Item setMaxDamage(int maxDamageIn)
```
  - isDamageable
```
public boolean isDamageable()
```
  - hitEntity
```
public boolean hitEntity(ItemStack stack,
                         EntityLivingBase target,
                         EntityLivingBase attacker)
```
  - onBlockDestroyed
```
public boolean onBlockDestroyed(ItemStack stack,
                                World worldIn,
                                IBlockState state,
                                BlockPos pos,
                                EntityLivingBase entityLiving)
```
  - canHarvestBlock
```
public boolean canHarvestBlock(IBlockState blockIn)
```
  - itemInteractionForEntity
```
public boolean itemInteractionForEntity(ItemStack stack,
                                        EntityPlayer playerIn,
                                        EntityLivingBase target,
                                        EnumHand hand)
```
  - setFull3D
```
public Item setFull3D()
```
  - isFull3D
```
public boolean isFull3D()
```
  - shouldRotateAroundWhenRendering
```
public boolean shouldRotateAroundWhenRendering()
```
  - setUnlocalizedName
```
public Item setUnlocalizedName(java.lang.String unlocalizedName)
```
  - getUnlocalizedNameInefficiently
```
public java.lang.String getUnlocalizedNameInefficiently(ItemStack stack)
```
  - getUnlocalizedName
```
public java.lang.String getUnlocalizedName()
```
  - getUnlocalizedName
```
public java.lang.String getUnlocalizedName(ItemStack stack)
```
  - setContainerItem
```
public Item setContainerItem(Item containerItem)
```
  - getShareTag
```
public boolean getShareTag()
```
  - getContainerItem
```
@Nullable
public Item getContainerItem()
```
  - hasContainerItem
```
@Deprecated
public boolean hasContainerItem()
```
    Deprecated.
  - onUpdate
```
public void onUpdate(ItemStack stack,
                     World worldIn,
                     Entity entityIn,
                     int itemSlot,
                     boolean isSelected)
```
  - onCreated
```
public void onCreated(ItemStack stack,
                      World worldIn,
                      EntityPlayer playerIn)
```
  - isMap
```
public boolean isMap()
```
  - getItemUseAction
```
public EnumAction getItemUseAction(ItemStack stack)
```
  - getMaxItemUseDuration
```
public int getMaxItemUseDuration(ItemStack stack)
```
  - onPlayerStoppedUsing
```
public void onPlayerStoppedUsing(ItemStack stack,
                                 World worldIn,
                                 EntityLivingBase entityLiving,
                                 int timeLeft)
```
  - addInformation
```
public void addInformation(ItemStack stack,
                           @Nullable
                           World worldIn,
                           java.util.List<java.lang.String> tooltip,
                           ITooltipFlag flagIn)
```
  - getItemStackDisplayName
```
public java.lang.String getItemStackDisplayName(ItemStack stack)
```
  - hasEffect
```
public boolean hasEffect(ItemStack stack)
```
  - getRarity
```
public EnumRarity getRarity(ItemStack stack)
```
  - isEnchantable
```
public boolean isEnchantable(ItemStack stack)
```
  - rayTrace
```
protected RayTraceResult rayTrace(World worldIn,
                                  EntityPlayer playerIn,
                                  boolean useLiquids)
```
  - getItemEnchantability
```
public int getItemEnchantability()
```
  - getSubItems
```
public void getSubItems(CreativeTabs tab,
                        NonNullList<ItemStack> items)
```
  - isInCreativeTab
```
protected boolean isInCreativeTab(CreativeTabs targetTab)
```
  - getCreativeTab
```
@Nullable
public CreativeTabs getCreativeTab()
```
  - setCreativeTab
```
public Item setCreativeTab(CreativeTabs tab)
```
  - canItemEditBlocks
```
public boolean canItemEditBlocks()
```
  - getIsRepairable
```
public boolean getIsRepairable(ItemStack toRepair,
                               ItemStack repair)
```
  - getItemAttributeModifiers
```
@Deprecated
public com.google.common.collect.Multimap<java.lang.String,AttributeModifier> getItemAttributeModifiers(EntityEquipmentSlot equipmentSlot)
```
    Deprecated.
  - getAttributeModifiers
```
public com.google.common.collect.Multimap<java.lang.String,AttributeModifier> getAttributeModifiers(EntityEquipmentSlot slot,
                                                                                                    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.
    
    displayName - the name that will be displayed unless it is changed in this method.
  - onItemUseFirst
```
public EnumActionResult onItemUseFirst(EntityPlayer player,
                                       World world,
                                       BlockPos pos,
                                       EnumFacing side,
                                       float hitX,
                                       float hitY,
                                       float hitZ,
                                       EnumHand hand)
```
    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
    
    hand - Which hand the item is being held in.
    
    Returns:
    
    Return PASS to allow vanilla handling, any other to skip normal code.
  - 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
  - getNBTShareTag
```
@Nullable
public NBTTagCompound getNBTShareTag(ItemStack stack)
```
    Override this method to change the NBT data being sent to the client. You should ONLY override this when you have no other choice, as this might change behavior client side! Note that this will sometimes be applied multiple times, the following MUST be supported: Item item = stack.getItem(); NBTTagCompound nbtShare1 = item.getNBTShareTag(stack); stack.setTagCompound(nbtShare1); NBTTagCompound nbtShare2 = item.getNBTShareTag(stack); assert nbtShare1.equals(nbtShare2);
    
    Parameters:
    
    stack - The stack to send the NBT tag for
    
    Returns:
    
    The NBT tag
  - 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,
                        EntityLivingBase 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.
  - 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
```
@Nullable
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.
  - doesSneakBypassUse
```
public boolean doesSneakBypassUse(ItemStack stack,
                                  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:
  - 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,
                            EntityEquipmentSlot armorType,
                            Entity entity)
```
    Determines if the specific ItemStack can be placed in the specified armor slot, for the entity. TODO: Change name to canEquip in 1.13?
    
    Parameters:
    
    stack - The ItemStack
    
    armorType - Armor slot to be verified.
    
    entity - The entity trying to equip the armor
    
    Returns:
    
    True if the given ItemStack can be inserted in the slot
  - getEquipmentSlot
```
@Nullable
public EntityEquipmentSlot getEquipmentSlot(ItemStack stack)
```
    Override this to set a non-default armor slot for an ItemStack, but do not use this to get the armor slot of said stack; for that, use EntityLiving.getSlotForItemStack(ItemStack).
    
    Parameters:
    
    stack - the ItemStack
    
    Returns:
    
    the armor slot of the ItemStack, or null to let the default vanilla logic as per EntityLiving.getSlotForItemStack(stack) decide
  - 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
```
@Nullable
public java.lang.String getArmorTexture(ItemStack stack,
                                                   Entity entity,
                                                   EntityEquipmentSlot 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
```
@Nullable
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
```
@Nullable
public ModelBiped getArmorModel(EntityLivingBase entityLiving,
                                           ItemStack itemStack,
                                           EntityEquipmentSlot 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 - The slot the armor is in
    
    _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:
    
    0.0 for 100% (no damage / full bar), 1.0 for 0% (fully damaged / empty bar)
  - getRGBDurabilityForDisplay
```
public int getRGBDurabilityForDisplay(ItemStack stack)
```
    Returns the packed int RGB value used to render the durability bar in the GUI. Defaults to a value based on the hue scaled based on getDurabilityForDisplay(net.minecraft.item.ItemStack), but can be overriden.
    
    Parameters:
    
    stack - Stack to get durability from
    
    Returns:
    
    A packed RGB value for the durability colour (0x00RRGGBB)
  - 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
  - canDestroyBlockInCreative
```
public boolean canDestroyBlockInCreative(World world,
                                         BlockPos pos,
                                         ItemStack stack,
                                         EntityPlayer player)
```
    Checked from PlayerControllerMP.onPlayerDestroyBlock() when a creative player left-clicks a block with this item. Also checked from ForgeHooks.onBlockBreakEvent() to prevent sending an event.
    
    Returns:
    
    true if the given player can destroy specified block in creative mode with this item
  - canHarvestBlock
```
public boolean canHarvestBlock(IBlockState state,
                               ItemStack stack)
```
    ItemStack sensitive version of canHarvestBlock(IBlockState)
    
    Parameters:
    
    state - The block trying to harvest
    
    stack - 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,
                           @Nullable
                           EntityPlayer player,
                           @Nullable
                           IBlockState blockState)
```
    Queries the harvest level of this item stack for the specified tool class, Returns -1 if this tool is not of the specified type
    
    Parameters:
    
    stack - This item stack instance
    
    toolClass - Tool Class
    
    player - The player trying to harvest the given blockstate
    
    blockState - The block to harvest
    
    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
  - canApplyAtEnchantingTable
```
public boolean canApplyAtEnchantingTable(ItemStack stack,
                                         Enchantment enchantment)
```
    Checks whether an item can be enchanted with a certain enchantment. This applies specifically to enchanting an item in the enchanting table and is called when retrieving the list of possible enchantments for an item. Enchantments may additionally (or exclusively) be doing their own checks in Enchantment.canApplyAtEnchantingTable(ItemStack); check the individual implementation for reference. By default this will check if the enchantment type is valid for this item type.
    
    Parameters:
    
    stack - the item stack to be enchanted
    
    enchantment - the enchantment to be applied
    
    Returns:
    
    true if the enchantment can be applied to this item
  - 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
  - shouldCauseBlockBreakReset
```
public boolean shouldCauseBlockBreakReset(ItemStack oldStack,
                                          ItemStack newStack)
```
    Called when the player is mining a block and the item in his hand changes. Allows to not reset blockbreaking if only NBT or similar changes.
    
    Parameters:
    
    oldStack - The old stack that was used for mining. Item in players main hand
    
    newStack - The new stack
    
    Returns:
    
    True to reset block break progress
  - getCreatorModId
```
@Nullable
public java.lang.String getCreatorModId(ItemStack itemStack)
```
    Called to get the Mod ID of the mod that *created* the ItemStack, instead of the real Mod ID that *registered* it. For example the Forge Universal Bucket creates a subitem for each modded fluid, and it returns the modded fluid's Mod ID here. Mods that register subitems for other mods can override this. Informational mods can call it to show the mod that created the item.
    
    Parameters:
    
    itemStack - the ItemStack to check
    
    Returns:
    
    the Mod ID for the ItemStack, or null when there is no specially associated mod and IForgeRegistryEntry.Impl.getRegistryName() would return null.
  - initCapabilities
```
@Nullable
public ICapabilityProvider initCapabilities(ItemStack stack,
                                                       @Nullable
                                                       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.
  - getAnimationParameters
```
public com.google.common.collect.ImmutableMap<java.lang.String,ITimeValue> getAnimationParameters(ItemStack stack,
                                                                                                  World world,
                                                                                                  EntityLivingBase entity)
```
  - canDisableShield
```
public boolean canDisableShield(ItemStack stack,
                                ItemStack shield,
                                EntityLivingBase entity,
                                EntityLivingBase attacker)
```
    Can this Item disable a shield
    
    Parameters:
    
    stack - The ItemStack
    
    shield - The shield in question
    
    entity - The EntityLivingBase holding the shield
    
    attacker - The EntityLivingBase holding the ItemStack
  - isShield
```
public boolean isShield(ItemStack stack,
                        @Nullable
                        EntityLivingBase entity)
```
    Is this Item a shield
    
    Parameters:
    
    stack - The ItemStack
    
    entity - The Entity holding the ItemStack
    
    Returns:
    
    True if the ItemStack is considered a shield
  - getItemBurnTime
```
public int getItemBurnTime(ItemStack itemStack)
```
    Returns:
    
    the fuel burn time for this itemStack in a furnace. Return 0 to make it not act as a fuel. Return -1 to let the default vanilla logic decide.
  - registerItems
```
public static void registerItems()
```
  - registerItemBlock
```
protected static void registerItemBlock(Block blockIn,
                                        Item itemIn)
```
  - getDefaultInstance
```
public ItemStack getDefaultInstance()
```

Class Item

Nested Class Summary

Nested classes/interfaces inherited from interface net.minecraftforge.registries.IForgeRegistryEntry

Field Summary

Fields inherited from class net.minecraftforge.registries.IForgeRegistryEntry.Impl

Constructor Summary

Method Summary

Methods inherited from class net.minecraftforge.registries.IForgeRegistryEntry.Impl

Methods inherited from class java.lang.Object

Field Detail

REGISTRY

ATTACK_DAMAGE_MODIFIER

ATTACK_SPEED_MODIFIER

itemRand

maxStackSize

bFull3D

hasSubtypes

canRepair

Constructor Detail

Item

Method Detail

getIdFromItem

getItemById

getItemFromBlock

getByNameOrId

addPropertyOverride

getPropertyGetter

updateItemStackNBT

hasCustomProperties

setMaxStackSize

onItemUse

getDestroySpeed

onItemRightClick

onItemUseFinish

getItemStackLimit

getMetadata

getHasSubtypes

setHasSubtypes

getMaxDamage

setMaxDamage

isDamageable

hitEntity

onBlockDestroyed

canHarvestBlock

itemInteractionForEntity

setFull3D

isFull3D

shouldRotateAroundWhenRendering

setUnlocalizedName

getUnlocalizedNameInefficiently

getUnlocalizedName

getUnlocalizedName

setContainerItem

getShareTag

getContainerItem

hasContainerItem

onUpdate

onCreated

isMap

getItemUseAction

getMaxItemUseDuration

onPlayerStoppedUsing

addInformation

getItemStackDisplayName

hasEffect

getRarity

isEnchantable

rayTrace

getItemEnchantability

getSubItems

isInCreativeTab

getCreativeTab

setCreativeTab

canItemEditBlocks

getIsRepairable

getItemAttributeModifiers

getAttributeModifiers

onDroppedByPlayer

getHighlightTip

onItemUseFirst