IForgeItem (forge 1.15.2-31.2.47)

All Known Implementing Classes:

AbstractMapItem, AirItem, ArmorItem, ArmorStandItem, ArrowItem, AxeItem, BannerItem, BannerPatternItem, BedItem, BlockItem, BlockNamedItem, BoatItem, BoneMealItem, BookItem, BowItem, BucketItem, CarrotOnAStickItem, ChorusFruitItem, ClockItem, CompassItem, CrossbowItem, CustomElytraTest.CustomElytra, DebugStickItem, DyeableArmorItem, DyeableHorseArmorItem, DyeItem, EggItem, ElytraItem, EnchantedBookItem, EnchantedGoldenAppleItem, EnderCrystalItem, EnderEyeItem, EnderPearlItem, ExperienceBottleItem, FilledMapItem, FireChargeItem, FireworkRocketItem, FireworkStarItem, FishBucketItem, FishingRodItem, FlintAndSteelItem, GlassBottleItem, GravityAttributeTest.ItemGravityStick, HangingEntityItem, HoeItem, HoneyBottleItem, HorseArmorItem, Item, ItemFluidContainer, ItemFrameItem, KnowledgeBookItem, LeadItem, LilyPadItem, LingeringPotionItem, MapItem, MilkBucketItem, MinecartItem, MusicDiscItem, NameTagItem, OperatorOnlyItem, PickaxeItem, PotionItem, SaddleItem, ScaffoldingItem, ShearsItem, ShieldItem, ShootableItem, ShovelItem, SignItem, SimpleFoiledItem, SkullItem, SnowballItem, SoupItem, SpawnEggItem, SpectralArrowItem, SplashPotionItem, SuspiciousStewItem, SwordItem, TallBlockItem, ThrowablePotionItem, TieredItem, TippedArrowItem, ToolItem, TridentItem, WallOrFloorItem, WritableBookItem, WrittenBookItem
```
public interface IForgeItem
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default boolean`	`canApplyAtEnchantingTable(ItemStack stack, Enchantment enchantment)` Checks whether an item can be enchanted with a certain enchantment.
`default boolean`	`canContinueUsing(ItemStack oldStack, ItemStack newStack)` Called while an item is in 'active' use to determine if usage should continue.
`default boolean`	`canDisableShield(ItemStack stack, ItemStack shield, LivingEntity entity, LivingEntity attacker)` Can this Item disable a shield
`default boolean`	`canElytraFly(ItemStack stack, LivingEntity entity)` Used to determine if the player can use Elytra flight.
`default boolean`	`canEquip(ItemStack stack, EquipmentSlotType armorType, Entity entity)` Determines if the specific ItemStack can be placed in the specified armor slot, for the entity.
`default boolean`	`canHarvestBlock(ItemStack stack, BlockState state)` ItemStack sensitive version of `#canHarvestBlock(IBlockState)`
`default Entity`	`createEntity(World world, Entity location, ItemStack itemstack)` This function should return a new entity to replace the dropped item.
`default <T extends LivingEntity> int`	`damageItem(ItemStack stack, int amount, T entity, java.util.function.Consumer<T> onBroken)` Reduce the durability of this item by the amount given.
`default boolean`	`doesSneakBypassUse(ItemStack stack, IWorldReader world, BlockPos pos, PlayerEntity player)` Should this item, when held, allow sneak-clicks to pass through to the underlying block?
`default boolean`	`elytraFlightTick(ItemStack stack, LivingEntity entity, int flightTicks)` Used to determine if the player can continue Elytra flight, this is called each tick, and can be used to apply ItemStack damage, consume Energy, or what have you.
`default com.google.common.collect.ImmutableMap<java.lang.String,ITimeValue>`	`getAnimationParameters(ItemStack stack, World world, LivingEntity entity)`
`default <A extends BipedModel<?>> A`	`getArmorModel(LivingEntity entityLiving, ItemStack itemStack, EquipmentSlotType armorSlot, A _default)` Override this method to have an item handle its own armor rendering.
`default java.lang.String`	`getArmorTexture(ItemStack stack, Entity entity, EquipmentSlotType slot, java.lang.String type)` Called by RenderBiped and RenderPlayer to determine the armor texture that should be use for the currently equipped item.
`default com.google.common.collect.Multimap<java.lang.String,AttributeModifier>`	`getAttributeModifiers(EquipmentSlotType slot, ItemStack stack)` ItemStack sensitive version of getItemAttributeModifiers
`default int`	`getBurnTime(ItemStack itemStack)`
`default ItemStack`	`getContainerItem(ItemStack itemStack)` ItemStack sensitive version of getContainerItem.
`default java.util.Collection<ItemGroup>`	`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.
`default 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.
`default int`	`getDamage(ItemStack stack)` Return the itemDamage represented by this ItemStack.
`default double`	`getDurabilityForDisplay(ItemStack stack)` Queries the percentage of the 'Durability' bar that should be drawn.
`default int`	`getEntityLifespan(ItemStack itemStack, World world)` Retrieves the normal 'lifespan' of this item when it is dropped on the ground as a EntityItem.
`default EquipmentSlotType`	`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 `net.minecraft.entity.EntityLiving#getSlotForItemStack(ItemStack)`.
`default FontRenderer`	`getFontRenderer(ItemStack stack)` Returns the font renderer used to render tooltips and overlays for this item.
`int`	`getHarvestLevel(ItemStack stack, ToolType tool, PlayerEntity player, BlockState 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
`default 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.
`default Item`	`getItem()`
`default int`	`getItemEnchantability(ItemStack stack)` ItemStack sensitive version of getItemEnchantability
`default int`	`getItemStackLimit(ItemStack stack)` Gets the maximum number of items that this stack should be able to hold.
`ItemStackTileEntityRenderer`	`getItemStackTileEntityRenderer()`
`default int`	`getMaxDamage(ItemStack stack)` Return the maxDamage for this ItemStack.
`default int`	`getRGBDurabilityForDisplay(ItemStack stack)` Returns the packed int RGB value used to render the durability bar in the GUI.
`default CompoundNBT`	`getShareTag(ItemStack stack)` Override this method to change the NBT data being sent to the client.
`default float`	`getSmeltingExperience(ItemStack item)` Determines the base experience for a player when they remove this item from a furnace slot.
`java.util.Set<ResourceLocation>`	`getTags()` Retrieves a list of tags names this is known to be associated with.
`java.util.Set<ToolType>`	`getToolTypes(ItemStack stack)`
`default float`	`getXpRepairRatio(ItemStack stack)` Determines the amount of durability the mending enchantment will repair, on average, per point of experience.
`default boolean`	`hasContainerItem(ItemStack stack)` ItemStack sensitive version of hasContainerItem
`default boolean`	`hasCustomEntity(ItemStack stack)` Determines if this Item has a special entity for when they are in the world.
`default ICapabilityProvider`	`initCapabilities(ItemStack stack, CompoundNBT nbt)` Called from ItemStack.setItem, will hold extra data for the life of this ItemStack.
`default boolean`	`isBeaconPayment(ItemStack stack)` Whether this Item can be used as a payment to activate the vanilla beacon.
`default boolean`	`isBookEnchantable(ItemStack stack, ItemStack book)` Allow or forbid the specific book/item combination as an anvil enchant
`default boolean`	`isDamaged(ItemStack stack)` Return if this itemstack is damaged.
`boolean`	`isRepairable(ItemStack stack)` Called by CraftingManager to determine if an item is reparable.
`default boolean`	`isShield(ItemStack stack, LivingEntity entity)` Is this Item a shield
`default void`	`onArmorTick(ItemStack stack, World world, PlayerEntity player)` Called to tick armor in the armor slot.
`default boolean`	`onBlockStartBreak(ItemStack itemstack, BlockPos pos, PlayerEntity player)` Called before a block is broken.
`default boolean`	`onDroppedByPlayer(ItemStack item, PlayerEntity 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
`default boolean`	`onEntityItemUpdate(ItemStack stack, ItemEntity entity)` 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.
`default boolean`	`onEntitySwing(ItemStack stack, LivingEntity entity)` Called when a entity tries to play the 'swing' animation.
`default void`	`onHorseArmorTick(ItemStack stack, World world, MobEntity horse)` Called every tick from `EntityHorse#onUpdate()` on the item in the armor slot.
`default ActionResultType`	`onItemUseFirst(ItemStack stack, ItemUseContext context)` This is called when the item is used, before the block is activated.
`default boolean`	`onLeftClickEntity(ItemStack stack, PlayerEntity player, Entity entity)` Called when the player Left Clicks (attacks) an entity.
`default void`	`onUsingTick(ItemStack stack, LivingEntity player, int count)` Called each tick while using an item.
`default void`	`readShareTag(ItemStack stack, CompoundNBT nbt)` Override this method to decide what to do with the NBT data received from getNBTShareTag().
`default void`	`renderHelmetOverlay(ItemStack stack, PlayerEntity player, int width, int height, float partialTicks)` Called when the client starts rendering the HUD, for whatever item the player currently has as a helmet.
`default void`	`setDamage(ItemStack stack, int damage)` Set the damage for this itemstack.
`default boolean`	`shouldCauseBlockBreakReset(ItemStack oldStack, ItemStack newStack)` Called when the player is mining a block and the item in his hand changes.
`default boolean`	`shouldCauseReequipAnimation(ItemStack oldStack, ItemStack newStack, boolean slotChanged)` Determine if the player switching between these two item stacks
`default boolean`	`showDurabilityBar(ItemStack stack)` Determines if the durability bar should be rendered for this item.

