livemap.layer.marker.Icon Class Reference

The icon marker is used to display clickable/draggable icons on the map. More...

Inheritance diagram for livemap.layer.marker.Icon:

Collaboration diagram for livemap.layer.marker.Icon:

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

Static Public Member Functions
static Icon	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 icon's anchor.
Point?	TargetPoint [get, set]
	Optional target point (relative to spawn) for translocators and similar markers.
new? IconOptions	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 icon marker is used to display clickable/draggable icons on the map.

This is mostly used to mark specific points in the world such as players, translocators, traders, cities, etc.
You can highlight entire areas instead of just a point with the Polygon

Constructor & Destructor Documentation

Icon() [1/2]

livemap.layer.marker.Icon.Icon ( )

inline

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

Icon() [2/2]

livemap.layer.marker.Icon.Icon ( string id, Point point, IconOptions? options = null )

inline

Create a new icon.

Parameters

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

Member Function Documentation

FromJson()

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

static

Property Documentation

Options

new? IconOptions livemap.layer.marker.Icon.Options

getset

Point

Point livemap.layer.marker.Icon.Point

getset

Absolute (not relative to spawn) world coordinates for the icon's anchor.

TargetPoint

Point? livemap.layer.marker.Icon.TargetPoint

getset

Optional target point (relative to spawn) for translocators and similar markers.

---

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

• src/layer/marker/Icon.cs