Struct NavigationAgentProfile

Namespace

Trailblazer.Pathing

Assembly

Trailblazer.dll

Defines immutable geometry and traversal capabilities for a navigation query.

public readonly struct NavigationAgentProfile : IEquatable<NavigationAgentProfile>

Implements

IEquatable<NavigationAgentProfile>

Inherited Members

ValueType.ToString()

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

NavigationAgentProfile(KinematicBodyShape, Fixed64, Fixed64, Fixed64, TraversalMedia, TraversalCapability)

Creates an immutable navigation agent profile.

public NavigationAgentProfile(KinematicBodyShape shape, Fixed64 maxStepUp, Fixed64 maxDropDown, Fixed64 arrivalRadius, TraversalMedia allowedMedia, TraversalCapability capabilities)

Parameters

shape KinematicBodyShape

maxStepUp Fixed64

maxDropDown Fixed64

arrivalRadius Fixed64

allowedMedia TraversalMedia

capabilities TraversalCapability

Exceptions

ArgumentException

Thrown when the body shape is invalid.

ArgumentOutOfRangeException

Thrown when a distance is negative or flags contain unknown bits.

Properties

AllowedMedia

Gets the traversal media this agent may enter.

public TraversalMedia AllowedMedia { get; }

Property Value

TraversalMedia

ArrivalRadius

Gets the non-negative distance at which the agent is considered to have arrived.

public Fixed64 ArrivalRadius { get; }

Property Value

Fixed64

Capabilities

Gets the additional traversal abilities available to the agent.

public TraversalCapability Capabilities { get; }

Property Value

TraversalCapability

MaxDropDown

Gets the maximum downward surface drop allowed in world units.

public Fixed64 MaxDropDown { get; }

Property Value

Fixed64

MaxStepUp

Gets the maximum upward surface step allowed in world units.

public Fixed64 MaxStepUp { get; }

Property Value

Fixed64

Shape

Gets the authoritative body geometry for the agent.

public KinematicBodyShape Shape { get; }

Property Value

KinematicBodyShape

Methods

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

Equals(NavigationAgentProfile)

public bool Equals(NavigationAgentProfile other)

Parameters

other NavigationAgentProfile

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

Operators

operator ==(NavigationAgentProfile, NavigationAgentProfile)

Returns whether two profiles have exactly equal values.

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

Parameters

left NavigationAgentProfile

right NavigationAgentProfile

Returns

bool

operator !=(NavigationAgentProfile, NavigationAgentProfile)

Returns whether two profiles differ.

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

Parameters

left NavigationAgentProfile

right NavigationAgentProfile

Returns

bool