- Method Detail
  - getItem
```
default Item getItem()
```
  - getAttributeModifiers
```
default com.google.common.collect.Multimap<java.lang.String,AttributeModifier> getAttributeModifiers(EquipmentSlotType slot,
                                                                                                     ItemStack stack)
```
    ItemStack sensitive version of getItemAttributeModifiers
  - onDroppedByPlayer
```
default boolean onDroppedByPlayer(ItemStack item,
                                  PlayerEntity 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
```
default 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
```
default ActionResultType onItemUseFirst(ItemStack stack,
                                        ItemUseContext context)
```
    This is called when the item is used, before the block is activated.
    
    Returns:
    
    Return PASS to allow vanilla handling, any other to skip normal code.
  - isRepairable
```
boolean isRepairable(ItemStack stack)
```
    Called by CraftingManager to determine if an item is reparable.
    
    Returns:
    
    True if reparable
  - getXpRepairRatio
```
default float getXpRepairRatio(ItemStack stack)
```
    Determines the amount of durability the mending enchantment will repair, on average, per point of experience.
  - getShareTag
```
@Nullable
default CompoundNBT getShareTag(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
  - readShareTag
```
default void readShareTag(ItemStack stack,
                          @Nullable
                          CompoundNBT nbt)
```
    Override this method to decide what to do with the NBT data received from getNBTShareTag().
    
    Parameters:
    
    stack - The stack that received NBT
    
    nbt - Received NBT, can be null
  - onBlockStartBreak
```
default boolean onBlockStartBreak(ItemStack itemstack,
                                  BlockPos pos,
                                  PlayerEntity 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
```
default void onUsingTick(ItemStack stack,
                         LivingEntity 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
```
default boolean onLeftClickEntity(ItemStack stack,
                                  PlayerEntity 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
```
default 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
```
default boolean hasContainerItem(ItemStack stack)
```
    ItemStack sensitive version of hasContainerItem
    
    Parameters:
    
    stack - The current item stack
    
    Returns:
    
    True if this item has a 'container'
  - getEntityLifespan
```
default 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
```
default 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
default 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
```
default boolean onEntityItemUpdate(ItemStack stack,
                                   ItemEntity entity)
```
    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:
    
    entity - The entity Item
    
    Returns:
    
    Return true to skip any further update code.
  - getCreativeTabs
```
default java.util.Collection<ItemGroup> 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
```
default 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
```
default boolean doesSneakBypassUse(ItemStack stack,
                                   IWorldReader world,
                                   BlockPos pos,
                                   PlayerEntity 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
```
default void onArmorTick(ItemStack stack,
                         World world,
                         PlayerEntity player)
```
    Called to tick armor in the armor slot. Override to do something
  - canEquip
```
default boolean canEquip(ItemStack stack,
                         EquipmentSlotType armorType,
                         Entity entity)
```
    Determines if the specific ItemStack can be placed in the specified armor slot, for the entity.
    
    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
default EquipmentSlotType 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 net.minecraft.entity.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
```
default 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
default java.lang.String getArmorTexture(ItemStack stack,
                                                   Entity entity,
                                                   EquipmentSlotType 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
default 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
default <A extends BipedModel<?>> A getArmorModel(LivingEntity entityLiving,
                                                            ItemStack itemStack,
                                                            EquipmentSlotType armorSlot,
                                                            A _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
```
default boolean onEntitySwing(ItemStack stack,
                              LivingEntity entity)
```
    Called when a entity tries to play the 'swing' animation.
    
    Parameters:
    
    entity - The entity swinging the item.
    
    Returns:
    
    True to cancel any further processing by EntityLiving
  - renderHelmetOverlay
```
default void renderHelmetOverlay(ItemStack stack,
                                 PlayerEntity player,
                                 int width,
                                 int height,
                                 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
```
default int getDamage(ItemStack stack)
```
    Return the itemDamage represented by this ItemStack. Defaults to the Damage entry in the stack NBT, but can be overridden here for other sources.
    
    Parameters:
    
    stack - The itemstack that is damaged
    
    Returns:
    
    the damage value
  - showDurabilityBar
```
default 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
```
default 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
```
default 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
```
default 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
```
default 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
```
default 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
```
default boolean canHarvestBlock(ItemStack stack,
                                BlockState state)
```
    ItemStack sensitive version of #canHarvestBlock(IBlockState)
    
    Parameters:
    
    stack - The itemstack used to harvest the block
    
    state - The block trying to harvest
    
    Returns:
    
    true if can harvest the block
  - getItemStackLimit
```
default 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
  - getToolTypes
```
java.util.Set<ToolType> getToolTypes(ItemStack stack)
```
  - getHarvestLevel
```
int getHarvestLevel(ItemStack stack,
                    ToolType tool,
                    @Nullable
                    PlayerEntity player,
                    @Nullable
                    BlockState 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
```
default int getItemEnchantability(ItemStack stack)
```
    ItemStack sensitive version of getItemEnchantability
    
    Parameters:
    
    stack - The ItemStack
    
    Returns:
    
    the item echantability value
  - canApplyAtEnchantingTable
```
default 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
```
default 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
```
default 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
```
default 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
  - canContinueUsing
```
default boolean canContinueUsing(ItemStack oldStack,
                                 ItemStack newStack)
```
    Called while an item is in 'active' use to determine if usage should continue. Allows items to continue being used while sustaining damage, for example.
    
    Parameters:
    
    oldStack - the previous 'active' stack
    
    newStack - the stack currently in the active hand
    
    Returns:
    
    true to set the new stack to active and continue using it
  - getCreatorModId
```
@Nullable
default 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 #getRegistryName() would return null.
  - initCapabilities
```
@Nullable
default ICapabilityProvider initCapabilities(ItemStack stack,
                                                       @Nullable
                                                       CompoundNBT 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
```
default com.google.common.collect.ImmutableMap<java.lang.String,ITimeValue> getAnimationParameters(ItemStack stack,
                                                                                                   World world,
                                                                                                   LivingEntity entity)
```
  - canDisableShield
```
default boolean canDisableShield(ItemStack stack,
                                 ItemStack shield,
                                 LivingEntity entity,
                                 LivingEntity 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
```
default boolean isShield(ItemStack stack,
                         @Nullable
                         LivingEntity 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
  - getBurnTime
```
default int getBurnTime(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.
  - onHorseArmorTick
```
default void onHorseArmorTick(ItemStack stack,
                              World world,
                              MobEntity horse)
```
    Called every tick from EntityHorse#onUpdate() on the item in the armor slot.
    
    Parameters:
    
    stack - the armor itemstack
    
    world - the world the horse is in
    
    horse - the horse wearing this armor
  - getItemStackTileEntityRenderer
```
ItemStackTileEntityRenderer getItemStackTileEntityRenderer()
```
    Returns:
    
    This Item's renderer, or the default instance if it does not have one.
  - getTags
```
java.util.Set<ResourceLocation> getTags()
```
    Retrieves a list of tags names this is known to be associated with. This should be used in favor of TagCollection.getOwningTags, as this caches the result and automatically updates when the TagCollection changes.
  - damageItem
```
default <T extends LivingEntity> int damageItem(ItemStack stack,
                                                int amount,
                                                T entity,
                                                java.util.function.Consumer<T> onBroken)
```
    Reduce the durability of this item by the amount given. This can be used to e.g. consume power from NBT before durability.
    
    Parameters:
    
    stack - The itemstack to damage
    
    amount - The amount to damage
    
    entity - The entity damaging the item
    
    onBroken - The on-broken callback from vanilla
    
    Returns:
    
    The amount of damage to pass to the vanilla logic
  - canElytraFly
```
default boolean canElytraFly(ItemStack stack,
                             LivingEntity entity)
```
    Used to determine if the player can use Elytra flight. This is called Client and Server side.
    
    Parameters:
    
    stack - The ItemStack in the Chest slot of the entity.
    
    entity - The entity trying to fly.
    
    Returns:
    
    True if the entity can use Elytra flight.
  - elytraFlightTick
```
default boolean elytraFlightTick(ItemStack stack,
                                 LivingEntity entity,
                                 int flightTicks)
```
    Used to determine if the player can continue Elytra flight, this is called each tick, and can be used to apply ItemStack damage, consume Energy, or what have you. For example the Vanilla implementation of this, applies damage to the ItemStack every 20 ticks.
    
    Parameters:
    
    stack - ItemStack in the Chest slot of the entity.
    
    entity - The entity currently in Elytra flight.
    
    flightTicks - The number of ticks the entity has been Elytra flying for.
    
    Returns:
    
    True if the entity should continue Elytra flight or False to stop.

Interface IForgeItem

Method Summary

Method Detail

getItem

getAttributeModifiers

onDroppedByPlayer

getHighlightTip

onItemUseFirst

isRepairable

getXpRepairRatio

getShareTag

readShareTag

onBlockStartBreak

onUsingTick

onLeftClickEntity

getContainerItem

hasContainerItem

getEntityLifespan

hasCustomEntity

createEntity

onEntityItemUpdate

getCreativeTabs

getSmeltingExperience

doesSneakBypassUse

onArmorTick

canEquip

getEquipmentSlot

isBookEnchantable

getArmorTexture

getFontRenderer

getArmorModel

onEntitySwing

renderHelmetOverlay

getDamage

showDurabilityBar

getDurabilityForDisplay

getRGBDurabilityForDisplay

getMaxDamage

isDamaged

setDamage

canHarvestBlock

getItemStackLimit

getToolTypes

getHarvestLevel

getItemEnchantability

canApplyAtEnchantingTable

isBeaconPayment

shouldCauseReequipAnimation

shouldCauseBlockBreakReset

canContinueUsing

getCreatorModId

initCapabilities

getAnimationParameters

canDisableShield

isShield

getBurnTime

onHorseArmorTick

getItemStackTileEntityRenderer

getTags

damageItem

canElytraFly

elytraFlightTick