Class Item
- All Implemented Interfaces:
ItemConvertible
,ToggleableFeature
- Direct Known Subclasses:
AirBlockItem
,ArmorItem
,ArmorStandItem
,ArrowItem
,BannerPatternItem
,BlockItem
,BoatItem
,BoneMealItem
,BookItem
,BrushItem
,BucketItem
,BundleItem
,ChorusFruitItem
,CompassItem
,DebugStickItem
,DecorationItem
,DiscFragmentItem
,DyeItem
,EggItem
,ElytraItem
,EnchantedBookItem
,EnchantedGoldenAppleItem
,EndCrystalItem
,EnderEyeItem
,EnderPearlItem
,ExperienceBottleItem
,FireChargeItem
,FireworkRocketItem
,FireworkStarItem
,FishingRodItem
,FlintAndSteelItem
,GlassBottleItem
,GlowInkSacItem
,GoatHornItem
,HoneyBottleItem
,HoneycombItem
,HorseArmorItem
,InkSacItem
,KnowledgeBookItem
,LeadItem
,MilkBucketItem
,MinecartItem
,MusicDiscItem
,NameTagItem
,NetherStarItem
,NetworkSyncedItem
,OnAStickItem
,PotionItem
,RangedWeaponItem
,SaddleItem
,ShearsItem
,ShieldItem
,SmithingTemplateItem
,SnowballItem
,SpawnEggItem
,SpyglassItem
,StewItem
,SuspiciousStewItem
,ToolItem
,TridentItem
,WritableBookItem
,WrittenBookItem
Like Block
, this class handles logics for a type of item, and does not
hold any data. Any data about a particular stack of item in a world, such as item count,
is held by an ItemStack
which represents a stack of specific item. Therefore,
there is one - and only one - instance of Item for one item (like apples, oak planks, etc),
while there can be infinite amounts of ItemStack
instances. This also means that
items themselves cannot hold NBT data.
Items with no custom behavior, like diamonds, can call the constructor of Item
directly. If a custom behavior is needed, this should be subclassed. Items also have
to be registered in the Registries.ITEM
registry.
Many methods of this class are called on both the logical client and logical server,
so take caution when using those methods. The logical side can be checked using
World.isClient
. See also
the Fabric Wiki article. It is also important that methods that take LivingEntity
as an argument can be called by non-players (such as foxes eating food), which causes
a crash if the code performs unchecked casting.
- See Also:
- Mappings:
Namespace Name official cmt
intermediary net/minecraft/class_1792
named net/minecraft/item/Item
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
Item settings configure behaviors common to all items, such as the stack's max count. -
Field Summary
Modifier and TypeFieldDescriptionprotected static final UUID
protected static final UUID
static final int
static final int
private final boolean
private final @Nullable FoodComponent
static final int
private static final Logger
private final int
private final int
private final Rarity
private final RegistryEntry.Reference<Item>
private final FeatureSet
Fields inherited from interface net.minecraft.resource.featuretoggle.ToggleableFeature
FEATURE_ENABLED_REGISTRY_KEYS
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
appendTooltip
(ItemStack stack, @Nullable World world, List<Text> tooltip, TooltipContext context) Called by the client to append tooltips to an item.asItem()
Gets this object in its item form.static Item
byRawId
(int id) Returns the item from its raw ID.boolean
boolean
canMine
(BlockState state, World world, BlockPos pos, PlayerEntity miner) Returns whether a player can break a block while holding the item.boolean
Returns whetherstack
can be repaired usingingredient
.boolean
damage
(DamageSource source) Returns whether this item can be damaged by the givensource
.finishUsing
(ItemStack stack, World world, LivingEntity user) Called when an entity finishes using the item, such as eating food or drinking a potion.static Item
Deprecated.Returns the attribute modifiers the item provides.Returns the default stack for this item.Returns the sound for drinking the item.Returns the sound for eating the item.int
Gets the enchantability of an item.Returns this item'sFoodComponent
, ornull
if none was set.int
getItemBarColor
(ItemStack stack) Returns the RGB color of the item bar, usually used for durability display.int
getItemBarStep
(ItemStack stack) Returns the step, or the length of the colored area of the item bar, forstack
.final int
Returns the maximum stack count of any ItemStack with this item.final int
Returns the maximum durability of this item.int
getMaxUseTime
(ItemStack stack) Returns the maximum use (right-click) time of this item, in ticks.float
getMiningSpeedMultiplier
(ItemStack stack, BlockState state) Returns the multiplier applied to the mining speed ofstack
when miningstate
.getName()
protected String
Returns this item's rarity, which changes the color of its name.static int
Returns the raw ID ofitem
, or 0 if passednull
.Gets the remainder item that should be left behind when this item is used as a crafting ingredient.Deprecated.getTooltipData
(ItemStack stack) Gets the translation key of this item.getTranslationKey
(ItemStack stack) Gets the translation key of this item using the provided item stack for context.getUseAction
(ItemStack stack) Returns the use action the item should perform.boolean
Checks if the glint effect should be applied when the item is rendered.boolean
Checks if this item has a remainder item that is left behind when used as a crafting ingredient.void
inventoryTick
(ItemStack stack, World world, Entity entity, int slot, boolean selected) Called on both the client and the server every tick if the item is in the player's inventory.boolean
Returns whether this item can lose durability.boolean
isEnchantable
(ItemStack stack) Returns whether the givenItemStack
is enchantable.boolean
Returns whether this item is immune to fire and lava damage.boolean
isFood()
Checks if this item is food and therefore is edible.boolean
isItemBarVisible
(ItemStack stack) Returns whether to show the item bar forstack
.boolean
Checks if an item should have its NBT data stored inItemStack.nbt
sent to the client.boolean
Returns whether the item needs to sync additional data to clients.boolean
isSuitableFor
(BlockState state) Determines whether this item can be used as a suitable tool for mining the specified block.boolean
isUsedOnRelease
(ItemStack stack) boolean
onClicked
(ItemStack stack, ItemStack otherStack, Slot slot, ClickType clickType, PlayerEntity player, StackReference cursorStackReference) Called when the item atslot
gets clicked by the cursor holdingotherStack
.void
Called when the item is made by crafting, smelting, smithing, etc.void
onCraftByPlayer
(ItemStack stack, World world, PlayerEntity player) Called when a player acquires the item by crafting, smelting, smithing, etc.void
onItemEntityDestroyed
(ItemEntity entity) Called on the server when anItemEntity
holding this item gets destroyed.boolean
onStackClicked
(ItemStack stack, Slot slot, ClickType clickType, PlayerEntity player) Called when the item at the cursor is clicked atslot
.void
onStoppedUsing
(ItemStack stack, World world, LivingEntity user, int remainingUseTicks) Called on both the client and the server when an entity stops using an item before reaching the maximum use time.boolean
postHit
(ItemStack stack, LivingEntity target, LivingEntity attacker) Called on the server when the item is used to hit an entity.boolean
postMine
(ItemStack stack, World world, BlockState state, BlockPos pos, LivingEntity miner) Called on the server when the item is used to break a block.void
Processes the NBT applied to an item stack of this item.protected static BlockHitResult
raycast
(World world, PlayerEntity player, RaycastContext.FluidHandling fluidHandling) toString()
void
usageTick
(World world, LivingEntity user, ItemStack stack, int remainingUseTicks) Called on both the server and the client every tick while an entity uses the item.use
(World world, PlayerEntity user, Hand hand) Called when the player uses (or starts using) the item.useOnBlock
(ItemUsageContext context) Called when an item is used on a block.useOnEntity
(ItemStack stack, PlayerEntity user, LivingEntity entity, Hand hand) Called on both the client and the server when a player uses the item on an entity.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface net.minecraft.resource.featuretoggle.ToggleableFeature
isEnabled
-
Field Details
-
LOGGER
- Mappings:
Namespace Name Mixin selector official a
Lcmt;a:Lorg/slf4j/Logger;
intermediary field_27017
Lnet/minecraft/class_1792;field_27017:Lorg/slf4j/Logger;
named LOGGER
Lnet/minecraft/item/Item;LOGGER:Lorg/slf4j/Logger;
-
BLOCK_ITEMS
- Mappings:
Namespace Name Mixin selector official l
Lcmt;l:Ljava/util/Map;
intermediary field_8003
Lnet/minecraft/class_1792;field_8003:Ljava/util/Map;
named BLOCK_ITEMS
Lnet/minecraft/item/Item;BLOCK_ITEMS:Ljava/util/Map;
-
ATTACK_DAMAGE_MODIFIER_ID
- Mappings:
Namespace Name Mixin selector official m
Lcmt;m:Ljava/util/UUID;
intermediary field_8006
Lnet/minecraft/class_1792;field_8006:Ljava/util/UUID;
named ATTACK_DAMAGE_MODIFIER_ID
Lnet/minecraft/item/Item;ATTACK_DAMAGE_MODIFIER_ID:Ljava/util/UUID;
-
ATTACK_SPEED_MODIFIER_ID
- Mappings:
Namespace Name Mixin selector official n
Lcmt;n:Ljava/util/UUID;
intermediary field_8001
Lnet/minecraft/class_1792;field_8001:Ljava/util/UUID;
named ATTACK_SPEED_MODIFIER_ID
Lnet/minecraft/item/Item;ATTACK_SPEED_MODIFIER_ID:Ljava/util/UUID;
-
DEFAULT_MAX_COUNT
public static final int DEFAULT_MAX_COUNT- See Also:
- Mappings:
Namespace Name Mixin selector official o
Lcmt;o:I
intermediary field_30887
Lnet/minecraft/class_1792;field_30887:I
named DEFAULT_MAX_COUNT
Lnet/minecraft/item/Item;DEFAULT_MAX_COUNT:I
-
DEFAULT_MAX_USE_TIME
public static final int DEFAULT_MAX_USE_TIME- See Also:
- Mappings:
Namespace Name Mixin selector official p
Lcmt;p:I
intermediary field_30888
Lnet/minecraft/class_1792;field_30888:I
named DEFAULT_MAX_USE_TIME
Lnet/minecraft/item/Item;DEFAULT_MAX_USE_TIME:I
-
ITEM_BAR_STEPS
public static final int ITEM_BAR_STEPS- See Also:
- Mappings:
Namespace Name Mixin selector official q
Lcmt;q:I
intermediary field_30889
Lnet/minecraft/class_1792;field_30889:I
named ITEM_BAR_STEPS
Lnet/minecraft/item/Item;ITEM_BAR_STEPS:I
-
registryEntry
- Mappings:
Namespace Name Mixin selector official b
Lcmt;b:Lih$c;
intermediary field_36401
Lnet/minecraft/class_1792;field_36401:Lnet/minecraft/class_6880$class_6883;
named registryEntry
Lnet/minecraft/item/Item;registryEntry:Lnet/minecraft/registry/entry/RegistryEntry$Reference;
-
rarity
- Mappings:
Namespace Name Mixin selector official c
Lcmt;c:Lcnp;
intermediary field_8009
Lnet/minecraft/class_1792;field_8009:Lnet/minecraft/class_1814;
named rarity
Lnet/minecraft/item/Item;rarity:Lnet/minecraft/util/Rarity;
-
maxCount
private final int maxCount- Mappings:
Namespace Name Mixin selector official d
Lcmt;d:I
intermediary field_8013
Lnet/minecraft/class_1792;field_8013:I
named maxCount
Lnet/minecraft/item/Item;maxCount:I
-
maxDamage
private final int maxDamage- Mappings:
Namespace Name Mixin selector official e
Lcmt;e:I
intermediary field_8012
Lnet/minecraft/class_1792;field_8012:I
named maxDamage
Lnet/minecraft/item/Item;maxDamage:I
-
fireproof
private final boolean fireproof- Mappings:
Namespace Name Mixin selector official f
Lcmt;f:Z
intermediary field_21979
Lnet/minecraft/class_1792;field_21979:Z
named fireproof
Lnet/minecraft/item/Item;fireproof:Z
-
recipeRemainder
- Mappings:
Namespace Name Mixin selector official g
Lcmt;g:Lcmt;
intermediary field_8008
Lnet/minecraft/class_1792;field_8008:Lnet/minecraft/class_1792;
named recipeRemainder
Lnet/minecraft/item/Item;recipeRemainder:Lnet/minecraft/item/Item;
-
translationKey
- Mappings:
Namespace Name Mixin selector official h
Lcmt;h:Ljava/lang/String;
intermediary field_8014
Lnet/minecraft/class_1792;field_8014:Ljava/lang/String;
named translationKey
Lnet/minecraft/item/Item;translationKey:Ljava/lang/String;
-
foodComponent
- Mappings:
Namespace Name Mixin selector official i
Lcmt;i:Lchy;
intermediary field_18672
Lnet/minecraft/class_1792;field_18672:Lnet/minecraft/class_4174;
named foodComponent
Lnet/minecraft/item/Item;foodComponent:Lnet/minecraft/item/FoodComponent;
-
requiredFeatures
- Mappings:
Namespace Name Mixin selector official j
Lcmt;j:Lchs;
intermediary field_40209
Lnet/minecraft/class_1792;field_40209:Lnet/minecraft/class_7699;
named requiredFeatures
Lnet/minecraft/item/Item;requiredFeatures:Lnet/minecraft/resource/featuretoggle/FeatureSet;
-
-
Constructor Details
-
Item
- Mappings:
Namespace Name Mixin selector official <init>
Lcmt;<init>(Lcmt$a;)V
intermediary <init>
Lnet/minecraft/class_1792;<init>(Lnet/minecraft/class_1792$class_1793;)V
named <init>
Lnet/minecraft/item/Item;<init>(Lnet/minecraft/item/Item$Settings;)V
-
-
Method Details
-
getRawId
Returns the raw ID ofitem
, or 0 if passednull
.- Returns:
- the raw ID of
item
, or 0 if passednull
- Mappings:
Namespace Name Mixin selector official a
Lcmt;a(Lcmt;)I
intermediary method_7880
Lnet/minecraft/class_1792;method_7880(Lnet/minecraft/class_1792;)I
named getRawId
Lnet/minecraft/item/Item;getRawId(Lnet/minecraft/item/Item;)I
-
byRawId
Returns the item from its raw ID.- Returns:
- the item from its raw ID
- Mappings:
Namespace Name Mixin selector official b
Lcmt;b(I)Lcmt;
intermediary method_7875
Lnet/minecraft/class_1792;method_7875(I)Lnet/minecraft/class_1792;
named byRawId
Lnet/minecraft/item/Item;byRawId(I)Lnet/minecraft/item/Item;
-
fromBlock
Deprecated.Please useBlock.asItem()
- Mappings:
Namespace Name Mixin selector official a
Lcmt;a(Lcwq;)Lcmt;
intermediary method_7867
Lnet/minecraft/class_1792;method_7867(Lnet/minecraft/class_2248;)Lnet/minecraft/class_1792;
named fromBlock
Lnet/minecraft/item/Item;fromBlock(Lnet/minecraft/block/Block;)Lnet/minecraft/item/Item;
-
getRegistryEntry
Deprecated.- Mappings:
Namespace Name Mixin selector official j
Lcmt;j()Lih$c;
intermediary method_40131
Lnet/minecraft/class_1792;method_40131()Lnet/minecraft/class_6880$class_6883;
named getRegistryEntry
Lnet/minecraft/item/Item;getRegistryEntry()Lnet/minecraft/registry/entry/RegistryEntry$Reference;
-
usageTick
Called on both the server and the client every tick while an entity uses the item. Currently used byCrossbowItem
to charge the crossbow. If this is overridden,getMaxUseTime(net.minecraft.item.ItemStack)
should also be overridden to return a positive value.- Parameters:
remainingUseTicks
- how long it's left until the entity finishes using the item, in ticks- See Also:
- Mappings:
Namespace Name Mixin selector official a
Lcmt;a(Lctp;Lbml;Lcmy;I)V
intermediary method_7852
Lnet/minecraft/class_1792;method_7852(Lnet/minecraft/class_1937;Lnet/minecraft/class_1309;Lnet/minecraft/class_1799;I)V
named usageTick
Lnet/minecraft/item/Item;usageTick(Lnet/minecraft/world/World;Lnet/minecraft/entity/LivingEntity;Lnet/minecraft/item/ItemStack;I)V
-
onItemEntityDestroyed
Called on the server when anItemEntity
holding this item gets destroyed. This can happen due to fire, lava, cactus, explosion, etc. Items that can hold other items should override this to drop its contents.- See Also:
- Mappings:
Namespace Name Mixin selector official a
Lcmt;a(Lcbu;)V
intermediary method_33261
Lnet/minecraft/class_1792;method_33261(Lnet/minecraft/class_1542;)V
named onItemEntityDestroyed
Lnet/minecraft/item/Item;onItemEntityDestroyed(Lnet/minecraft/entity/ItemEntity;)V
-
postProcessNbt
Processes the NBT applied to an item stack of this item.This is only used in vanilla to process player head NBT data.
- Mappings:
Namespace Name Mixin selector official b
Lcmt;b(Lsn;)V
intermediary method_7860
Lnet/minecraft/class_1792;method_7860(Lnet/minecraft/class_2487;)V
named postProcessNbt
Lnet/minecraft/item/Item;postProcessNbt(Lnet/minecraft/nbt/NbtCompound;)V
-
canMine
Returns whether a player can break a block while holding the item.This is to check whether the player can start breaking the block in the first place; this does not check if the item is a correct tool to mine the block. Melee weapons should override this to return
false
, unless it is also intended to be used as a tool.- Returns:
- whether a player can break a block while holding the item
- Mappings:
Namespace Name Mixin selector official a
Lcmt;a(Ldjh;Lctp;Lhx;Lcfi;)Z
intermediary method_7885
Lnet/minecraft/class_1792;method_7885(Lnet/minecraft/class_2680;Lnet/minecraft/class_1937;Lnet/minecraft/class_2338;Lnet/minecraft/class_1657;)Z
named canMine
Lnet/minecraft/item/Item;canMine(Lnet/minecraft/block/BlockState;Lnet/minecraft/world/World;Lnet/minecraft/util/math/BlockPos;Lnet/minecraft/entity/player/PlayerEntity;)Z
-
asItem
Gets this object in its item form.- Specified by:
asItem
in interfaceItemConvertible
- Mappings:
Namespace Name Mixin selector official k
Lcto;k()Lcmt;
intermediary method_8389
Lnet/minecraft/class_1935;method_8389()Lnet/minecraft/class_1792;
named asItem
Lnet/minecraft/item/ItemConvertible;asItem()Lnet/minecraft/item/Item;
-
useOnBlock
Called when an item is used on a block.This method is called on both the logical client and logical server, so take caution when using this method. The logical side can be checked using
context.getWorld().isClient()
.- Parameters:
context
- the usage context- Returns:
- an action result that specifies if using the item on a block was successful.
- Mappings:
Namespace Name Mixin selector official a
Lcmt;a(Lcpj;)Lbkb;
intermediary method_7884
Lnet/minecraft/class_1792;method_7884(Lnet/minecraft/class_1838;)Lnet/minecraft/class_1269;
named useOnBlock
Lnet/minecraft/item/Item;useOnBlock(Lnet/minecraft/item/ItemUsageContext;)Lnet/minecraft/util/ActionResult;
-
getMiningSpeedMultiplier
Returns the multiplier applied to the mining speed ofstack
when miningstate
.The default value is
1.0f
. Returning larger integer will cause the block to be mined faster. Enchantments, status effects, and other effects that affect mining speed are instead handled inPlayerEntity.getBlockBreakingSpeed(net.minecraft.block.BlockState)
.- Returns:
- the multiplier applied to the mining speed of
stack
when miningstate
- See Also:
- Mappings:
Namespace Name Mixin selector official a
Lcmt;a(Lcmy;Ldjh;)F
intermediary method_7865
Lnet/minecraft/class_1792;method_7865(Lnet/minecraft/class_1799;Lnet/minecraft/class_2680;)F
named getMiningSpeedMultiplier
Lnet/minecraft/item/Item;getMiningSpeedMultiplier(Lnet/minecraft/item/ItemStack;Lnet/minecraft/block/BlockState;)F
-
use
Called when the player uses (or starts using) the item. The use action, by default, is bound to the right mouse button. This method checks the player's hunger when the item is a food, and will pass in all other cases by default.If the item can be used for multiple ticks, then this will only be called when the player starts using it. After that,
usageTick(net.minecraft.world.World, net.minecraft.entity.LivingEntity, net.minecraft.item.ItemStack, int)
is called every tick until the player finishes using the item.This method is called on both the logical client and logical server, so take caution when overriding this method. The logical side can be checked using
world.isClient()
.- Parameters:
world
- the world the item was used inuser
- the player who used the itemhand
- the hand used- Returns:
- a typed action result that specifies whether using the item was successful. The action result contains the new item stack that the player's hand will be set to.
- Mappings:
Namespace Name Mixin selector official a
Lcmt;a(Lctp;Lcfi;Lbka;)Lbkc;
intermediary method_7836
Lnet/minecraft/class_1792;method_7836(Lnet/minecraft/class_1937;Lnet/minecraft/class_1657;Lnet/minecraft/class_1268;)Lnet/minecraft/class_1271;
named use
Lnet/minecraft/item/Item;use(Lnet/minecraft/world/World;Lnet/minecraft/entity/player/PlayerEntity;Lnet/minecraft/util/Hand;)Lnet/minecraft/util/TypedActionResult;
-
finishUsing
Called when an entity finishes using the item, such as eating food or drinking a potion. This method handles eating food by default.This method is called on both the logical client and logical server, so take caution when overriding this method. The logical side can be checked using
World.isClient
.user
might not be a player in some cases. For example, this occurs when a fox eats food or when a wandering trader drinks milk.- Returns:
- the new item stack after using the item
- Mappings:
Namespace Name Mixin selector official a
Lcmt;a(Lcmy;Lctp;Lbml;)Lcmy;
intermediary method_7861
Lnet/minecraft/class_1792;method_7861(Lnet/minecraft/class_1799;Lnet/minecraft/class_1937;Lnet/minecraft/class_1309;)Lnet/minecraft/class_1799;
named finishUsing
Lnet/minecraft/item/Item;finishUsing(Lnet/minecraft/item/ItemStack;Lnet/minecraft/world/World;Lnet/minecraft/entity/LivingEntity;)Lnet/minecraft/item/ItemStack;
-
getMaxCount
public final int getMaxCount()Returns the maximum stack count of any ItemStack with this item. Can be configured throughsettings.maxCount()
.- Returns:
- the maximum stack count of any ItemStack with this item
- Mappings:
Namespace Name Mixin selector official l
Lcmt;l()I
intermediary method_7882
Lnet/minecraft/class_1792;method_7882()I
named getMaxCount
Lnet/minecraft/item/Item;getMaxCount()I
-
getMaxDamage
public final int getMaxDamage()Returns the maximum durability of this item. Can be configured throughsettings.maxDamage()
.- Returns:
- the maximum durability of this item
- Mappings:
Namespace Name Mixin selector official n
Lcmt;n()I
intermediary method_7841
Lnet/minecraft/class_1792;method_7841()I
named getMaxDamage
Lnet/minecraft/item/Item;getMaxDamage()I
-
isDamageable
public boolean isDamageable()Returns whether this item can lose durability.- Returns:
- whether this item can lose durability
- Mappings:
Namespace Name Mixin selector official o
Lcmt;o()Z
intermediary method_7846
Lnet/minecraft/class_1792;method_7846()Z
named isDamageable
Lnet/minecraft/item/Item;isDamageable()Z
-
isItemBarVisible
Returns whether to show the item bar forstack
.Item bar is usually used to display durability of the stack.
When overriding this,
getItemBarStep(net.minecraft.item.ItemStack)
andgetItemBarColor(net.minecraft.item.ItemStack)
should also be overridden.- Returns:
- whether to show the item bar for
stack
- Mappings:
Namespace Name Mixin selector official e
Lcmt;e(Lcmy;)Z
intermediary method_31567
Lnet/minecraft/class_1792;method_31567(Lnet/minecraft/class_1799;)Z
named isItemBarVisible
Lnet/minecraft/item/Item;isItemBarVisible(Lnet/minecraft/item/ItemStack;)Z
-
getItemBarStep
Returns the step, or the length of the colored area of the item bar, forstack
.This is between
0.0f
and {code 13.0f}. By default, this isdurability * 13.0f / maxDurability
.When overriding this,
isItemBarVisible(net.minecraft.item.ItemStack)
andgetItemBarColor(net.minecraft.item.ItemStack)
should also be overridden.- Returns:
- the step, or the length of the colored area of the item bar, for
stack
- Mappings:
Namespace Name Mixin selector official f
Lcmt;f(Lcmy;)I
intermediary method_31569
Lnet/minecraft/class_1792;method_31569(Lnet/minecraft/class_1799;)I
named getItemBarStep
Lnet/minecraft/item/Item;getItemBarStep(Lnet/minecraft/item/ItemStack;)I
-
getItemBarColor
Returns the RGB color of the item bar, usually used for durability display.When overriding this,
isItemBarVisible(net.minecraft.item.ItemStack)
andgetItemBarStep(net.minecraft.item.ItemStack)
should also be overridden.- Returns:
- the RGB color of the item bar, usually used for durability display
- Mappings:
Namespace Name Mixin selector official g
Lcmt;g(Lcmy;)I
intermediary method_31571
Lnet/minecraft/class_1792;method_31571(Lnet/minecraft/class_1799;)I
named getItemBarColor
Lnet/minecraft/item/Item;getItemBarColor(Lnet/minecraft/item/ItemStack;)I
-
onStackClicked
Called when the item at the cursor is clicked atslot
.While this method is usually called on the logical server, it can also be called on the logical client, so take caution when overriding this method. The logical side can be checked using
World.isClient
.For example, this is called on
BundleItem
when the cursor holds a bundle and the player clicks on the slot.- Parameters:
stack
- the stack the cursor holdsslot
- the clicked slot- Returns:
- whether the action was successful
- Mappings:
Namespace Name Mixin selector official a
Lcmt;a(Lcmy;Lcjw;Lcij;Lcfi;)Z
intermediary method_31565
Lnet/minecraft/class_1792;method_31565(Lnet/minecraft/class_1799;Lnet/minecraft/class_1735;Lnet/minecraft/class_5536;Lnet/minecraft/class_1657;)Z
named onStackClicked
Lnet/minecraft/item/Item;onStackClicked(Lnet/minecraft/item/ItemStack;Lnet/minecraft/screen/slot/Slot;Lnet/minecraft/util/ClickType;Lnet/minecraft/entity/player/PlayerEntity;)Z
-
onClicked
public boolean onClicked(ItemStack stack, ItemStack otherStack, Slot slot, ClickType clickType, PlayerEntity player, StackReference cursorStackReference) Called when the item atslot
gets clicked by the cursor holdingotherStack
.While this method is usually called on the logical server, it can also be called on the logical client, so take caution when overriding this method. The logical side can be checked using
World.isClient
.For example, this is called on
BundleItem
when the cursor holds an item and the player clicks on the slot that has a bundle.- Parameters:
stack
- the slot's stackotherStack
- the stack the cursor holdsslot
- the clicked slot- Returns:
- whether the action was successful
- Mappings:
Namespace Name Mixin selector official a
Lcmt;a(Lcmy;Lcmy;Lcjw;Lcij;Lcfi;Lbnd;)Z
intermediary method_31566
Lnet/minecraft/class_1792;method_31566(Lnet/minecraft/class_1799;Lnet/minecraft/class_1799;Lnet/minecraft/class_1735;Lnet/minecraft/class_5536;Lnet/minecraft/class_1657;Lnet/minecraft/class_5630;)Z
named onClicked
Lnet/minecraft/item/Item;onClicked(Lnet/minecraft/item/ItemStack;Lnet/minecraft/item/ItemStack;Lnet/minecraft/screen/slot/Slot;Lnet/minecraft/util/ClickType;Lnet/minecraft/entity/player/PlayerEntity;Lnet/minecraft/inventory/StackReference;)Z
-
postHit
Called on the server when the item is used to hit an entity.Tools and melee weapons should override this to damage the stack.
- Returns:
- whether the item's use stat should be incremented
- See Also:
- Mappings:
Namespace Name Mixin selector official a
Lcmt;a(Lcmy;Lbml;Lbml;)Z
intermediary method_7873
Lnet/minecraft/class_1792;method_7873(Lnet/minecraft/class_1799;Lnet/minecraft/class_1309;Lnet/minecraft/class_1309;)Z
named postHit
Lnet/minecraft/item/Item;postHit(Lnet/minecraft/item/ItemStack;Lnet/minecraft/entity/LivingEntity;Lnet/minecraft/entity/LivingEntity;)Z
-
postMine
public boolean postMine(ItemStack stack, World world, BlockState state, BlockPos pos, LivingEntity miner) Called on the server when the item is used to break a block.Tools and melee weapons should override this to damage the stack, after checking if the block's hardness is larger than
0.0f
.- Returns:
- whether the item's use stat should be incremented
- See Also:
- Mappings:
Namespace Name Mixin selector official a
Lcmt;a(Lcmy;Lctp;Ldjh;Lhx;Lbml;)Z
intermediary method_7879
Lnet/minecraft/class_1792;method_7879(Lnet/minecraft/class_1799;Lnet/minecraft/class_1937;Lnet/minecraft/class_2680;Lnet/minecraft/class_2338;Lnet/minecraft/class_1309;)Z
named postMine
Lnet/minecraft/item/Item;postMine(Lnet/minecraft/item/ItemStack;Lnet/minecraft/world/World;Lnet/minecraft/block/BlockState;Lnet/minecraft/util/math/BlockPos;Lnet/minecraft/entity/LivingEntity;)Z
-
isSuitableFor
Determines whether this item can be used as a suitable tool for mining the specified block. Depending on block implementation, when combined together, the correct item and block may achieve a better mining speed and yield drops that would not be obtained when mining otherwise.Note that this is not the only way to achieve "effectiveness" when mining. Other items, such as shears on string, may use their own logic and calls to this method might not return a value consistent to this rule for those items.
- Mappings:
Namespace Name Mixin selector official a_
Lcmt;a_(Ldjh;)Z
intermediary method_7856
Lnet/minecraft/class_1792;method_7856(Lnet/minecraft/class_2680;)Z
named isSuitableFor
Lnet/minecraft/item/Item;isSuitableFor(Lnet/minecraft/block/BlockState;)Z
-
useOnEntity
Called on both the client and the server when a player uses the item on an entity.This method is called on both the logical client and logical server, so take caution when overriding this method. The logical side can be checked using
World.isClient
.This should be used if the item can be used on multiple types of entities, such as name tags or saddles.
- Returns:
- the action result
- Mappings:
Namespace Name Mixin selector official a
Lcmt;a(Lcmy;Lcfi;Lbml;Lbka;)Lbkb;
intermediary method_7847
Lnet/minecraft/class_1792;method_7847(Lnet/minecraft/class_1799;Lnet/minecraft/class_1657;Lnet/minecraft/class_1309;Lnet/minecraft/class_1268;)Lnet/minecraft/class_1269;
named useOnEntity
Lnet/minecraft/item/Item;useOnEntity(Lnet/minecraft/item/ItemStack;Lnet/minecraft/entity/player/PlayerEntity;Lnet/minecraft/entity/LivingEntity;Lnet/minecraft/util/Hand;)Lnet/minecraft/util/ActionResult;
-
getName
- Mappings:
Namespace Name Mixin selector official p
Lcmt;p()Lvf;
intermediary method_7848
Lnet/minecraft/class_1792;method_7848()Lnet/minecraft/class_2561;
named getName
Lnet/minecraft/item/Item;getName()Lnet/minecraft/text/Text;
-
toString
-
getOrCreateTranslationKey
- Mappings:
Namespace Name Mixin selector official q
Lcmt;q()Ljava/lang/String;
intermediary method_7869
Lnet/minecraft/class_1792;method_7869()Ljava/lang/String;
named getOrCreateTranslationKey
Lnet/minecraft/item/Item;getOrCreateTranslationKey()Ljava/lang/String;
-
getTranslationKey
Gets the translation key of this item.- Mappings:
Namespace Name Mixin selector official a
Lcmt;a()Ljava/lang/String;
intermediary method_7876
Lnet/minecraft/class_1792;method_7876()Ljava/lang/String;
named getTranslationKey
Lnet/minecraft/item/Item;getTranslationKey()Ljava/lang/String;
-
getTranslationKey
Gets the translation key of this item using the provided item stack for context.- Mappings:
Namespace Name Mixin selector official j
Lcmt;j(Lcmy;)Ljava/lang/String;
intermediary method_7866
Lnet/minecraft/class_1792;method_7866(Lnet/minecraft/class_1799;)Ljava/lang/String;
named getTranslationKey
Lnet/minecraft/item/Item;getTranslationKey(Lnet/minecraft/item/ItemStack;)Ljava/lang/String;
-
isNbtSynced
public boolean isNbtSynced()Checks if an item should have its NBT data stored inItemStack.nbt
sent to the client.If an item is damageable, this method is ignored and data is always synced to client.
- Mappings:
Namespace Name Mixin selector official r
Lcmt;r()Z
intermediary method_7887
Lnet/minecraft/class_1792;method_7887()Z
named isNbtSynced
Lnet/minecraft/item/Item;isNbtSynced()Z
-
getRecipeRemainder
Gets the remainder item that should be left behind when this item is used as a crafting ingredient.- Mappings:
Namespace Name Mixin selector official s
Lcmt;s()Lcmt;
intermediary method_7858
Lnet/minecraft/class_1792;method_7858()Lnet/minecraft/class_1792;
named getRecipeRemainder
Lnet/minecraft/item/Item;getRecipeRemainder()Lnet/minecraft/item/Item;
-
hasRecipeRemainder
public boolean hasRecipeRemainder()Checks if this item has a remainder item that is left behind when used as a crafting ingredient.- Mappings:
Namespace Name Mixin selector official t
Lcmt;t()Z
intermediary method_7857
Lnet/minecraft/class_1792;method_7857()Z
named hasRecipeRemainder
Lnet/minecraft/item/Item;hasRecipeRemainder()Z
-
inventoryTick
Called on both the client and the server every tick if the item is in the player's inventory.This method is called on both the logical client and logical server, so take caution when overriding this method. The logical side can be checked using
World.isClient
.- Parameters:
entity
- the entity holding the item; usually a playerselected
- whether the item is in the selected hotbar slot- Mappings:
Namespace Name Mixin selector official a
Lcmt;a(Lcmy;Lctp;Lblv;IZ)V
intermediary method_7888
Lnet/minecraft/class_1792;method_7888(Lnet/minecraft/class_1799;Lnet/minecraft/class_1937;Lnet/minecraft/class_1297;IZ)V
named inventoryTick
Lnet/minecraft/item/Item;inventoryTick(Lnet/minecraft/item/ItemStack;Lnet/minecraft/world/World;Lnet/minecraft/entity/Entity;IZ)V
-
onCraftByPlayer
Called when a player acquires the item by crafting, smelting, smithing, etc.Not called when the item is automatically created, such as via a crafter.
- Mappings:
Namespace Name Mixin selector official b
Lcmt;b(Lcmy;Lctp;Lcfi;)V
intermediary method_54465
Lnet/minecraft/class_1792;method_54465(Lnet/minecraft/class_1799;Lnet/minecraft/class_1937;Lnet/minecraft/class_1657;)V
named onCraftByPlayer
Lnet/minecraft/item/Item;onCraftByPlayer(Lnet/minecraft/item/ItemStack;Lnet/minecraft/world/World;Lnet/minecraft/entity/player/PlayerEntity;)V
-
onCraft
Called when the item is made by crafting, smelting, smithing, etc.- Mappings:
Namespace Name Mixin selector official a
Lcmt;a(Lcmy;Lctp;)V
intermediary method_7843
Lnet/minecraft/class_1792;method_7843(Lnet/minecraft/class_1799;Lnet/minecraft/class_1937;)V
named onCraft
Lnet/minecraft/item/Item;onCraft(Lnet/minecraft/item/ItemStack;Lnet/minecraft/world/World;)V
-
isNetworkSynced
public boolean isNetworkSynced()Returns whether the item needs to sync additional data to clients.Items should ideally store all necessary information on the stack's NBT. However, this is not always possible for things like maps. In those cases, items can send a packet to the player holding it that syncs additional data. Such items must subclass
NetworkSyncedItem
.- Returns:
- whether the item needs to sync additional data to clients
- See Also:
- Mappings:
Namespace Name Mixin selector official al_
Lcmt;al_()Z
intermediary method_16698
Lnet/minecraft/class_1792;method_16698()Z
named isNetworkSynced
Lnet/minecraft/item/Item;isNetworkSynced()Z
-
getUseAction
Returns the use action the item should perform.- Returns:
- the use action the item should perform
- Mappings:
Namespace Name Mixin selector official c
Lcmt;c(Lcmy;)Lcos;
intermediary method_7853
Lnet/minecraft/class_1792;method_7853(Lnet/minecraft/class_1799;)Lnet/minecraft/class_1839;
named getUseAction
Lnet/minecraft/item/Item;getUseAction(Lnet/minecraft/item/ItemStack;)Lnet/minecraft/util/UseAction;
-
getMaxUseTime
Returns the maximum use (right-click) time of this item, in ticks. Once a player has used an item for said number of ticks, they stop using it, andfinishUsing(net.minecraft.item.ItemStack, net.minecraft.world.World, net.minecraft.entity.LivingEntity)
is called.- Returns:
- the maximum use (right-click) time of this item, in ticks
- Mappings:
Namespace Name Mixin selector official b
Lcmt;b(Lcmy;)I
intermediary method_7881
Lnet/minecraft/class_1792;method_7881(Lnet/minecraft/class_1799;)I
named getMaxUseTime
Lnet/minecraft/item/Item;getMaxUseTime(Lnet/minecraft/item/ItemStack;)I
-
onStoppedUsing
Called on both the client and the server when an entity stops using an item before reaching the maximum use time. If the time was reached,finishUsing(net.minecraft.item.ItemStack, net.minecraft.world.World, net.minecraft.entity.LivingEntity)
is called instead.This method is called on both the logical client and logical server, so take caution when overriding this method. The logical side can be checked using
World.isClient
.user
might not be a player in some cases. For example, this occurs when an entity uses a crossbow.- Mappings:
Namespace Name Mixin selector official a
Lcmt;a(Lcmy;Lctp;Lbml;I)V
intermediary method_7840
Lnet/minecraft/class_1792;method_7840(Lnet/minecraft/class_1799;Lnet/minecraft/class_1937;Lnet/minecraft/class_1309;I)V
named onStoppedUsing
Lnet/minecraft/item/Item;onStoppedUsing(Lnet/minecraft/item/ItemStack;Lnet/minecraft/world/World;Lnet/minecraft/entity/LivingEntity;I)V
-
appendTooltip
public void appendTooltip(ItemStack stack, @Nullable @Nullable World world, List<Text> tooltip, TooltipContext context) Called by the client to append tooltips to an item. Subclasses can override this and add custom tooltips totooltip
list.- Parameters:
tooltip
- the list of tooltips to show- Mappings:
Namespace Name Mixin selector official a
Lcmt;a(Lcmy;Lctp;Ljava/util/List;Lcoq;)V
intermediary method_7851
Lnet/minecraft/class_1792;method_7851(Lnet/minecraft/class_1799;Lnet/minecraft/class_1937;Ljava/util/List;Lnet/minecraft/class_1836;)V
named appendTooltip
Lnet/minecraft/item/Item;appendTooltip(Lnet/minecraft/item/ItemStack;Lnet/minecraft/world/World;Ljava/util/List;Lnet/minecraft/client/item/TooltipContext;)V
-
getTooltipData
- Mappings:
Namespace Name Mixin selector official h
Lcmt;h(Lcmy;)Ljava/util/Optional;
intermediary method_32346
Lnet/minecraft/class_1792;method_32346(Lnet/minecraft/class_1799;)Ljava/util/Optional;
named getTooltipData
Lnet/minecraft/item/Item;getTooltipData(Lnet/minecraft/item/ItemStack;)Ljava/util/Optional;
-
getName
- Mappings:
Namespace Name Mixin selector official m
Lcmt;m(Lcmy;)Lvf;
intermediary method_7864
Lnet/minecraft/class_1792;method_7864(Lnet/minecraft/class_1799;)Lnet/minecraft/class_2561;
named getName
Lnet/minecraft/item/Item;getName(Lnet/minecraft/item/ItemStack;)Lnet/minecraft/text/Text;
-
hasGlint
Checks if the glint effect should be applied when the item is rendered.By default, returns true if the item has enchantments.
- Mappings:
Namespace Name Mixin selector official i
Lcmt;i(Lcmy;)Z
intermediary method_7886
Lnet/minecraft/class_1792;method_7886(Lnet/minecraft/class_1799;)Z
named hasGlint
Lnet/minecraft/item/Item;hasGlint(Lnet/minecraft/item/ItemStack;)Z
-
getRarity
Returns this item's rarity, which changes the color of its name.By default, if an item has an enchantment, its rarity is modified:
- Common and Uncommon -> Rare
- Rare -> Epic
- Returns:
- this item's rarity, which changes the color of its name
- Mappings:
Namespace Name Mixin selector official n
Lcmt;n(Lcmy;)Lcnp;
intermediary method_7862
Lnet/minecraft/class_1792;method_7862(Lnet/minecraft/class_1799;)Lnet/minecraft/class_1814;
named getRarity
Lnet/minecraft/item/Item;getRarity(Lnet/minecraft/item/ItemStack;)Lnet/minecraft/util/Rarity;
-
isEnchantable
Returns whether the givenItemStack
is enchantable.By default, ItemStacks are enchantable if their max stack count is 1 and they can be damaged.
- Returns:
- whether the given
ItemStack
is enchantable - Mappings:
Namespace Name Mixin selector official d_
Lcmt;d_(Lcmy;)Z
intermediary method_7870
Lnet/minecraft/class_1792;method_7870(Lnet/minecraft/class_1799;)Z
named isEnchantable
Lnet/minecraft/item/Item;isEnchantable(Lnet/minecraft/item/ItemStack;)Z
-
raycast
protected static BlockHitResult raycast(World world, PlayerEntity player, RaycastContext.FluidHandling fluidHandling) - Mappings:
Namespace Name Mixin selector official a
Lcmt;a(Lctp;Lcfi;Lcsy$b;)Lelp;
intermediary method_7872
Lnet/minecraft/class_1792;method_7872(Lnet/minecraft/class_1937;Lnet/minecraft/class_1657;Lnet/minecraft/class_3959$class_242;)Lnet/minecraft/class_3965;
named raycast
Lnet/minecraft/item/Item;raycast(Lnet/minecraft/world/World;Lnet/minecraft/entity/player/PlayerEntity;Lnet/minecraft/world/RaycastContext$FluidHandling;)Lnet/minecraft/util/hit/BlockHitResult;
-
getEnchantability
public int getEnchantability()Gets the enchantability of an item. This specifies the ability of an item to receive enchantments when enchanted using an enchanting table. As the value increases, the amount and level of enchantments applied increase.If the value of this method is 0, the item cannot be enchanted using an enchanting table.
- Mappings:
Namespace Name Mixin selector official c
Lcmt;c()I
intermediary method_7837
Lnet/minecraft/class_1792;method_7837()I
named getEnchantability
Lnet/minecraft/item/Item;getEnchantability()I
-
canRepair
Returns whetherstack
can be repaired usingingredient
.This only handles repairing using the ingredient such as diamonds, and does not handle combining tools or armor.
- Returns:
- whether
stack
can be repaired usingingredient
- Mappings:
Namespace Name Mixin selector official a
Lcmt;a(Lcmy;Lcmy;)Z
intermediary method_7878
Lnet/minecraft/class_1792;method_7878(Lnet/minecraft/class_1799;Lnet/minecraft/class_1799;)Z
named canRepair
Lnet/minecraft/item/Item;canRepair(Lnet/minecraft/item/ItemStack;Lnet/minecraft/item/ItemStack;)Z
-
getAttributeModifiers
Returns the attribute modifiers the item provides.Tools and armor should override this to specify the attack damage or armor points.
- Returns:
- the attribute modifiers the item provides
- Mappings:
Namespace Name Mixin selector official a
Lcmt;a(Lbma;)Lcom/google/common/collect/Multimap;
intermediary method_7844
Lnet/minecraft/class_1792;method_7844(Lnet/minecraft/class_1304;)Lcom/google/common/collect/Multimap;
named getAttributeModifiers
Lnet/minecraft/item/Item;getAttributeModifiers(Lnet/minecraft/entity/EquipmentSlot;)Lcom/google/common/collect/Multimap;
-
isUsedOnRelease
- Mappings:
Namespace Name Mixin selector official l
Lcmt;l(Lcmy;)Z
intermediary method_7838
Lnet/minecraft/class_1792;method_7838(Lnet/minecraft/class_1799;)Z
named isUsedOnRelease
Lnet/minecraft/item/Item;isUsedOnRelease(Lnet/minecraft/item/ItemStack;)Z
-
getDefaultStack
Returns the default stack for this item.Items that expect certain NBT data in the item stack should override this method to return the stack with the NBT data.
- Returns:
- the default stack for this item
- Mappings:
Namespace Name Mixin selector official am_
Lcmt;am_()Lcmy;
intermediary method_7854
Lnet/minecraft/class_1792;method_7854()Lnet/minecraft/class_1799;
named getDefaultStack
Lnet/minecraft/item/Item;getDefaultStack()Lnet/minecraft/item/ItemStack;
-
isFood
public boolean isFood()Checks if this item is food and therefore is edible.- Mappings:
Namespace Name Mixin selector official u
Lcmt;u()Z
intermediary method_19263
Lnet/minecraft/class_1792;method_19263()Z
named isFood
Lnet/minecraft/item/Item;isFood()Z
-
getFoodComponent
Returns this item'sFoodComponent
, ornull
if none was set.- Returns:
- this item's
FoodComponent
, ornull
if none was set - Mappings:
Namespace Name Mixin selector official v
Lcmt;v()Lchy;
intermediary method_19264
Lnet/minecraft/class_1792;method_19264()Lnet/minecraft/class_4174;
named getFoodComponent
Lnet/minecraft/item/Item;getFoodComponent()Lnet/minecraft/item/FoodComponent;
-
getDrinkSound
Returns the sound for drinking the item.- Returns:
- the sound for drinking the item
- Mappings:
Namespace Name Mixin selector official an_
Lcmt;an_()Larr;
intermediary method_21831
Lnet/minecraft/class_1792;method_21831()Lnet/minecraft/class_3414;
named getDrinkSound
Lnet/minecraft/item/Item;getDrinkSound()Lnet/minecraft/sound/SoundEvent;
-
getEatSound
Returns the sound for eating the item.- Returns:
- the sound for eating the item
- Mappings:
Namespace Name Mixin selector official ao_
Lcmt;ao_()Larr;
intermediary method_21830
Lnet/minecraft/class_1792;method_21830()Lnet/minecraft/class_3414;
named getEatSound
Lnet/minecraft/item/Item;getEatSound()Lnet/minecraft/sound/SoundEvent;
-
isFireproof
public boolean isFireproof()Returns whether this item is immune to fire and lava damage.- Returns:
- whether this item is immune to fire and lava damage
- Mappings:
Namespace Name Mixin selector official w
Lcmt;w()Z
intermediary method_24358
Lnet/minecraft/class_1792;method_24358()Z
named isFireproof
Lnet/minecraft/item/Item;isFireproof()Z
-
damage
Returns whether this item can be damaged by the givensource
.- Returns:
- whether this item can be damaged by the given
source
- Mappings:
Namespace Name Mixin selector official a
Lcmt;a(Lbkt;)Z
intermediary method_24357
Lnet/minecraft/class_1792;method_24357(Lnet/minecraft/class_1282;)Z
named damage
Lnet/minecraft/item/Item;damage(Lnet/minecraft/entity/damage/DamageSource;)Z
-
canBeNested
public boolean canBeNested()- Returns:
- true if the item can be placed inside of shulker boxes or bundles.
- Mappings:
Namespace Name Mixin selector official ap_
Lcmt;ap_()Z
intermediary method_31568
Lnet/minecraft/class_1792;method_31568()Z
named canBeNested
Lnet/minecraft/item/Item;canBeNested()Z
-
getRequiredFeatures
- Specified by:
getRequiredFeatures
in interfaceToggleableFeature
- Mappings:
Namespace Name Mixin selector official m
Lchp;m()Lchs;
intermediary method_45322
Lnet/minecraft/class_7695;method_45322()Lnet/minecraft/class_7699;
named getRequiredFeatures
Lnet/minecraft/resource/featuretoggle/ToggleableFeature;getRequiredFeatures()Lnet/minecraft/resource/featuretoggle/FeatureSet;
-
Block.asItem()