WorldMapPoint

Methods
22
Fields
None

Getting one

WorldMapPoint.new(…)
WorldMapPoint.builder():build()

Methods

MethodReturnsDescription
getImage()BufferedImage?The image drawn at the point (nil: nothing is drawn). Override it to draw another.
setImage(BufferedImage?)()Set the image drawn at the point.
getWorldPoint()WorldPoint?The tile the image is drawn at.
setWorldPoint(WorldPoint?)()Set the tile the image is drawn at.
getTarget()WorldPoint?Where "Focus on" scrolls the map (nil: the point's own tile).
setTarget(WorldPoint?)()Set where "Focus on" scrolls the map.
getImagePoint()Point?The pixel of the image drawn on the tile (nil: the image's centre).
setImagePoint(Point?)()Set the pixel of the image drawn on the tile.
isSnapToEdge()booleanWhether the image stays at the map's edge when its tile is off the map.
setSnapToEdge(boolean)()Set whether the image stays at the map's edge.
isCurrentlyEdgeSnapped()booleanWhether the image is at the edge now (the overlay sets it).
setCurrentlyEdgeSnapped(boolean)()Set whether the image is at the edge now.
isJumpOnClick()booleanWhether hovering the image offers "Focus on" its name.
setJumpOnClick(boolean)()Set whether hovering the image offers "Focus on".
getName()string?The name the "Focus on" entry shows. Override it to show another.
setName(string?)()Set the name the "Focus on" entry shows.
getTooltip()string?The tooltip shown while the image is hovered (<br> breaks lines). Override it to show another.
setTooltip(string?)()Set the tooltip shown while the image is hovered.
onEdgeSnap()()Called when the image snaps to the map's edge; does nothing (override it).
onEdgeUnsnap()()Called when the image leaves the map's edge; does nothing (override it).
new(WorldPoint?, BufferedImage?)WorldMapPoint(WorldPoint?, BufferedImage?) -> WorldMapPoint: A point at worldPoint showing image; a subclass (class(WorldMapPoint)) calls it as…
new(WorldMapPointBuilder)WorldMapPoint
builder()WorldMapPointBuilderA builder with every field unset.

Returned by

MethodReturnsDescription
WorldMapPointBuilder.buildWorldMapPointThe point, with the fields set so far.
WorldMapPointClass.newWorldMapPoint(WorldPoint?, BufferedImage?) -> WorldMapPoint: A point at worldPoint showing image; a subclass (class(WorldMapPoint)) calls it as…

Method details

getName

getName: (WorldMapPoint) -> string?

The name the "Focus on" entry shows. Override it to show another.

getTooltip

getTooltip: (WorldMapPoint) -> string?

The tooltip shown while the image is hovered (<br> breaks lines). Override it to show another.

onEdgeSnap

onEdgeSnap: (WorldMapPoint) -> ()

Called when the image snaps to the map's edge; does nothing (override it).