Struct MapMarker

Namespace

SkyrimForge.Game

Assembly

SkyrimForge.dll

A location's map marker.

public readonly struct MapMarker : IEquatable<MapMarker>

Implements

IEquatable<MapMarker>

Inherited Members

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Remarks

LocationId is null for a marker whose reference states no location. IsVisible is whether the map shows the marker, and CanTravelTo whether the player can fast travel to it.

Constructors

MapMarker(FormId<Location>?, FormId<ObjectReference>, FormId<WorldSpace>, NiPoint3, string, MARKER_TYPE, bool, bool)

A location's map marker.

public MapMarker(FormId<Location>? LocationId, FormId<ObjectReference> ReferenceId, FormId<WorldSpace> WorldspaceId, NiPoint3 Position, string Name, MARKER_TYPE Kind, bool IsVisible, bool CanTravelTo)

Parameters

LocationId FormId<Location>?

ReferenceId FormId<ObjectReference>

WorldspaceId FormId<WorldSpace>

Position NiPoint3

Name string

Kind MARKER_TYPE

IsVisible bool

CanTravelTo bool

Remarks

LocationId is null for a marker whose reference states no location. IsVisible is whether the map shows the marker, and CanTravelTo whether the player can fast travel to it.

Properties

CanTravelTo

public bool CanTravelTo { get; init; }

Property Value

bool

IsVisible

public bool IsVisible { get; init; }

Property Value

bool

Kind

public MARKER_TYPE Kind { get; init; }

Property Value

MARKER_TYPE

LocationId

public FormId<Location>? LocationId { get; init; }

Property Value

FormId<Location>?

Name

public string Name { get; init; }

Property Value

string

Position

public NiPoint3 Position { get; init; }

Property Value

NiPoint3

ReferenceId

public FormId<ObjectReference> ReferenceId { get; init; }

Property Value

FormId<ObjectReference>

WorldspaceId

public FormId<WorldSpace> WorldspaceId { get; init; }

Property Value

FormId<WorldSpace>

Methods

Deconstruct(out FormId<Location>?, out FormId<ObjectReference>, out FormId<WorldSpace>, out NiPoint3, out string, out MARKER_TYPE, out bool, out bool)

public void Deconstruct(out FormId<Location>? LocationId, out FormId<ObjectReference> ReferenceId, out FormId<WorldSpace> WorldspaceId, out NiPoint3 Position, out string Name, out MARKER_TYPE Kind, out bool IsVisible, out bool CanTravelTo)

Parameters

LocationId FormId<Location>?

ReferenceId FormId<ObjectReference>

WorldspaceId FormId<WorldSpace>

Position NiPoint3

Name string

Kind MARKER_TYPE

IsVisible bool

CanTravelTo bool

Equals(MapMarker)

public bool Equals(MapMarker other)

Parameters

other MapMarker

Returns

bool

Equals(object)

public override bool Equals(object obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

ToString()

public override string ToString()

Returns

string

Operators

operator ==(MapMarker, MapMarker)

public static bool operator ==(MapMarker left, MapMarker right)

Parameters

left MapMarker

right MapMarker

Returns

bool

operator !=(MapMarker, MapMarker)

public static bool operator !=(MapMarker left, MapMarker right)

Parameters

left MapMarker

right MapMarker

Returns

bool