Interface Waypoint

public interface Waypoint

  • Method Details

    • getId

      String getId()
      Non-unique id that is a comibination of modId and waypoint position.

    • getGuid

      String getGuid()
      Unique Id for each waypoint, will not change.

    • getGroupId

      String getGroupId()
      Unique id of the group this waypoint belongs to.

    • getModId

      String getModId()

    • getName

      String getName()

    • setName

      void setName(String name)

    • getDescription

      @Nullable default @Nullable String getDescription()
      Optional free-form description shown in the waypoint manager tooltip. Implementations may treat values starting with "jm." as i18n keys. Default returns null for backwards compatibility with addons that implement Waypoint directly.

    • setDescription

      default void setDescription(@Nullable @Nullable String description)
      See Also:

    • setPos

      void setPos(int x, int y, int z)

    • setBlockPos

      void setBlockPos(net.minecraft.core.BlockPos pos)

    • getBlockPos

      net.minecraft.core.BlockPos getBlockPos()

    • getX

      int getX()

    • setX

      void setX(int x)

    • getY

      int getY()

    • setY

      void setY(int y)

    • getZ

      int getZ()

    • setZ

      void setZ(int z)

    • getRed

      int getRed()

    • setRed

      void setRed(int red)

    • getGreen

      int getGreen()

    • setGreen

      void setGreen(int green)

    • getBlue

      int getBlue()

    • setBlue

      void setBlue(int blue)

    • getColor

      int getColor()

    • setColor

      void setColor(int color)

    • getDimensions

      TreeSet<String> getDimensions()

    • setDimensions

      void setDimensions(Collection<String> dims)

    • setPrimaryDimension

      default void setPrimaryDimension(net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> dimension)

    • setPrimaryDimension

      void setPrimaryDimension(String dimension)

    • getPrimaryDimension

      String getPrimaryDimension()

    • isPersistent

      boolean isPersistent()

    • setPersistent

      void setPersistent(boolean persistent)

    • isEnabled

      boolean isEnabled()
      Is waypoint enabled.
      Returns:
      - the Enabled boolean

    • setEnabled

      void setEnabled(boolean enabled)
      Set waypoint enabled / disabled
      Parameters:
      enabled - - enabled

    • showDeviation

      boolean showDeviation()
      Is deviation being shown
      Returns:
      - is showing

    • setShowDeviation

      void setShowDeviation(boolean showDeviation)
      Sets the show deviation text on the beacon.
      Parameters:
      showDeviation - - the boolean

    • getIconRotation

      int getIconRotation()
      Gets the rotation in degrees the image should be oriented. Zero is the default.
      Returns:
      degrees

    • setIconRotation

      void setIconRotation(int rotation)
      Sets the rotation in degrees the image should be oriented. Zero is the default.
      Parameters:
      rotation - in degrees

    • getIconColor

      Integer getIconColor()
      Gets color.
      Returns:
      the color

    • setIconColor

      void setIconColor(Integer color)
      Sets color used to tint the image. Use 0xffffff for no tint. This is only to be used if the icon needs to have a separate color from the waypoint. Defaults to -1 which will tint the icon to the beacon color.
      Parameters:
      color - the color

    • getIconOpacity

      float getIconOpacity()
      Gets opacity.
      Returns:
      the opacity

    • setIconOpacity

      void setIconOpacity(float opacity)
      Sets opacity.
      Parameters:
      opacity - the opacity

    • getIconIdentifier

      net.minecraft.resources.Identifier getIconIdentifier()
      Gets the texture resource location.
      Returns:
      - Identifier

    • setIconIdentifier

      void setIconIdentifier(net.minecraft.resources.Identifier Identifier)
      Sets the texture resource location.
      Parameters:
      Identifier - - the resource location

    • getIconTextureWidth

      int getIconTextureWidth()
      Gets the image textureWidth.
      Returns:
      textureWidth

    • setIconTextureWidth

      void setIconTextureWidth(Integer width)
      Sets the texture width
      Parameters:
      width - - the texture width

    • getIconTextureHeight

      int getIconTextureHeight()
      Gets the image textureHeight.
      Returns:
      textureHeight

    • setIconTextureHeight

      void setIconTextureHeight(Integer height)
      Sets the texture height
      Parameters:
      height - - the texture height

    • setIconTextureSize

      default void setIconTextureSize(int width, int height)
      Set the texture size
      Parameters:
      width - - the texture width
      height - - the texture height

    • setCustomData

      void setCustomData(String key, @Nullable @Nullable String data)
      Allows add-on devs to set custom data on their waypoints for use, this is not used by journeymap.
      Parameters:
      key - - they key for the data
      data - - String

    • getCustomData

      @Nullable @Nullable String getCustomData(String key)
      Gets the custom data stored on a waypoint
      Parameters:
      key - - they key for the data
      Returns:
      - String

    • showBeacon

      default boolean showBeacon()
      Returns:
      whether the waypoint's beacon beam renders

    • setShowBeacon

      default void setShowBeacon(boolean showBeacon)

    • showOnMap

      default boolean showOnMap()
      Returns:
      whether the waypoint renders on the 2D map

    • setShowOnMap

      default void setShowOnMap(boolean showOnMap)

    • showInWorld

      default boolean showInWorld()
      Returns:
      whether the waypoint renders in the world

    • setShowInWorld

      default void setShowInWorld(boolean showInWorld)

    • showLabel

      default boolean showLabel()
      Returns:
      whether the waypoint's name label renders

    • setShowLabel

      default void setShowLabel(boolean showLabel)

    • showIcon

      default boolean showIcon()
      Returns:
      whether the waypoint's icon renders

    • setShowIcon

      default void setShowIcon(boolean showIcon)

    • showOnLocatorBar

      default boolean showOnLocatorBar()
      Returns:
      whether the waypoint shows on the vanilla locator bar

    • setShowOnLocatorBar

      default void setShowOnLocatorBar(boolean showOnLocatorBar)

    • getBeaconColor

      default Integer getBeaconColor()
      Returns:
      the beacon color, or null to follow the icon color

    • setBeaconColor

      default void setBeaconColor(Integer beaconColor)

    • getLabelColor

      default Integer getLabelColor()
      Returns:
      the label color, or null to follow the icon color

    • setLabelColor

      default void setLabelColor(Integer labelColor)