Class Path Extends IPathInternals

PathCompleteState CompleteState

Current state of the path.

PathState PipelineState

Returns the state of the path in the pathfinding pipeline.

OnPathDelegate callback

Callback to call when the path is complete.

This is usually sent to the Seeker component which post processes the path and then calls a callback to the script which requested the path

float duration

How long it took to calculate this path in milliseconds.

bool error

If the path failed, this is true.

This typically happens if there's no valid node close enough to the start point of the path, or if there's no node close enough to the target point that is reachable from the start point. The errorLog will have more information about what happened.

string errorLog

Additional info on why a path failed.

Heuristic heuristic

Determines which heuristic to use.

float heuristicScale = 1F

Scale of the heuristic values.

OnPathDelegate immediateCallback

Immediate callback to call when the path is complete.

NearestNodeConstraint nearestNodeConstraint

Constraint for how to search for nodes that are traversable by this path.

This constraint is what the path uses to search for closest nodes to the start and end points.

This is derived from the traversalConstraint and the nearestNodeDistanceMetric.

DistanceMetric nearestNodeDistanceMetric

Distance metric to use when searching for the start and end nodes in the graph.

By default, the euclidean distance metric is used. This allows the path to, for example, find the closest start node to the start point, as measured using "normal" distance. However, you can change this to instead measure distance by ignoring the Y coordinate. This is quite useful for characters, as it will find the node right below the agents feet, even if the agent is slightly above the ground on a slope.

List<GraphNode> path

Holds the path as a GraphNode list.

These are all nodes that the path traversed, as calculated by the pathfinding algorithm. This may not be the same nodes as the post processed path traverses.

ushort pathID

ID of this path.

Used to distinguish between different paths

int searchedNodes

Number of nodes this path has searched.

TraversalConstraint traversalConstraint = TraversalConstraint.None

Constrains which nodes the path can traverse.

By default, all walkable nodes are traversable. But you can modify this to, for example, only allow nodes with a certain tag to be traversed, or supply completely custom rules by using an ITraversalProvider.

TraversalCosts traversalCosts

Specifies the cost of traversing different nodes.

By default, nodes have no special costs associated with them. But you can modify this to, for example, make nodes with a certain tag more expensive to traverse, or supply completely custom rules by using an ITraversalProvider.

List<Vector3> vectorPath

Holds the (possibly post-processed) path as a Vector3 list.

This list may be modified by path modifiers to be smoother or simpler compared to the raw path generated by the pathfinding algorithm.

Unity.Profiling.ProfilerMarker MarkerOpenCandidateConnectionsToEnd = new Unity.Profiling.ProfilerMarker("OpenCandidateConnectionsToEnd")

Unity.Profiling.ProfilerMarker MarkerTrace = new Unity.Profiling.ProfilerMarker("Trace")

bool Pooled

True if the path is currently pooled.

Do not set this value. Only read. It is used internally.

HashSet<System.Type> checkedTraversalProviders = new HashSet<System.Type>()

int claimCount = 0

System.Object[] claimed = new System.Object[2]

List of claims on this path with reference objects.

We use an array instead of List<T> to avoid an indirection and reduce memory usage a bit (actually has a measureable impact).

PathCompleteState completeState

Backing field for CompleteState.

bool hasBeenReset

True if the Reset function has been called.

Used to alert users when they are doing something wrong.

bool releasedNotSilent

True if the path has been released with a non-silent call yet.

int enabledTags

Which graph tags are traversable.

This is a bitmask so -1 = all bits set = all tags traversable. For example, to set bit 5 to true, you would do myPath.enabledTags |= 1 << 5;
To set it to false, you would do myPath.enabledTags &= ~(1 << 5);


The Seeker has a popup field where you can set which tags to use.

NNConstraintPathProxy nnConstraint

Constraint for how to search for nodes.

uint[] tagPenalties

Penalties for each tag.

Tag 0 which is the default tag, will get a penalty of tagPenalties[0]. These should only be non-negative values since the A* algorithm cannot handle negative penalties.

When assigning an array to this property it must have a length of 32.

ITraversalProvider traversalProvider

Provides additional traversal information to a path request.