journeymap.api.v2.common.waypoint

Interface Waypoint

public interface Waypoint

Method Summary

Modifier and Type	Method and Description
default java.lang.Integer	getBeaconColor()
net.minecraft.core.BlockPos	getBlockPos()
int	getBlue()
int	getColor()
@Nullable java.lang.String	getCustomData(java.lang.String key) Gets the custom data stored on a waypoint
default @Nullable java.lang.String	getDescription() Optional free-form description shown in the waypoint manager tooltip.
java.util.TreeSet<java.lang.String>	getDimensions()
int	getGreen()
java.lang.String	getGroupId() Unique id of the group this waypoint belongs to.
java.lang.String	getGuid() Unique Id for each waypoint, will not change.
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.
java.lang.String	getId() Non-unique id that is a comibination of modId and waypoint position.
default java.lang.Integer	getLabelColor()
java.lang.String	getModId()
java.lang.String	getName()
java.lang.String	getPrimaryDimension()
int	getRed()
int	getX()
int	getY()
int	getZ()
boolean	isEnabled() Is waypoint enabled.
boolean	isPersistent()
default void	setBeaconColor(java.lang.Integer beaconColor)
void	setBlockPos(net.minecraft.core.BlockPos pos)
void	setBlue(int blue)
void	setColor(int color)
void	setCustomData(java.lang.String key, @Nullable java.lang.String data) Allows add-on devs to set custom data on their waypoints for use, this is not used by journeymap.
default void	setDescription(@Nullable java.lang.String description)
void	setDimensions(java.util.Collection<java.lang.String> dims)
void	setEnabled(boolean enabled) Set waypoint enabled / disabled
void	setGreen(int green)
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	setIconRotation(int rotation) Sets the rotation in degrees the image should be oriented.
void	setIconTextureHeight(java.lang.Integer height) Sets the texture height
default void	setIconTextureSize(int width, int height) Set the texture size
void	setIconTextureWidth(java.lang.Integer width) Sets the texture width
default void	setLabelColor(java.lang.Integer labelColor)
void	setName(java.lang.String name)
void	setPersistent(boolean persistent)
void	setPos(int x, int y, int z)
default void	setPrimaryDimension(net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> dimension)
void	setPrimaryDimension(java.lang.String dimension)
void	setRed(int red)
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)
default void	setShowOnLocatorBar(boolean showOnLocatorBar)
default void	setShowOnMap(boolean showOnMap)
void	setX(int x)
void	setY(int y)
void	setZ(int z)
default boolean	showBeacon()
boolean	showDeviation() Is deviation being shown
default boolean	showIcon()
default boolean	showInWorld()
default boolean	showLabel()
default boolean	showOnLocatorBar()
default boolean	showOnMap()

Method Detail

getId

java.lang.String getId()

Non-unique id that is a comibination of modId and waypoint position.

getGuid

java.lang.String getGuid()

Unique Id for each waypoint, will not change.

getGroupId

java.lang.String getGroupId()

Unique id of the group this waypoint belongs to.

getModId

java.lang.String getModId()

getName

java.lang.String getName()

setName

void setName(java.lang.String name)

getDescription

@Nullable
default @Nullable java.lang.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 java.lang.String description)

See Also:

getDescription()

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

java.util.TreeSet<java.lang.String> getDimensions()

setDimensions

void setDimensions(java.util.Collection<java.lang.String> dims)

setPrimaryDimension

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

setPrimaryDimension

void setPrimaryDimension(java.lang.String dimension)

getPrimaryDimension

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

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 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.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 width)

Sets the texture width

Parameters:

width - - the texture width

getIconTextureHeight

int getIconTextureHeight()

Gets the image textureHeight.

Returns:

textureHeight

setIconTextureHeight

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

Returns:

the beacon color, or null to follow the icon color

setBeaconColor

default void setBeaconColor(java.lang.Integer beaconColor)

getLabelColor

default java.lang.Integer getLabelColor()

Returns:

the label color, or null to follow the icon color

setLabelColor

default void setLabelColor(java.lang.Integer labelColor)