journeymap.api.v2.common.waypoint

Interface WaypointGroup

public interface WaypointGroup

Method Summary

Modifier and Type	Method and Description
boolean	addWaypoint(Waypoint waypoint)
boolean	colorOverride() Does waypoint group override individual waypoint colors.
default java.lang.Integer	getBeaconColor()
java.lang.Integer	getColor()
@Nullable java.lang.String	getCustomData(java.lang.String key) Gets the custom data stored on a waypoint group
java.lang.String	getDescription()
java.lang.String	getGuid()
java.lang.Integer	getIconColor() Gets color.
net.minecraft.resources.ResourceLocation	getIconIdentifier() Gets the texture resource location.
float	getIconOpacity() Gets opacity.
int	getIconRotation() Gets the rotation in degrees the image should be oriented.
int	getIconTextureHeight() Gets the image textureHeight.
int	getIconTextureWidth() Gets the image textureWidth.
default java.lang.Integer	getLabelColor()
java.lang.String	getModId()
java.lang.String	getName()
@Nullable java.lang.String	getTag() A tag to easily identify waypoints in world an on the map.
java.util.List<java.lang.String>	getWaypointIds()
boolean	iconOverride() Does waypoint group override individual waypoint icons.
boolean	isEnabled() Is waypoint group enabled.
boolean	isLocked() Can users change group settings, including adding/removing waypoints
boolean	isPersistent()
boolean	isShowOnLocatorBar()
default boolean	overrideColors()
default boolean	overrideSettings()
default void	setBeaconColor(java.lang.Integer beaconColor)
void	setColor(java.lang.Integer color)
void	setColorOverride(boolean override) Setting this to true, waypoints will use the group color instead of individual colors.
void	setCustomData(java.lang.String key, @Nullable java.lang.String data) Allows add-on devs to set custom data on their waypoint group for use, this is not used by journeymap.
void	setDescription(java.lang.String description)
void	setEnabled(boolean enabled) Set waypoint group enabled / disabled
void	setIconColor(java.lang.Integer color) Sets color used to tint the image.
void	setIconIdentifier(net.minecraft.resources.ResourceLocation ResourceLocation) Sets the texture resource location.
void	setIconOpacity(float opacity) Sets opacity.
void	setIconOverride(boolean override) Setting this to true, waypoints will use the group icons instead of individual iconss.
void	setIconRotation(int rotation) Sets the rotation in degrees the image should be oriented.
void	setIconTextureHeight(java.lang.Integer textureHeight) Sets the texture height
default void	setIconTextureSize(int width, int height) Set the texture size
void	setIconTextureWidth(java.lang.Integer textureWidth) Sets the texture width
default void	setLabelColor(java.lang.Integer labelColor)
void	setLocked(boolean locked) Set to true to lock users from modifying the group.
void	setName(java.lang.String name)
default void	setOverrideColors(boolean overrideColors)
default void	setOverrideSettings(boolean overrideSettings)
void	setPersistent(boolean persistent)
default void	setShowBeacon(boolean showBeacon)
void	setShowDeviation(boolean showDeviation) Sets the show deviation text on the beacon.
default void	setShowIcon(boolean showIcon)
default void	setShowInWorld(boolean showInWorld)
default void	setShowLabel(boolean showLabel)
void	setShowOnLocatorBar(boolean showOnLocatorBar) Show waypoints in this group on the locator bar.
default void	setShowOnMap(boolean showOnMap)
void	setTag(@Nullable java.lang.String tab) Sets the tag.
default boolean	showBeacon()
boolean	showDeviation() Is deviation being shown
default boolean	showIcon()
default boolean	showInWorld()
default boolean	showLabel()
default boolean	showOnMap()

Method Detail

getWaypointIds

java.util.List<java.lang.String> getWaypointIds()

addWaypoint

boolean addWaypoint(Waypoint waypoint)

getGuid

java.lang.String getGuid()

getModId

java.lang.String getModId()

getName

java.lang.String getName()

setName

void setName(java.lang.String name)

getDescription

java.lang.String getDescription()

setDescription

void setDescription(java.lang.String description)

getTag

@Nullable
@Nullable java.lang.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 java.lang.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

java.lang.Integer getColor()

setColor

void setColor(java.lang.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

java.lang.Integer getIconColor()

Gets color.

Returns:

the color

setIconColor

void setIconColor(java.lang.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.ResourceLocation getIconIdentifier()

Gets the texture resource location.

Returns:

- ResourceLocation

setIconIdentifier

void setIconIdentifier(net.minecraft.resources.ResourceLocation ResourceLocation)

Sets the texture resource location.

Parameters:

ResourceLocation - - the resource location

getIconTextureWidth

int getIconTextureWidth()

Gets the image textureWidth.

Returns:

textureWidth

setIconTextureWidth

void setIconTextureWidth(java.lang.Integer textureWidth)

Sets the texture width

Parameters:

textureWidth - - the texture width

getIconTextureHeight

int getIconTextureHeight()

Gets the image textureHeight.

Returns:

textureHeight

setIconTextureHeight

void setIconTextureHeight(java.lang.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(java.lang.String key,
                   @Nullable
                   @Nullable java.lang.String data)

Allows add-on devs to set custom data on their waypoint group for use, this is not used by journeymap.

Parameters:

key - - they key for the data

data - - String

getCustomData

@Nullable
@Nullable java.lang.String getCustomData(java.lang.String key)

Gets the custom data stored on a waypoint group

Parameters:

key - - they key for the data

Returns:

- String

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.

showBeacon

default boolean showBeacon()

setShowBeacon

default void setShowBeacon(boolean showBeacon)

showOnMap

default boolean showOnMap()

setShowOnMap

default void setShowOnMap(boolean showOnMap)

showInWorld

default boolean showInWorld()

setShowInWorld

default void setShowInWorld(boolean showInWorld)

showLabel

default boolean showLabel()

setShowLabel

default void setShowLabel(boolean showLabel)

showIcon

default boolean showIcon()

setShowIcon

default void setShowIcon(boolean showIcon)

getBeaconColor

default java.lang.Integer getBeaconColor()

setBeaconColor

default void setBeaconColor(java.lang.Integer beaconColor)

getLabelColor

default java.lang.Integer getLabelColor()

setLabelColor

default void setLabelColor(java.lang.Integer labelColor)

overrideColors

default boolean overrideColors()

Returns:

whether this group overrides its members' colors

setOverrideColors

default void setOverrideColors(boolean overrideColors)

overrideSettings

default boolean overrideSettings()

Returns:

whether this group overrides its members' visibility settings

setOverrideSettings

default void setOverrideSettings(boolean overrideSettings)