net.minecraft.item

Class Item

java.lang.Object

net.minecraftforge.registries.ForgeRegistryEntry<Item>

net.minecraft.item.Item

All Implemented Interfaces:

IItemProvider, IForgeItem, IForgeRegistryEntry<Item>

Direct Known Subclasses:

AbstractMapItem, AirItem, ArmorItem, ArmorStandItem, ArrowItem, BannerPatternItem, BlockItem, BoatItem, BoneMealItem, BookItem, BucketItem, CarrotOnAStickItem, ChorusFruitItem, ClockItem, CompassItem, CustomElytraTest.CustomElytra, DebugStickItem, DyeItem, EggItem, ElytraItem, EnchantedBookItem, EnchantedGoldenAppleItem, EnderCrystalItem, EnderEyeItem, EnderPearlItem, ExperienceBottleItem, FireChargeItem, FireworkRocketItem, FireworkStarItem, FishingRodItem, FlintAndSteelItem, GlassBottleItem, GravityAttributeTest.ItemGravityStick, HangingEntityItem, HoneyBottleItem, HorseArmorItem, ItemFluidContainer, KnowledgeBookItem, LeadItem, MilkBucketItem, MinecartItem, MusicDiscItem, NameTagItem, PotionItem, SaddleItem, ShearsItem, ShieldItem, ShootableItem, SimpleFoiledItem, SnowballItem, SoupItem, SpawnEggItem, SuspiciousStewItem, TieredItem, TridentItem, WritableBookItem, WrittenBookItem

public class Item
extends ForgeRegistryEntry<Item>
implements IItemProvider, IForgeItem

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Item.Properties

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
static java.util.Map<Block,Item>	BLOCK_TO_ITEM
protected boolean	canRepair
private Item	containerItem
private static IItemPropertyGetter	COOLDOWN_GETTER
private static IItemPropertyGetter	DAMAGE_GETTER
private static IItemPropertyGetter	DAMAGED_GETTER
private Food	food
protected ItemGroup	group
private java.util.function.Supplier<ItemStackTileEntityRenderer>	ister
private static IItemPropertyGetter	LEFTHANDED_GETTER
private int	maxDamage
private int	maxStackSize
private static IItemPropertyGetter	MODELDATA_GETTER
java.util.Map<ResourceLocation,IItemPropertyGetter>	properties
protected static java.util.Random	random
private Rarity	rarity
private ReverseTagWrapper<Item>	reverseTags
private java.util.Map<ToolType,java.lang.Integer>	toolClasses
private java.lang.String	translationKey

Fields inherited from class net.minecraftforge.registries.ForgeRegistryEntry

delegate

Constructor Summary

Constructors

Constructor and Description
Item(Item.Properties properties)

Method Summary

