journeymap.api.v2.server.overlay

Class ServerPolygon

java.lang.Object

journeymap.api.v2.server.overlay.ServerPolygon

public final class ServerPolygon
extends java.lang.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.server.level.ServerPlayer, 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.server.level.ServerPlayer, java.lang.String, java.lang.String) removes it.

Constructor Summary

Constructors

Constructor and Description
ServerPolygon(java.lang.String overlayId, net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> dimension, java.util.List<OverlayPolygon> polygons, OverlayShapeProps props)

Method Summary

Modifier and Type	Method and Description
net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level>	dimension()
boolean	equals(java.lang.Object o)
int	hashCode()
java.lang.String	overlayId()
java.util.List<OverlayPolygon>	polygons()
OverlayShapeProps	props()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerPolygon

public ServerPolygon(java.lang.String overlayId,
                     net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> dimension,
                     java.util.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 Detail

overlayId

public java.lang.String overlayId()

dimension

public net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> dimension()

polygons

public java.util.List<OverlayPolygon> polygons()

props

public OverlayShapeProps props()

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object