Struct NavigationGuideLease

Namespace

Trailblazer.Pathing

Assembly

Trailblazer.dll

Owns one graph-backed A* payload reference and its guide-local step cursor.

public readonly struct NavigationGuideLease : IDisposable

Implements

IDisposable

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Properties

CurrentStepIndex

Gets the zero-based guide-local step cursor.

public int CurrentStepIndex { get; }

Property Value

int

Status

Gets the lease's current dependency-validated status.

public NavigationGuideStatus Status { get; }

Property Value

NavigationGuideStatus

StepCount

Gets the immutable number of movement and action steps in the leased route.

public int StepCount { get; }

Property Value

int

TotalCost

Gets the immutable exact fixed-point cost of the complete route.

public Fixed64 TotalCost { get; }

Property Value

Fixed64

Methods

CompletePendingTransition(in NavigationTransitionInstruction)

Completes the exact current pending semantic action.

public NavigationGuideStatus CompletePendingTransition(in NavigationTransitionInstruction instruction)

Parameters

instruction NavigationTransitionInstruction

Returns

NavigationGuideStatus

Dispose()

public void Dispose()

TryAdvanceStep()

Advances one ordinary movement step; a pending action cannot be crossed.

public NavigationGuideStatus TryAdvanceStep()

Returns

NavigationGuideStatus

TryGetCurrentStep(out NavigationGuideStep)

Gets the current dependency-validated movement or action step.

public NavigationGuideStatus TryGetCurrentStep(out NavigationGuideStep step)

Parameters

step NavigationGuideStep

Returns

NavigationGuideStatus