Struct TraversalTransitionDefinition

Namespace

Trailblazer.Pathing

Assembly

Trailblazer.dll

Describes one directed, source-map-owned semantic traversal action.

public readonly struct TraversalTransitionDefinition : IEquatable<TraversalTransitionDefinition>

Implements

IEquatable<TraversalTransitionDefinition>

Inherited Members

ValueType.ToString()

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

TraversalTransitionDefinition(string, TraversalTransitionType, VoxelIndex, TraversalMedium, NavigationCellAddress, TraversalMedium, TraversalCapability, Fixed64, TraversalTransitionLocomotionHints, Vector3d, bool, Vector3d, bool)

Creates one complete directed semantic transition definition.

public TraversalTransitionDefinition(string id, TraversalTransitionType type, VoxelIndex sourceIndex, TraversalMedium sourceMedium, NavigationCellAddress destination, TraversalMedium destinationMedium, TraversalCapability requiredCapabilities = TraversalCapability.None, Fixed64 actionCost = default, TraversalTransitionLocomotionHints locomotionHints = TraversalTransitionLocomotionHints.None, Vector3d sourcePointOverride = default, bool hasSourcePointOverride = false, Vector3d destinationPointOverride = default, bool hasDestinationPointOverride = false)

Parameters

id string

type TraversalTransitionType

sourceIndex VoxelIndex

sourceMedium TraversalMedium

destination NavigationCellAddress

destinationMedium TraversalMedium

requiredCapabilities TraversalCapability

actionCost Fixed64

locomotionHints TraversalTransitionLocomotionHints

sourcePointOverride Vector3d

hasSourcePointOverride bool

destinationPointOverride Vector3d

hasDestinationPointOverride bool

Properties

ActionCost

The non-negative surcharge for performing this semantic action.

public Fixed64 ActionCost { get; }

Property Value

Fixed64

Destination

The durable destination-cell address.

public NavigationCellAddress Destination { get; }

Property Value

NavigationCellAddress

DestinationMedium

The traversal medium used at the destination endpoint.

public TraversalMedium DestinationMedium { get; }

Property Value

TraversalMedium

DestinationPointOverride

The exact destination endpoint when HasDestinationPointOverride is true.

public Vector3d DestinationPointOverride { get; }

Property Value

Vector3d

HasDestinationPointOverride

Whether the destination endpoint overrides its cell anchor.

public bool HasDestinationPointOverride { get; }

Property Value

bool

HasSourcePointOverride

Whether the source endpoint overrides its cell anchor.

public bool HasSourcePointOverride { get; }

Property Value

bool

Id

The stable map-local transition identifier.

public string Id { get; }

Property Value

string

LocomotionHints

The authored built-in locomotion intent for this semantic action.

public TraversalTransitionLocomotionHints LocomotionHints { get; }

Property Value

TraversalTransitionLocomotionHints

RequiredCapabilities

The complete set of capabilities required to use this transition.

public TraversalCapability RequiredCapabilities { get; }

Property Value

TraversalCapability

SourceIndex

The local source-cell index in the owning map.

public VoxelIndex SourceIndex { get; }

Property Value

VoxelIndex

SourceMedium

The traversal medium used at the source endpoint.

public TraversalMedium SourceMedium { get; }

Property Value

TraversalMedium

SourcePointOverride

The exact source endpoint when HasSourcePointOverride is true.

public Vector3d SourcePointOverride { get; }

Property Value

Vector3d

Type

The semantic action performed by this transition.

public TraversalTransitionType Type { get; }

Property Value

TraversalTransitionType

Methods

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

Equals(TraversalTransitionDefinition)

public bool Equals(TraversalTransitionDefinition other)

Parameters

other TraversalTransitionDefinition

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

Operators

operator ==(TraversalTransitionDefinition, TraversalTransitionDefinition)

Tests two definitions for value equality.

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

Parameters

left TraversalTransitionDefinition

right TraversalTransitionDefinition

Returns

bool

operator !=(TraversalTransitionDefinition, TraversalTransitionDefinition)

Tests two definitions for value inequality.

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

Parameters

left TraversalTransitionDefinition

right TraversalTransitionDefinition

Returns

bool