Package net.minecraft.item

Class CompassItem

java.lang.Object

net.minecraft.item.Item

net.minecraft.item.CompassItem

All Implemented Interfaces:

ItemConvertible, ToggleableFeature

public class CompassItem
extends Item

Mappings:

Namespace	Name
named	net/minecraft/item/CompassItem
intermediary	net/minecraft/class_1759
official	cza

Nested Class Summary

Nested classes/interfaces inherited from class net.minecraft.item.Item

Item.Settings, Item.TooltipContext

Field Summary

Fields

Modifier and Type	Field	Description
private static final Text	LODESTONE_COMPASS_NAME

Fields inherited from class net.minecraft.item.Item

BASE_ATTACK_DAMAGE_MODIFIER_ID, BASE_ATTACK_SPEED_MODIFIER_ID, BLOCK_ITEMS, DEFAULT_BLOCKS_ATTACKS_MAX_USE_TIME, DEFAULT_MAX_COUNT, ENTRY_CODEC, ENTRY_PACKET_CODEC, ITEM_BAR_STEPS, MAX_MAX_COUNT, translationKey

Fields inherited from interface net.minecraft.resource.featuretoggle.ToggleableFeature

FEATURE_ENABLED_REGISTRY_KEYS

Constructor Summary

Constructors

Constructor	Description
CompassItem(Item.Settings settings)

Method Summary

Modifier and Type	Method	Description
Text	getName(ItemStack stack)
boolean	hasGlint(ItemStack stack)	Checks if the glint effect should be applied when the item is rendered.
void	inventoryTick(ItemStack stack, ServerWorld world, Entity entity, @Nullable EquipmentSlot slot)	Called on both the client and the server every tick if the item is in a player or other entity's inventory.
ActionResult	useOnBlock(ItemUsageContext context)	Called when an item is used on a block.

Methods inherited from class net.minecraft.item.Item

appendTooltip, asItem, byRawId, canBeNested, canMine, finishUsing, fromBlock, getBonusAttackDamage, getComponents, getDamageSource, getDefaultStack, getItemBarColor, getItemBarStep, getMaxCount, getMaxUseTime, getMiningSpeed, getName, getRawId, getRecipeRemainder, getRegistryEntry, getRequiredFeatures, getTooltipData, getTranslationKey, getUseAction, isCorrectForDrops, isItemBarVisible, isUsedOnRelease, onClicked, onCraft, onCraftByPlayer, onItemEntityDestroyed, onStackClicked, onStoppedUsing, postDamageEntity, postHit, postMine, postProcessComponents, raycast, shouldShowOperatorBlockWarnings, toString, usageTick, use, useOnEntity

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

LODESTONE_COMPASS_NAME

private static final Text LODESTONE_COMPASS_NAME

Mappings:

Namespace	Name	Mixin selector
named	LODESTONE_COMPASS_NAME	Lnet/minecraft/item/CompassItem;LODESTONE_COMPASS_NAME:Lnet/minecraft/text/Text;
intermediary	field_54114	Lnet/minecraft/class_1759;field_54114:Lnet/minecraft/class_2561;
official	a	Lcza;a:Lxg;

Constructor Details

CompassItem

public CompassItem(Item.Settings settings)

Mappings:

Namespace	Name	Mixin selector
named	<init>	Lnet/minecraft/item/Item;<init>(Lnet/minecraft/item/Item$Settings;)V
intermediary	<init>	Lnet/minecraft/class_1792;<init>(Lnet/minecraft/class_1792$class_1793;)V
official	<init>	Ldag;<init>(Ldag$a;)V

Method Details

hasGlint

public boolean hasGlint(ItemStack stack)

Checks if the glint effect should be applied when the item is rendered.

By default, returns true if the item has enchantments.

Overrides:

hasGlint in class Item

Mappings:

Namespace	Name	Mixin selector
named	hasGlint	Lnet/minecraft/item/Item;hasGlint(Lnet/minecraft/item/ItemStack;)Z
intermediary	method_7886	Lnet/minecraft/class_1792;method_7886(Lnet/minecraft/class_1799;)Z
official	d_	Ldag;d_(Ldak;)Z

inventoryTick

public void inventoryTick(ItemStack stack,
 ServerWorld world,
 Entity entity,
 @Nullable
 @Nullable EquipmentSlot slot)

Called on both the client and the server every tick if the item is in a player or other entity'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

invalid reference

World#isClient

.

Overrides:

inventoryTick in class Item

Parameters:

entity - the entity holding the item

Mappings:

Namespace	Name	Mixin selector
named	inventoryTick	Lnet/minecraft/item/Item;inventoryTick(Lnet/minecraft/item/ItemStack;Lnet/minecraft/server/world/ServerWorld;Lnet/minecraft/entity/Entity;Lnet/minecraft/entity/EquipmentSlot;)V
intermediary	method_7888	Lnet/minecraft/class_1792;method_7888(Lnet/minecraft/class_1799;Lnet/minecraft/class_3218;Lnet/minecraft/class_1297;Lnet/minecraft/class_1304;)V
official	a	Ldag;a(Ldak;Lasb;Lbxe;Lbxo;)V

useOnBlock

public ActionResult useOnBlock(ItemUsageContext context)

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().

Overrides:

useOnBlock in class Item

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
named	useOnBlock	Lnet/minecraft/item/Item;useOnBlock(Lnet/minecraft/item/ItemUsageContext;)Lnet/minecraft/util/ActionResult;
intermediary	method_7884	Lnet/minecraft/class_1792;method_7884(Lnet/minecraft/class_1838;)Lnet/minecraft/class_1269;
official	a	Ldag;a(Ldef;)Lbvc;

getName

public Text getName(ItemStack stack)

Overrides:

getName in class Item

Mappings:

Namespace	Name	Mixin selector
named	getName	Lnet/minecraft/item/Item;getName(Lnet/minecraft/item/ItemStack;)Lnet/minecraft/text/Text;
intermediary	method_7864	Lnet/minecraft/class_1792;method_7864(Lnet/minecraft/class_1799;)Lnet/minecraft/class_2561;
official	a	Ldag;a(Ldak;)Lxg;