Record Class OverlayShapeProps

java.lang.Object
java.lang.Record
journeymap.api.v2.server.overlay.OverlayShapeProps
Record Components:
fillColor - 0xRRGGBB; alpha is supplied separately as fillOpacity
fillOpacity - 0.0 (transparent) to 1.0 (opaque)
strokeColor - 0xRRGGBB
strokeWidth - pixels; 0 disables the stroke
strokeOpacity - 0.0 to 1.0
displayOrder - z-order among overlays; higher draws in front (default 1000)
minZoom - minimum fullscreen zoom at which the overlay is visible
maxZoom - maximum fullscreen zoom at which the overlay is visible
activeUIs - which UIs (Fullscreen, Minimap, Webmap) the overlay is visible in
activeMapTypes - which map types (Day, Night, etc.) the overlay is visible in
label - static label rendered with the polygon, or null for none
title - hover tooltip text, or null for none
public record OverlayShapeProps(int fillColor, float fillOpacity, int strokeColor, float strokeWidth, float strokeOpacity, int displayOrder, int minZoom, int maxZoom, Set<Context.UI> activeUIs, Set<Context.MapType> activeMapTypes, @Nullable String label, @Nullable String title) extends Record
Style and visibility properties applied to every polygon in a single ServerPolygon. Mirrors the subset of Overlay fields that are meaningful for server-pushed overlays. Interactive listeners are not supported in v1 and are therefore not represented here.

  • Constructor Details

    • OverlayShapeProps

      public OverlayShapeProps(int fillColor, float fillOpacity, int strokeColor, float strokeWidth, float strokeOpacity, int displayOrder, int minZoom, int maxZoom, Set<Context.UI> activeUIs, Set<Context.MapType> activeMapTypes, @Nullable @Nullable String label, @Nullable @Nullable String title)
      Creates an instance of a OverlayShapeProps record class.
      Parameters:
      fillColor - the value for the fillColor record component
      fillOpacity - the value for the fillOpacity record component
      strokeColor - the value for the strokeColor record component
      strokeWidth - the value for the strokeWidth record component
      strokeOpacity - the value for the strokeOpacity record component
      displayOrder - the value for the displayOrder record component
      minZoom - the value for the minZoom record component
      maxZoom - the value for the maxZoom record component
      activeUIs - the value for the activeUIs record component
      activeMapTypes - the value for the activeMapTypes record component
      label - the value for the label record component
      title - the value for the title record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • fillColor

      public int fillColor()
      Returns the value of the fillColor record component.
      Returns:
      the value of the fillColor record component

    • fillOpacity

      public float fillOpacity()
      Returns the value of the fillOpacity record component.
      Returns:
      the value of the fillOpacity record component

    • strokeColor

      public int strokeColor()
      Returns the value of the strokeColor record component.
      Returns:
      the value of the strokeColor record component

    • strokeWidth

      public float strokeWidth()
      Returns the value of the strokeWidth record component.
      Returns:
      the value of the strokeWidth record component

    • strokeOpacity

      public float strokeOpacity()
      Returns the value of the strokeOpacity record component.
      Returns:
      the value of the strokeOpacity record component

    • displayOrder

      public int displayOrder()
      Returns the value of the displayOrder record component.
      Returns:
      the value of the displayOrder record component

    • minZoom

      public int minZoom()
      Returns the value of the minZoom record component.
      Returns:
      the value of the minZoom record component

    • maxZoom

      public int maxZoom()
      Returns the value of the maxZoom record component.
      Returns:
      the value of the maxZoom record component

    • activeUIs

      public Set<Context.UI> activeUIs()
      Returns the value of the activeUIs record component.
      Returns:
      the value of the activeUIs record component

    • activeMapTypes

      public Set<Context.MapType> activeMapTypes()
      Returns the value of the activeMapTypes record component.
      Returns:
      the value of the activeMapTypes record component

    • label

      @Nullable public @Nullable String label()
      Returns the value of the label record component.
      Returns:
      the value of the label record component

    • title

      @Nullable public @Nullable String title()
      Returns the value of the title record component.
      Returns:
      the value of the title record component