journeymap.api.v2.client.display

Class ImageOverlay

java.lang.Object

journeymap.api.v2.client.display.Displayable

journeymap.api.v2.client.display.Overlay

journeymap.api.v2.client.display.ImageOverlay

All Implemented Interfaces:

java.lang.Comparable<Displayable>

@ParametersAreNonnullByDefault
public final class ImageOverlay
extends Overlay

An image overlay places an image on the map between the given coordinates.

Setters use the Builder pattern so they can be chained.

Note that like all Displayables, simply changing this object doesn't guarantee the player will get the changes. You must call IClientAPI.show(Displayable) in order for the changes to take effect in JourneyMap.

Field Summary

Fields inherited from class journeymap.api.v2.client.display.Overlay

activeMapTypes, activeUIs, dimension, displayOrder, label, maxZoom, minZoom, needsRerender, overlayGroupName, overlayListener, textProperties, title

Fields inherited from class journeymap.api.v2.client.display.Displayable

displayType, id, modId

Constructor Summary

Constructors

Constructor and Description
ImageOverlay(java.lang.String modId, net.minecraft.core.BlockPos northWestPoint, net.minecraft.core.BlockPos southEastPoint, MapImage image) Constructor.

Method Summary

Modifier and Type	Method and Description
MapImage	getImage() Image to display as the overlay.
net.minecraft.core.BlockPos	getNorthWestPoint() Top-left location of the image overlay.
net.minecraft.core.BlockPos	getSouthEastPoint() Bottom-right location of the image overlay.
ImageOverlay	setImage(MapImage image) Sets image to display as the overlay.
ImageOverlay	setNorthWestPoint(net.minecraft.core.BlockPos northWestPoint) Sets top-left location of the image overlay.
ImageOverlay	setSouthEastPoint(net.minecraft.core.BlockPos southEastPoint) Sets bottom-right location of the image overlay.
java.lang.String	toString()

Methods inherited from class journeymap.api.v2.client.display.Overlay

clearFlagForRerender, flagForRerender, getActiveMapTypes, getActiveUIs, getDimension, getDisplayOrder, getLabel, getMaxZoom, getMinZoom, getNeedsRerender, getOverlayGroupName, getOverlayListener, getTextProperties, getTitle, isActiveIn, isInZoomRange, setActiveMapTypes, setActiveUIs, setDimension, setDisplayOrder, setLabel, setMaxZoom, setMinZoom, setOverlayGroupName, setOverlayListener, setTextProperties, setTitle, toStringHelper

Methods inherited from class journeymap.api.v2.client.display.Displayable

clampOpacity, clampRGB, compareTo, equals, getDisplayType, getGuid, getId, getModId, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ImageOverlay

public ImageOverlay(java.lang.String modId,
                    net.minecraft.core.BlockPos northWestPoint,
                    net.minecraft.core.BlockPos southEastPoint,
                    MapImage image)

Constructor.

Parameters:

modId - Your mod id.

northWestPoint - Location of the top-left corner of the image.

southEastPoint - Location of the lower-right corner of the image.

image - The image to display as the overlay.

Method Detail

getNorthWestPoint

public net.minecraft.core.BlockPos getNorthWestPoint()

Top-left location of the image overlay.

setNorthWestPoint

public ImageOverlay setNorthWestPoint(net.minecraft.core.BlockPos northWestPoint)

Sets top-left location of the image overlay.

Parameters:

northWestPoint - point

Returns:

this

getSouthEastPoint

public net.minecraft.core.BlockPos getSouthEastPoint()

Bottom-right location of the image overlay.

setSouthEastPoint

public ImageOverlay setSouthEastPoint(net.minecraft.core.BlockPos southEastPoint)

Sets bottom-right location of the image overlay.

Parameters:

southEastPoint - point

Returns:

this

getImage

public MapImage getImage()

Image to display as the overlay.

Returns:

icon

setImage

public ImageOverlay setImage(MapImage image)

Sets image to display as the overlay.

Parameters:

image - image

Returns:

this

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object