Package journeymap.api.v2.common.waypoint

Interface WaypointGroup

public interface WaypointGroup

  • Method Details

    • getWaypointIds

      List<String> getWaypointIds()

    • addWaypoint

      boolean addWaypoint(Waypoint waypoint)

    • getGuid

      String getGuid()

    • getModId

      String getModId()

    • getName

      String getName()

    • setName

      void setName(String name)

    • getDescription

      String getDescription()

    • setDescription

      void setDescription(String description)

    • getTag

      @Nullable @Nullable String getTag()
      A tag to easily identify waypoints in world an on the map.

      Example giving the group the tag 'Farm' would make the name -> "[Farm] Carrots" All waypoints in the group will have this tag.

      Returns:
      - the Tag

    • setTag

      void setTag(@Nullable @Nullable String tab)
      Sets the tag.
      Parameters:
      tab - - the Tag

    • isEnabled

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

    • setEnabled

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

    • isPersistent

      boolean isPersistent()

    • setPersistent

      void setPersistent(boolean persistent)

    • 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

    • isLocked

      boolean isLocked()
      Can users change group settings, including adding/removing waypoints
      Returns:
      the is locked

    • setLocked

      void setLocked(boolean locked)
      Set to true to lock users from modifying the group. This includes adding/removing waypoints and changing any of the settings of the group. Default - False
      Parameters:
      locked - - the locked boolean

    • getColor

      Integer getColor()

    • setColor

      void setColor(Integer color)

    • colorOverride

      boolean colorOverride()
      Does waypoint group override individual waypoint colors.
      Returns:
      if override

    • setColorOverride

      void setColorOverride(boolean override)
      Setting this to true, waypoints will use the group color instead of individual colors. Setting to false, waypoints will use their individual colors
      Parameters:
      override - to override

    • iconOverride

      boolean iconOverride()
      Does waypoint group override individual waypoint icons.
      Returns:
      if override

    • setIconOverride

      void setIconOverride(boolean override)
      Setting this to true, waypoints will use the group icons instead of individual iconss. Setting to false, waypoints will use their individual iconss
      Parameters:
      override - to override

    • 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 white (no tint). This is only to be used if the icon needs to have a separate color from the waypoint.
      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

    • setIconResourceLoctaion

      void setIconResourceLoctaion(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 textureWidth)
      Sets the texture width
      Parameters:
      textureWidth - - the texture width

    • getIconTextureHeight

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

    • setIconTextureHeight

      void setIconTextureHeight(Integer textureHeight)
      Sets the texture height
      Parameters:
      textureHeight - - 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(@Nullable @Nullable String data)
      Allows add-on devs to set custom data on their waypoint groups for use, this is not used by journeymap.
      Parameters:
      data - - String

    • getCustomData

      @Nullable @Nullable String getCustomData()
      Gets the custom data stored on a waypoint group
      Returns:

    • isShowOnLocatorBar

      boolean isShowOnLocatorBar()
      Returns:
      is showing waypoints for this group on the locator bar.

    • setShowOnLocatorBar

      void setShowOnLocatorBar(boolean showOnLocatorBar)
      Show waypoints in this group on the locator bar.