getImage
getImage: (WorldMapPoint) -> BufferedImage?The image drawn at the point (nil: nothing is drawn). Override it to draw another.
WorldMapPoint.new(…)
WorldMapPoint.builder():build()| Method | Returns | Description |
|---|---|---|
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() | boolean | Whether 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() | boolean | Whether the image is at the edge now (the overlay sets it). |
setCurrentlyEdgeSnapped(boolean) | () | Set whether the image is at the edge now. |
isJumpOnClick() | boolean | Whether 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() | WorldMapPointBuilder | A builder with every field unset. |
| Method | Returns | Description |
|---|---|---|
WorldMapPointBuilder.build | WorldMapPoint | The point, with the fields set so far. |
WorldMapPointClass.new | WorldMapPoint | (WorldPoint?, BufferedImage?) -> WorldMapPoint: A point at worldPoint showing image; a subclass (class(WorldMapPoint)) calls it as… |
getImagegetImage: (WorldMapPoint) -> BufferedImage?The image drawn at the point (nil: nothing is drawn). Override it to draw another.
setImagesetImage: (WorldMapPoint, BufferedImage?) -> ()Set the image drawn at the point.
getWorldPointgetWorldPoint: (WorldMapPoint) -> WorldPoint?The tile the image is drawn at.
setWorldPointsetWorldPoint: (WorldMapPoint, WorldPoint?) -> ()Set the tile the image is drawn at.
getTargetgetTarget: (WorldMapPoint) -> WorldPoint?Where "Focus on" scrolls the map (nil: the point's own tile).
setTargetsetTarget: (WorldMapPoint, WorldPoint?) -> ()Set where "Focus on" scrolls the map.
getImagePointgetImagePoint: (WorldMapPoint) -> Point?The pixel of the image drawn on the tile (nil: the image's centre).
setImagePointsetImagePoint: (WorldMapPoint, Point?) -> ()Set the pixel of the image drawn on the tile.
isSnapToEdgeisSnapToEdge: (WorldMapPoint) -> booleanWhether the image stays at the map's edge when its tile is off the map.
setSnapToEdgesetSnapToEdge: (WorldMapPoint, boolean) -> ()Set whether the image stays at the map's edge.
isCurrentlyEdgeSnappedisCurrentlyEdgeSnapped: (WorldMapPoint) -> booleanWhether the image is at the edge now (the overlay sets it).
setCurrentlyEdgeSnappedsetCurrentlyEdgeSnapped: (WorldMapPoint, boolean) -> ()Set whether the image is at the edge now.
isJumpOnClickisJumpOnClick: (WorldMapPoint) -> booleanWhether hovering the image offers "Focus on" its name.
setJumpOnClicksetJumpOnClick: (WorldMapPoint, boolean) -> ()Set whether hovering the image offers "Focus on".
getNamegetName: (WorldMapPoint) -> string?The name the "Focus on" entry shows. Override it to show another.
setNamesetName: (WorldMapPoint, string?) -> ()Set the name the "Focus on" entry shows.
getTooltipgetTooltip: (WorldMapPoint) -> string?The tooltip shown while the image is hovered (<br> breaks lines). Override it to show another.
setTooltipsetTooltip: (WorldMapPoint, string?) -> ()Set the tooltip shown while the image is hovered.
onEdgeSnaponEdgeSnap: (WorldMapPoint) -> ()Called when the image snaps to the map's edge; does nothing (override it).
onEdgeUnsnaponEdgeUnsnap: (WorldMapPoint) -> ()Called when the image leaves the map's edge; does nothing (override it).
newnew: ((WorldPoint?, BufferedImage?) -> WorldMapPoint) & ((WorldMapPointBuilder) -> WorldMapPoint)(WorldPoint?, BufferedImage?) -> WorldMapPoint: A point at worldPoint showing image; a subclass (class(WorldMapPoint)) calls it as X.super.init(self, worldPoint, image).
(WorldMapPointBuilder) -> WorldMapPoint: A point with every field from builder.
builderbuilder: () -> WorldMapPointBuilderA builder with every field unset.