Struct NavigationEndpoint

Namespace

Trailblazer.Pathing

Assembly

Trailblazer.dll

Describes one immutable world-space endpoint of a path query.

public readonly struct NavigationEndpoint : IEquatable<NavigationEndpoint>

Implements

IEquatable<NavigationEndpoint>

Inherited Members

ValueType.ToString()

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

NavigationEndpoint(Vector3d, string?, EndpointResolutionPolicy, Fixed64)

Creates an immutable navigation endpoint.

public NavigationEndpoint(Vector3d position, string? mapId = null, EndpointResolutionPolicy resolution = EndpointResolutionPolicy.Strict, Fixed64 maxResolutionDistance = default)

Parameters

position Vector3d

mapId string

resolution EndpointResolutionPolicy

maxResolutionDistance Fixed64

Exceptions

ArgumentException

Thrown when a supplied map identifier is empty or whitespace.

ArgumentOutOfRangeException

Thrown when the policy is unknown or the distance is negative.

Properties

MapId

Gets the optional stable map identifier used to filter endpoint candidates.

public string? MapId { get; }

Property Value

string

MaxResolutionDistance

Gets the non-negative maximum resolution distance in world units.

public Fixed64 MaxResolutionDistance { get; }

Property Value

Fixed64

Position

Gets the exact requested foot position in world space.

public Vector3d Position { get; }

Property Value

Vector3d

Resolution

Gets the endpoint resolution policy.

public EndpointResolutionPolicy Resolution { get; }

Property Value

EndpointResolutionPolicy

Methods

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

Equals(NavigationEndpoint)

public bool Equals(NavigationEndpoint other)

Parameters

other NavigationEndpoint

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

Operators

operator ==(NavigationEndpoint, NavigationEndpoint)

Returns whether two endpoints have exactly equal values.

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

Parameters

left NavigationEndpoint

right NavigationEndpoint

Returns

bool

operator !=(NavigationEndpoint, NavigationEndpoint)

Returns whether two endpoints differ.

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

Parameters

left NavigationEndpoint

right NavigationEndpoint

Returns

bool