Interface CompassMeta

All Superinterfaces:
Cloneable, ConfigurationSerializable, ItemMeta, PersistentDataHolder, PersistentDataViewHolder

public interface CompassMeta extends ItemMeta
Represents a compass that can track a specific location.
  • Method Details

    • hasLodestone

      boolean hasLodestone()
      Checks if this compass has been paired to a lodestone.
      Returns:
      paired status
    • getLodestone

      @Nullable @Nullable Location getLodestone()
      Gets the location that this compass will point to. Check hasLodestone() first!
      Returns:
      lodestone location
    • setLodestone

      void setLodestone(@Nullable @Nullable Location lodestone)
      Sets the location this lodestone compass will point to.
      Parameters:
      lodestone - new location or null to clear the targeted location
      See Also:
    • isLodestoneTracked

      boolean isLodestoneTracked()
      Gets if this compass is tracking a specific lodestone. If true the compass will only work if there is a lodestone at the tracked location.
      Returns:
      lodestone tracked
    • setLodestoneTracked

      void setLodestoneTracked(boolean tracked)
      Sets if this compass is tracking a specific lodestone. If true the compass will only work if there is a lodestone at the tracked location.
      Parameters:
      tracked - new tracked status
      See Also:
    • isLodestoneCompass

      boolean isLodestoneCompass()
      Checks if this compass is considered a lodestone compass.
      See Also:
    • clearLodestone

      void clearLodestone()
      Reset this compass to a normal compass, removing any tracked location.
    • clone

      CompassMeta clone()
      Specified by:
      clone in interface ItemMeta