Package journeymap.api.v2.server.overlay

Class ServerPolygon

java.lang.Object

journeymap.api.v2.server.overlay.ServerPolygon

public final class ServerPolygon
extends Object

One logical overlay pushed by a server addon. May contain many disjoint OverlayPolygons sharing one set of OverlayShapeProps.

The overlayId is a stable, addon-chosen string. Re-calling IServerOverlayAPI.show(net.minecraft.entity.player.EntityPlayerMP, java.lang.String, journeymap.api.v2.server.overlay.ServerPolygon...) with the same (modId, overlayId) pair replaces any prior version on the client; calling IServerOverlayAPI.remove(net.minecraft.entity.player.EntityPlayerMP, java.lang.String, java.lang.String) removes it.

Constructor Summary

Constructors

Constructor	Description
ServerPolygon(String overlayId, int dimension, List<OverlayPolygon> polygons, OverlayShapeProps props)

Method Summary

Modifier and Type	Method	Description
int	dimension()
boolean	equals(Object o)
int	hashCode()
String	overlayId()
List<OverlayPolygon>	polygons()
OverlayShapeProps	props()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ServerPolygon

public ServerPolygon(String overlayId,
 int dimension,
 List<OverlayPolygon> polygons,
 OverlayShapeProps props)

Parameters:

overlayId - the addon-stable handle for this overlay

dimension - the dimension this overlay belongs to

polygons - one or more polygons, all sharing the same shape props

props - style and visibility for every polygon in this overlay

Method Details

overlayId

public String overlayId()

dimension

public int dimension()

polygons

public List<OverlayPolygon> polygons()

props

public OverlayShapeProps props()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object