Package net.minecraft.item

Class CompassItem

java.lang.Object

net.minecraft.item.Item

net.minecraft.item.CompassItem

All Implemented Interfaces:

ItemConvertible, Vanishable, ToggleableFeature

public class CompassItem
extends Item
implements Vanishable

Mappings:

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

Nested Class Summary

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

Item.Settings

Field Summary

Fields

Modifier and Type	Field	Description
static final String	LODESTONE_DIMENSION_KEY
static final String	LODESTONE_POS_KEY
static final String	LODESTONE_TRACKED_KEY
private static final Logger	LOGGER

Fields inherited from class net.minecraft.item.Item

ATTACK_DAMAGE_MODIFIER_ID, ATTACK_SPEED_MODIFIER_ID, BLOCK_ITEMS, DEFAULT_MAX_COUNT, DEFAULT_MAX_USE_TIME, ITEM_BAR_STEPS

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
static @Nullable GlobalPos	createLodestonePos(NbtCompound nbt)
static @Nullable GlobalPos	createSpawnPos(World world)
private static Optional<RegistryKey<World>>	getLodestoneDimension(NbtCompound nbt)
String	getTranslationKey(ItemStack stack)	Gets the translation key of this item using the provided item stack for context.
boolean	hasGlint(ItemStack stack)	Checks if the glint effect should be applied when the item is rendered.
static boolean	hasLodestone(ItemStack stack)
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.
ActionResult	useOnBlock(ItemUsageContext context)	Called when an item is used on a block.
private void	writeNbt(RegistryKey<World> worldKey, BlockPos pos, NbtCompound nbt)

Methods inherited from class net.minecraft.item.Item

appendTooltip, asItem, byRawId, canBeNested, canMine, canRepair, damage, finishUsing, fromBlock, getAttributeModifiers, getDefaultStack, getDrinkSound, getEatSound, getEnchantability, getFoodComponent, getItemBarColor, getItemBarStep, getMaxCount, getMaxDamage, getMaxUseTime, getMiningSpeedMultiplier, getName, getName, getOrCreateTranslationKey, getRarity, getRawId, getRecipeRemainder, getRegistryEntry, getRequiredFeatures, getTooltipData, getTranslationKey, getUseAction, hasRecipeRemainder, isDamageable, isEnchantable, isFireproof, isFood, isItemBarVisible, isNbtSynced, isNetworkSynced, isSuitableFor, isUsedOnRelease, onClicked, onCraft, onItemEntityDestroyed, onStackClicked, onStoppedUsing, postHit, postMine, postProcessNbt, raycast, 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

LOGGER

private static final Logger LOGGER

Mappings:

Namespace	Name	Mixin selector
official	d	Lceb;d:Lorg/slf4j/Logger;
intermediary	field_24670	Lnet/minecraft/class_1759;field_24670:Lorg/slf4j/Logger;
named	LOGGER	Lnet/minecraft/item/CompassItem;LOGGER:Lorg/slf4j/Logger;

LODESTONE_POS_KEY

public static final String LODESTONE_POS_KEY

See Also:

• Constant Field Values

Mappings:

Namespace	Name	Mixin selector
official	a	Lceb;a:Ljava/lang/String;
intermediary	field_30860	Lnet/minecraft/class_1759;field_30860:Ljava/lang/String;
named	LODESTONE_POS_KEY	Lnet/minecraft/item/CompassItem;LODESTONE_POS_KEY:Ljava/lang/String;

LODESTONE_DIMENSION_KEY

public static final String LODESTONE_DIMENSION_KEY

See Also:

• Constant Field Values

Mappings:

Namespace	Name	Mixin selector
official	b	Lceb;b:Ljava/lang/String;
intermediary	field_30861	Lnet/minecraft/class_1759;field_30861:Ljava/lang/String;
named	LODESTONE_DIMENSION_KEY	Lnet/minecraft/item/CompassItem;LODESTONE_DIMENSION_KEY:Ljava/lang/String;

LODESTONE_TRACKED_KEY

public static final String LODESTONE_TRACKED_KEY

See Also:

• Constant Field Values

Mappings:

