Class MapPOI

Namespace

S1API.Map

Assembly

S1API.dll

A managed handle for a standalone point of interest on the phone map.

public sealed class MapPOI : IDisposable

Inheritance

object

MapPOI

Implements

IDisposable

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

ReflectionUtils.GetValueTupleItems(object)

ReflectionUtils.IsValueTuple(object)

Properties

Icon

The marker's custom icon, or null for the native appearance.

public Sprite? Icon { get; }

Property Value

Sprite

Id

The stable identifier used to register this marker.

public string Id { get; }

Property Value

string

IsReady

Whether the native POI component has been created.

public bool IsReady { get; }

Property Value

bool

IsRemoved

Whether this handle has been removed or invalidated by a scene change.

public bool IsRemoved { get; }

Property Value

bool

IsUIReady

Whether the phone map has created this marker's UI.

public bool IsUIReady { get; }

Property Value

bool

IsVisible

The requested marker visibility.

public bool IsVisible { get; }

Property Value

bool

Label

The marker's current display label.

public string Label { get; }

Property Value

string

Position

The marker's current world position.

public Vector3 Position { get; }

Property Value

Vector3

RotateWithTarget

Whether the marker icon rotates with its target heading.

public bool RotateWithTarget { get; }

Property Value

bool

Target

The moving target currently followed by the marker, if any.

public Transform? Target { get; }

Property Value

Transform

TextVisibility

Controls when the marker label is displayed.

public MapPOITextVisibility TextVisibility { get; }

Property Value

MapPOITextVisibility

UI

The live map UI transform, or null until it is available.

public RectTransform? UI { get; }

Property Value

RectTransform

Methods

Dispose()

public void Dispose()

Focus(bool)

Focuses the phone map on this marker.

public bool Focus(bool openMap = true)

Parameters

openMap bool

Whether to open the phone map before focusing it.

Returns

bool

true when the live marker UI was available and focused.

Remove()

Removes the marker and releases its native objects.

public bool Remove()

Returns

bool

true on the first removal; otherwise false.

SetIcon(Sprite?)

Updates or clears the marker's custom icon.

public MapPOI SetIcon(Sprite? icon)

Parameters

icon Sprite

Returns

MapPOI

SetLabel(string)

Updates the marker label.

public MapPOI SetLabel(string label)

Parameters

label string

Returns

MapPOI

SetPosition(Vector3)

Moves the marker to a fixed world position and clears its moving target.

public MapPOI SetPosition(Vector3 position)

Parameters

position Vector3

Returns

MapPOI

SetRotation(bool)

Updates whether the marker icon rotates with its target heading.

public MapPOI SetRotation(bool rotateWithTarget)

Parameters

rotateWithTarget bool

Returns

MapPOI

SetTarget(Transform)

Binds the marker to a moving target.

public MapPOI SetTarget(Transform target)

Parameters

target Transform

Returns

MapPOI

SetTextVisibility(MapPOITextVisibility)

Updates when the marker label is displayed.

public MapPOI SetTextVisibility(MapPOITextVisibility visibility)

Parameters

visibility MapPOITextVisibility

Returns

MapPOI

SetVisible(bool)

Shows or hides the marker.

public MapPOI SetVisible(bool visible)

Parameters

visible bool

Returns

MapPOI