Class PluginMapMarker

Namespace

AcDream.Plugin.Abstractions

Assembly

AcDream.Plugin.Abstractions.dll

A map marker owned by a plugin.

public sealed record PluginMapMarker : IEquatable<PluginMapMarker>

Inheritance

object

PluginMapMarker

Implements

IEquatable<PluginMapMarker>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

PluginMapMarker(string, PluginMapPoint, string?, string?, string?, bool)

A map marker owned by a plugin.

public PluginMapMarker(string Id, PluginMapPoint Position, string? Label = null, string? IconId = null, string? Tooltip = null, bool IsSelected = false)

Parameters

Id string

The marker's name, unique on its map. Input about the marker names it by this.

Position PluginMapPoint

Where in the world the marker stands.

Label string

Text shown beside the marker, or null for none.

IconId string

The id of an icon among the plugin's resources, or null for the host's default marker.

Tooltip string

Text shown when the pointer rests on the marker, or null for none.

IsSelected bool

Whether the marker is drawn as the selected one.

Properties

IconId

The id of an icon among the plugin's resources, or null for the host's default marker.

public string? IconId { get; init; }

Property Value

string

Id

The marker's name, unique on its map. Input about the marker names it by this.

public string Id { get; init; }

Property Value

string

IsSelected

Whether the marker is drawn as the selected one.

public bool IsSelected { get; init; }

Property Value

bool

Label

Text shown beside the marker, or null for none.

public string? Label { get; init; }

Property Value

string

Position

Where in the world the marker stands.

public PluginMapPoint Position { get; init; }

Property Value

PluginMapPoint

Tooltip

Text shown when the pointer rests on the marker, or null for none.

public string? Tooltip { get; init; }

Property Value

string