Modifier and Type	Method and Description
void	addInformation(ItemStack stack, World worldIn, java.util.List<ITextComponent> tooltip, ITooltipFlag flagIn)
void	addPropertyOverride(ResourceLocation key, IItemPropertyGetter getter)
Item	asItem()
boolean	canHarvestBlock(BlockState blockIn)
boolean	canPlayerBreakBlockWhileHolding(BlockState state, World worldIn, BlockPos pos, PlayerEntity player)
void	fillItemGroup(ItemGroup group, NonNullList<ItemStack> items)
com.google.common.collect.Multimap<java.lang.String,AttributeModifier>	getAttributeModifiers(EquipmentSlotType equipmentSlot) Deprecated.
Item	getContainerItem() Deprecated.
ItemStack	getDefaultInstance()
protected java.lang.String	getDefaultTranslationKey()
float	getDestroySpeed(ItemStack stack, BlockState state)
ITextComponent	getDisplayName(ItemStack stack)
SoundEvent	getDrinkSound()
SoundEvent	getEatSound()
Food	getFood()
ItemGroup	getGroup()
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
static int	getIdFromItem(Item itemIn)
boolean	getIsRepairable(ItemStack toRepair, ItemStack repair)
static Item	getItemById(int id)
int	getItemEnchantability()
static Item	getItemFromBlock(Block blockIn) Deprecated.
ItemStackTileEntityRenderer	getItemStackTileEntityRenderer()
int	getMaxDamage() Deprecated.
int	getMaxStackSize() Deprecated.
ITextComponent	getName()
IItemPropertyGetter	getPropertyGetter(ResourceLocation key)
Rarity	getRarity(ItemStack stack)
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)
java.lang.String	getTranslationKey()
java.lang.String	getTranslationKey(ItemStack stack)
UseAction	getUseAction(ItemStack stack)
int	getUseDuration(ItemStack stack)
boolean	hasContainerItem() Deprecated.
boolean	hasCustomProperties()
boolean	hasEffect(ItemStack stack)
boolean	hitEntity(ItemStack stack, LivingEntity target, LivingEntity attacker)
void	inventoryTick(ItemStack stack, World worldIn, Entity entityIn, int itemSlot, boolean isSelected)
boolean	isComplex()
boolean	isCrossbow(ItemStack stack)
boolean	isDamageable()
boolean	isEnchantable(ItemStack stack)
boolean	isFood()
boolean	isIn(Tag<Item> tagIn)
protected boolean	isInGroup(ItemGroup group)
boolean	isRepairable(ItemStack stack) Called by CraftingManager to determine if an item is reparable.
boolean	itemInteractionForEntity(ItemStack stack, PlayerEntity playerIn, LivingEntity target, Hand hand)
boolean	onBlockDestroyed(ItemStack stack, World worldIn, BlockState state, BlockPos pos, LivingEntity entityLiving)
void	onCreated(ItemStack stack, World worldIn, PlayerEntity playerIn)
ActionResult<ItemStack>	onItemRightClick(World worldIn, PlayerEntity playerIn, Hand handIn)
ActionResultType	onItemUse(ItemUseContext context)
ItemStack	onItemUseFinish(ItemStack stack, World worldIn, LivingEntity entityLiving)
void	onPlayerStoppedUsing(ItemStack stack, World worldIn, LivingEntity entityLiving, int timeLeft)
void	onUse(World worldIn, LivingEntity livingEntityIn, ItemStack stack, int count)
protected static RayTraceResult	rayTrace(World worldIn, PlayerEntity player, RayTraceContext.FluidMode fluidMode)
boolean	shouldSyncTag()
java.lang.String	toString()
boolean	updateItemStackNBT(CompoundNBT nbt)

Methods inherited from class net.minecraftforge.registries.ForgeRegistryEntry

getRegistryName, getRegistryType, setRegistryName, setRegistryName, setRegistryName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.minecraftforge.common.extensions.IForgeItem

canApplyAtEnchantingTable, canContinueUsing, canDisableShield, canElytraFly, canEquip, canHarvestBlock, createEntity, damageItem, doesSneakBypassUse, elytraFlightTick, getAnimationParameters, getArmorModel, getArmorTexture, getAttributeModifiers, getBurnTime, getContainerItem, getCreativeTabs, getCreatorModId, getDamage, getDurabilityForDisplay, getEntityLifespan, getEquipmentSlot, getFontRenderer, getHighlightTip, getItem, getItemEnchantability, getItemStackLimit, getMaxDamage, getRGBDurabilityForDisplay, getShareTag, getSmeltingExperience, getXpRepairRatio, hasContainerItem, hasCustomEntity, initCapabilities, isBeaconPayment, isBookEnchantable, isDamaged, isShield, onArmorTick, onBlockStartBreak, onDroppedByPlayer, onEntityItemUpdate, onEntitySwing, onHorseArmorTick, onItemUseFirst, onLeftClickEntity, onUsingTick, readShareTag, renderHelmetOverlay, setDamage, shouldCauseBlockBreakReset, shouldCauseReequipAnimation, showDurabilityBar

Field Detail

BLOCK_TO_ITEM

