Package net.runelite.client.ui.overlay.worldmap

Class WorldMapPoint.WorldMapPointBuilder<C extends WorldMapPoint,B extends WorldMapPoint.WorldMapPointBuilder<C,B>>

java.lang.Object

net.runelite.client.ui.overlay.worldmap.WorldMapPoint.WorldMapPointBuilder<C,B>

Enclosing class:

WorldMapPoint

public abstract static class WorldMapPoint.WorldMapPointBuilder<C extends WorldMapPoint,B extends WorldMapPoint.WorldMapPointBuilder<C,B>>
extends Object

Constructor Summary

Constructors

Constructor	Description
WorldMapPointBuilder()

Method Summary

Modifier and Type	Method	Description
abstract C	build()
B	currentlyEdgeSnapped(boolean currentlyEdgeSnapped)
B	image(BufferedImage image)
B	imagePoint(net.runelite.api.Point imagePoint)	The point on the image that will be drawn at WorldPoint WorldMapPointManager will center the image if imagePoint is null
B	jumpOnClick(boolean jumpOnClick)	Whether or not the map jumps to target, or worldPoint when the overlay is clicked
B	name(String name)	Name in menu option when jumpOnClick is set
protected abstract B	self()
B	snapToEdge(boolean snapToEdge)
B	target(net.runelite.api.coords.WorldPoint target)	The WorldPoint which the worldmap will jump to when clicked
B	tooltip(String tooltip)
String	toString()
B	worldPoint(net.runelite.api.coords.WorldPoint worldPoint)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

WorldMapPointBuilder

public WorldMapPointBuilder()

Method Detail

image

public B image(BufferedImage image)

Returns:

this.

worldPoint

public B worldPoint(net.runelite.api.coords.WorldPoint worldPoint)

Returns:

this.

target

public B target(@Nullable
                net.runelite.api.coords.WorldPoint target)

The WorldPoint which the worldmap will jump to when clicked

Returns:

this.

imagePoint

public B imagePoint(net.runelite.api.Point imagePoint)

The point on the image that will be drawn at WorldPoint WorldMapPointManager will center the image if imagePoint is null

Returns:

this.

snapToEdge

public B snapToEdge(boolean snapToEdge)

Returns:

this.

currentlyEdgeSnapped

public B currentlyEdgeSnapped(boolean currentlyEdgeSnapped)

Returns:

this.

jumpOnClick

public B jumpOnClick(boolean jumpOnClick)

Whether or not the map jumps to target, or worldPoint when the overlay is clicked

Returns:

this.

name

public B name(String name)

Name in menu option when jumpOnClick is set

Returns:

this.

tooltip

public B tooltip(String tooltip)

Returns:

this.

self

protected abstract B self()

build

public abstract C build()

toString

public String toString()

Overrides:

toString in class Object