Namespace	Name	Mixin selector
official	c	Lceb;c:Ljava/lang/String;
intermediary	field_30862	Lnet/minecraft/class_1759;field_30862:Ljava/lang/String;
named	LODESTONE_TRACKED_KEY	Lnet/minecraft/item/CompassItem;LODESTONE_TRACKED_KEY:Ljava/lang/String;

Constructor Details

CompassItem

public CompassItem(Item.Settings settings)

Mappings:

Namespace	Name	Mixin selector
official	<init>	Lcfs;<init>(Lcfs$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

hasLodestone

public static boolean hasLodestone(ItemStack stack)

Mappings:

Namespace	Name	Mixin selector
official	d	Lceb;d(Lcfx;)Z
intermediary	method_26365	Lnet/minecraft/class_1759;method_26365(Lnet/minecraft/class_1799;)Z
named	hasLodestone	Lnet/minecraft/item/CompassItem;hasLodestone(Lnet/minecraft/item/ItemStack;)Z

getLodestoneDimension

private static Optional<RegistryKey<World>> getLodestoneDimension(NbtCompound nbt)

Mappings:

Namespace	Name	Mixin selector
official	c	Lceb;c(Lqr;)Ljava/util/Optional;
intermediary	method_26364	Lnet/minecraft/class_1759;method_26364(Lnet/minecraft/class_2487;)Ljava/util/Optional;
named	getLodestoneDimension	Lnet/minecraft/item/CompassItem;getLodestoneDimension(Lnet/minecraft/nbt/NbtCompound;)Ljava/util/Optional;

createLodestonePos

@Nullable
public static @Nullable GlobalPos createLodestonePos(NbtCompound nbt)

Mappings:

Namespace	Name	Mixin selector
official	a	Lceb;a(Lqr;)Lhd;
intermediary	method_43124	Lnet/minecraft/class_1759;method_43124(Lnet/minecraft/class_2487;)Lnet/minecraft/class_4208;
named	createLodestonePos	Lnet/minecraft/item/CompassItem;createLodestonePos(Lnet/minecraft/nbt/NbtCompound;)Lnet/minecraft/util/math/GlobalPos;

createSpawnPos

@Nullable
public static @Nullable GlobalPos createSpawnPos(World world)

Mappings:

Namespace	Name	Mixin selector
official	a	Lceb;a(Lcmk;)Lhd;
intermediary	method_43123	Lnet/minecraft/class_1759;method_43123(Lnet/minecraft/class_1937;)Lnet/minecraft/class_4208;
named	createSpawnPos	Lnet/minecraft/item/CompassItem;createSpawnPos(Lnet/minecraft/world/World;)Lnet/minecraft/util/math/GlobalPos;

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
official	i	Lcfs;i(Lcfx;)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

inventoryTick

public 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.

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.

Overrides:

inventoryTick in class Item

Parameters:

entity - the entity holding the item; usually a player

selected - whether the item is in the selected hotbar slot

Mappings:

Namespace	Name	Mixin selector
official	a	Lcfs;a(Lcfx;Lcmk;Lbfh;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

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
official	a	Lcfs;a(Lcih;)Lbdw;
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;

writeNbt

private void writeNbt(RegistryKey<World> worldKey,
 BlockPos pos,
 NbtCompound nbt)

Mappings:

Namespace	Name	Mixin selector
official	a	Lceb;a(Lacp;Lgu;Lqr;)V
intermediary	method_27315	Lnet/minecraft/class_1759;method_27315(Lnet/minecraft/class_5321;Lnet/minecraft/class_2338;Lnet/minecraft/class_2487;)V
named	writeNbt	Lnet/minecraft/item/CompassItem;writeNbt(Lnet/minecraft/registry/RegistryKey;Lnet/minecraft/util/math/BlockPos;Lnet/minecraft/nbt/NbtCompound;)V

getTranslationKey

public String getTranslationKey(ItemStack stack)

Gets the translation key of this item using the provided item stack for context.

Overrides:

getTranslationKey in class Item

Mappings:

Namespace	Name	Mixin selector
official	j	Lcfs;j(Lcfx;)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;