public static final java.util.Map<Block,Item> BLOCK_TO_ITEM

DAMAGED_GETTER

private static final IItemPropertyGetter DAMAGED_GETTER

DAMAGE_GETTER

private static final IItemPropertyGetter DAMAGE_GETTER

LEFTHANDED_GETTER

private static final IItemPropertyGetter LEFTHANDED_GETTER

COOLDOWN_GETTER

private static final IItemPropertyGetter COOLDOWN_GETTER

MODELDATA_GETTER

private static final IItemPropertyGetter MODELDATA_GETTER

ATTACK_DAMAGE_MODIFIER

protected static final java.util.UUID ATTACK_DAMAGE_MODIFIER

ATTACK_SPEED_MODIFIER

protected static final java.util.UUID ATTACK_SPEED_MODIFIER

random

protected static final java.util.Random random

properties

public final java.util.Map<ResourceLocation,IItemPropertyGetter> properties

group

protected final ItemGroup group

rarity

private final Rarity rarity

maxStackSize

private final int maxStackSize

maxDamage

private final int maxDamage

containerItem

private final Item containerItem

translationKey

@Nullable
private java.lang.String translationKey

food

@Nullable
private final Food food

ister

@Nullable
private final java.util.function.Supplier<ItemStackTileEntityRenderer> ister

toolClasses

private final java.util.Map<ToolType,java.lang.Integer> toolClasses

reverseTags

private final ReverseTagWrapper<Item> reverseTags

canRepair

protected final boolean canRepair

Constructor Detail

Item

public Item(Item.Properties properties)

Method Detail

getIdFromItem

public static int getIdFromItem(Item itemIn)

getItemById

public static Item getItemById(int id)

getItemFromBlock

@Deprecated
public static Item getItemFromBlock(Block blockIn)

Deprecated.

onUse

public void onUse(World worldIn,
                  LivingEntity livingEntityIn,
                  ItemStack stack,
                  int count)

getPropertyGetter

@Nullable
public IItemPropertyGetter getPropertyGetter(ResourceLocation key)

hasCustomProperties

public boolean hasCustomProperties()

updateItemStackNBT

public boolean updateItemStackNBT(CompoundNBT nbt)

canPlayerBreakBlockWhileHolding

public boolean canPlayerBreakBlockWhileHolding(BlockState state,
                                               World worldIn,
                                               BlockPos pos,
                                               PlayerEntity player)

asItem

public Item asItem()

Specified by:

asItem in interface IItemProvider

addPropertyOverride

public final void addPropertyOverride(ResourceLocation key,
                                      IItemPropertyGetter getter)

onItemUse

public ActionResultType onItemUse(ItemUseContext context)

getDestroySpeed

public float getDestroySpeed(ItemStack stack,
                             BlockState state)

onItemRightClick

public ActionResult<ItemStack> onItemRightClick(World worldIn,
                                                PlayerEntity playerIn,
                                                Hand handIn)

onItemUseFinish

public ItemStack onItemUseFinish(ItemStack stack,
                                 World worldIn,
                                 LivingEntity entityLiving)

getMaxStackSize

@Deprecated
public final int getMaxStackSize()

Deprecated.

getMaxDamage

@Deprecated
public final int getMaxDamage()

Deprecated.

isDamageable

public boolean isDamageable()

hitEntity

public boolean hitEntity(ItemStack stack,
                         LivingEntity target,
                         LivingEntity attacker)

onBlockDestroyed

public boolean onBlockDestroyed(ItemStack stack,
                                World worldIn,
                                BlockState state,
                                BlockPos pos,
                                LivingEntity entityLiving)

canHarvestBlock

public boolean canHarvestBlock(BlockState blockIn)

itemInteractionForEntity

public boolean itemInteractionForEntity(ItemStack stack,
                                        PlayerEntity playerIn,
                                        LivingEntity target,
                                        Hand hand)

getName

public ITextComponent getName()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getDefaultTranslationKey

