Class Path Extends IPathInternals

Public Abstract

Base class for all path types.

Inner Types

Temporary data for a single path used during the pathfinding process.

Public Methods

Blocks until this path has been calculated and returned.

Claim (o)

Increase the reference count on this path by 1 (for pooling).

Error ()

Aborts the path because of an error.

Causes the path to fail and sets errorLog to msg.

Total Length of the path.

IsDone ()

True if this path is done calculating.

OnVisitNode (ctx, pathNode, hScore, gScore)

Called for every node that the path visits.

Release (o, silent=…)

Reduces the reference count on the path by 1 (pooling).

UseSettings (settings)

Copies the given settings into this path.

Waits until this path has been calculated and returned.

Public Variables

CompleteState

Current state of the path.

Public
PipelineState

Returns the state of the path in the pathfinding pipeline.

Public
callback

Callback to call when the path is complete.

Public
duration

How long it took to calculate this path in milliseconds.

Public
error

If the path failed, this is true.

Public
errorLog

Additional info on why a path failed.

Public
heuristic

Determines which heuristic to use.

Public
heuristicScale

Scale of the heuristic values.

Public
immediateCallback

Immediate callback to call when the path is complete.

Public
nearestNodeConstraint

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

Public
nearestNodeDistanceMetric

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

Public
path

Holds the path as a GraphNode list.

Public
pathID

ID of this path.

Public
searchedNodes

Number of nodes this path has searched.

Public
traversalConstraint

Constrains which nodes the path can traverse.

Public
traversalCosts

Specifies the cost of traversing different nodes.

Public
vectorPath

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

Public

Public Static Variables

MarkerOpenCandidateConnectionsToEnd
Public Static Readonly
MarkerTrace
Public Static Readonly

Private/Protected Members

Threadsafe increment of the state.

CalculateStep (ctx, targetTick)

Checks the traversal provider for compatibility with the current version of the A* Pathfinding Project.

Cleanup (ctx)

DebugString (builder, logMode)

DebugStringPrefix (logMode, text)

Writes text shared for all overrides of DebugString to the string builder.

DebugStringSuffix (logMode, text)

Writes text shared for all overrides of DebugString to the string builder.

Performs some error checking.

OnFoundEndNode (ctx, pathNode, hScore, gScore)

Called when a valid node has been found for the end of the path.

Called when there are no more nodes to search.

Pooled

True if the path is currently pooled.

Private
Prepare (ctx)

...

PrepareBase (...)

Reset ()

...

Trace (ctx, fromPathNodeIndex, [reverse])

checkedTraversalProviders
Private Static
claimed

List of claims on this path with reference objects.

Private
completeState

Backing field for CompleteState.

Protected
hasBeenReset

True if the Reset function has been called.

Protected
releasedNotSilent

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

Private

Deprecated Members

CanTraverse (...)

Returns if the...

Returns penalty for the given tag.

Returns the cost of traversing the given node.

enabledTags

Which graph tags are traversable.

Public
nnConstraint

Constraint for how to search for nodes.

Public
tagPenalties

Penalties for each tag.

Public
traversalProvider

Provides additional traversal information to a path request.

Public