livemap.layer.marker.Rectangle Class Reference

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

Inheritance diagram for livemap.layer.marker.Rectangle:

Collaboration diagram for livemap.layer.marker.Rectangle:

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

Static Public Member Functions
static Rectangle	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[]	Point [get, set]
	Absolute (not relative to spawn) world coordinates for the rectangle's points.
new? RectangleOptions	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 rectangle marker is used to draw rectangle overlays on the map.

This is mostly used to show specific areas/sections of the world such as protected claims, cities, nations, etc.
You can make more detailed shapes with the Polygon

Constructor & Destructor Documentation

Rectangle() [1/2]

livemap.layer.marker.Rectangle.Rectangle ( )

inline

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

Rectangle() [2/2]

livemap.layer.marker.Rectangle.Rectangle ( string id, Point[] point, RectangleOptions? options = null )

inline

Create a new rectangle.

Parameters

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

Member Function Documentation

FromJson()

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

static

Property Documentation

Options

new? RectangleOptions livemap.layer.marker.Rectangle.Options

getset

Point

Point [] livemap.layer.marker.Rectangle.Point

getset

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

---

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

• src/layer/marker/Rectangle.cs