protected java.lang.String getDefaultTranslationKey()

getTranslationKey

public java.lang.String getTranslationKey()

getTranslationKey

public java.lang.String getTranslationKey(ItemStack stack)

shouldSyncTag

public boolean shouldSyncTag()

getContainerItem

@Nullable
 @Deprecated
public final Item getContainerItem()

Deprecated.

hasContainerItem

@Deprecated
public boolean hasContainerItem()

Deprecated.

inventoryTick

public void inventoryTick(ItemStack stack,
                          World worldIn,
                          Entity entityIn,
                          int itemSlot,
                          boolean isSelected)

onCreated

public void onCreated(ItemStack stack,
                      World worldIn,
                      PlayerEntity playerIn)

isComplex

public boolean isComplex()

getUseAction

public UseAction getUseAction(ItemStack stack)

getUseDuration

public int getUseDuration(ItemStack stack)

onPlayerStoppedUsing

public void onPlayerStoppedUsing(ItemStack stack,
                                 World worldIn,
                                 LivingEntity entityLiving,
                                 int timeLeft)

addInformation

public void addInformation(ItemStack stack,
                           @Nullable
                           World worldIn,
                           java.util.List<ITextComponent> tooltip,
                           ITooltipFlag flagIn)

getDisplayName

public ITextComponent getDisplayName(ItemStack stack)

hasEffect

public boolean hasEffect(ItemStack stack)

getRarity

public Rarity getRarity(ItemStack stack)

isEnchantable

public boolean isEnchantable(ItemStack stack)

rayTrace

protected static RayTraceResult rayTrace(World worldIn,
                                         PlayerEntity player,
                                         RayTraceContext.FluidMode fluidMode)

getItemEnchantability

public int getItemEnchantability()

fillItemGroup

public void fillItemGroup(ItemGroup group,
                          NonNullList<ItemStack> items)

isInGroup

protected boolean isInGroup(ItemGroup group)

getGroup

@Nullable
public final ItemGroup getGroup()

getIsRepairable

public boolean getIsRepairable(ItemStack toRepair,
                               ItemStack repair)

getAttributeModifiers

@Deprecated
public com.google.common.collect.Multimap<java.lang.String,AttributeModifier> getAttributeModifiers(EquipmentSlotType equipmentSlot)

Deprecated.

isRepairable

public boolean isRepairable(ItemStack stack)

Description copied from interface: IForgeItem

Called by CraftingManager to determine if an item is reparable.

Specified by:

isRepairable in interface IForgeItem

Returns:

True if reparable

getToolTypes

public java.util.Set<ToolType> getToolTypes(ItemStack stack)

Specified by:

getToolTypes in interface IForgeItem

getHarvestLevel

public int getHarvestLevel(ItemStack stack,
                           ToolType tool,
                           @Nullable
                           PlayerEntity player,
                           @Nullable
                           BlockState blockState)

Description copied from interface: IForgeItem

Queries the harvest level of this item stack for the specified tool class, Returns -1 if this tool is not of the specified type

Specified by:

getHarvestLevel in interface IForgeItem

Parameters:

stack - This item stack instance

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.

getItemStackTileEntityRenderer

public final ItemStackTileEntityRenderer getItemStackTileEntityRenderer()

Specified by:

getItemStackTileEntityRenderer in interface IForgeItem

Returns:

This Item's renderer, or the default instance if it does not have one.

getTags

public java.util.Set<ResourceLocation> getTags()

Description copied from interface: IForgeItem

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.

Specified by:

getTags in interface IForgeItem

isCrossbow

public boolean isCrossbow(ItemStack stack)

getDefaultInstance

public ItemStack getDefaultInstance()

isIn

public boolean isIn(Tag<Item> tagIn)

isFood

public boolean isFood()

getFood

@Nullable
public Food getFood()

getDrinkSound

public SoundEvent getDrinkSound()

getEatSound

public SoundEvent getEatSound()