livemap.layer.marker.Polygon Class Reference

The polygon marker is used to draw polygon overlays on the map. More...

Inheritance diagram for livemap.layer.marker.Polygon:

Collaboration diagram for livemap.layer.marker.Polygon:

Public Member Functions
	Polygon ()
	Create a new polygon at 0,0 with a random id.
	Polygon (string id, Point points, PolygonOptions? options=null)
	Create a new polygon.
	Polygon (string id, Point[] points, PolygonOptions? options=null)
	Create a new polygon.
	Polygon (string id, Point[][] points, PolygonOptions? options=null)
	Create a new polygon.
	Polygon (string id, Point[][][] points, PolygonOptions? options=null)
	Create a new polygon.
Public Member Functions inherited from livemap.layer.marker.Marker
string	ToJson ()
	Serializes this object to a JSON string.

Static Public Member Functions
static Polygon	FromJson (string json)
Static Public Member Functions inherited from livemap.layer.marker.Marker
static T	FromJson< T > (string json)
	Deserializes a JSON string into an instance of this object.

Properties
Point[][][]	Points [get, set]
	Absolute (not relative to spawn) world coordinates for the polygon's points.
new? PolygonOptions	Options [get, set]
Properties inherited from livemap.layer.marker.Marker
string	Type [get]
	Type identifier for the marker.
string	Id [get]
	Unique id for the marker.
BaseOptions?	Options [get, set]
	Optional settings.
TooltipOptions?	Tooltip [get, set]
	Optional tooltip settings.
PopupOptions?	Popup [get, set]
	Optional popup settings.

Additional Inherited Members
Protected Member Functions inherited from livemap.layer.marker.Marker
	Marker (string type, string id)

Detailed Description

The polygon marker is used to draw polygon overlays on the map.

This is mostly used to show more complex shaped areas/sections of the world such as protected claims, cities, nations, etc.
You can make more basic shapes with the Rectangle

Constructor & Destructor Documentation

Polygon() [1/5]

livemap.layer.marker.Polygon.Polygon ( )

inline

Create a new polygon at 0,0 with a random id.

Polygon() [2/5]

livemap.layer.marker.Polygon.Polygon ( string id, Point points, PolygonOptions? options = null )

inline

Create a new polygon.

Parameters

id	Unique identifying key
points	Absolute (not relative to spawn) world coordinates for the polygon's points
options	Optional settings for the polygon

Polygon() [3/5]

livemap.layer.marker.Polygon.Polygon ( string id, Point[] points, PolygonOptions? options = null )

inline

Create a new polygon.

Parameters

id	Unique identifying key
points	Absolute (not relative to spawn) world coordinates for the polygon's points
options	Optional settings for the polygon

Polygon() [4/5]

livemap.layer.marker.Polygon.Polygon ( string id, Point points[][], PolygonOptions? options = null )

inline

Create a new polygon.

Parameters

id	Unique identifying key
points	Absolute (not relative to spawn) world coordinates for the polygon's points
options	Optional settings for the polygon

Polygon() [5/5]

livemap.layer.marker.Polygon.Polygon ( string id, Point points[][][], PolygonOptions? options = null )

inline

Create a new polygon.

Parameters

id	Unique identifying key
points	Absolute (not relative to spawn) world coordinates for the polygon's points
options	Optional settings for the polygon

Member Function Documentation

FromJson()

Polygon livemap.layer.marker.Polygon.FromJson ( string json )

static

Property Documentation

Options

new? PolygonOptions livemap.layer.marker.Polygon.Options

getset

Points

Point [][][] livemap.layer.marker.Polygon.Points

getset

Absolute (not relative to spawn) world coordinates for the polygon's points.

---

The documentation for this class was generated from the following file:

• src/layer/marker/Polygon.cs