Class XPath Extends ABPath

Public

Extended Path.

This is the same as a standard path but it is possible to customize when the target should be considered reached. Can be used to for example signal a path as complete when it is within a specific distance from the target.

Note

More customizations does make it slower to calculate than an ABPath but not by very much.

A* Pro Feature

This is an A* Pathfinding Project Pro feature only. This function/class/variable might not exist in the Free version of the A* Pathfinding Project or the functionality might be limited.
The Pro version can be bought here

Deprecated

Use an ABPath with the ABPath.endingCondition field instead.

Inherited Public Members

Blocks until this path has been calculated and returned.

Claim (o)

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

CompleteState

Current state of the path.

Public
Construct (start, end, [callback])

Construct a path with a start and end point.

Error ()

Aborts the path because of an error.

Causes the path to fail and sets errorLog to msg.

FakePath (vectorPath, nodePath=null)

Creates a fake path.

Total Length of the path.

IsDone ()

True if this path is done calculating.

MarkerOpenCandidateConnectionsToEnd
Public Static Readonly
MarkerTrace
Public Static Readonly
OnVisitNode (ctx, pathNode, hScore, gScore)

Called for every node that the path visits.

PipelineState

Returns the state of the path in the pathfinding pipeline.

Public
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.

calculatePartial

Calculate partial path if the target node cannot be reached.

Public
callback

Callback to call when the path is complete.

Public
cost

Total cost of this path as used by the pathfinding algorithm.

Public
duration

How long it took to calculate this path in milliseconds.

Public
endNode

End node of the path.

Public
endPoint

End point of the path.

Public
endPointKnownBeforeCalculation

True if this path type has a well defined end point, even before calculation starts.

Public
endingCondition

Optional ending condition for the path.

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
originalEndPoint

End Point exactly as in the path request.

Public
originalStartPoint

Start Point exactly as in the path request.

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
startNode

Start node of the path.

Public
startPoint

Start point of the path.

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

Private/Protected Members

CalculateStep (ctx, targetTick)

Calculates the path until completed or until the time has passed targetTick.

Cleanup (ctx)

Always called after the path has been calculated.

DebugString (builder, logMode)

Returns a debug string for this path.

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.

EndPointGridGraphSpecialCase (ctx, closestWalkableEndNode, originalEndPoint, targetIndex)

Applies a special case for grid nodes.

FindStartAndEndNodes (ctx, constraint)

Called when the path enters the pool.

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.

Prepare (ctx)

Prepares the path.

PrepareBase (pathHandler)

Prepares low level path variables for calculation.

Reset ()

Reset all values to their default values.

Calls callback to return the calculated path.

Setup (start, end, callbackDelegate)
Trace (ctx, fromPathNodeIndex, [reverse])

UpdateStartEnd (start, end)

Sets the start and end points.

completeState

Backing field for CompleteState.

Protected
hasBeenReset

True if the Reset function has been called.

Protected
hasEndPoint

Determines if a search for an end node should be done.

Protected
partialBestTargetGScore
Protected
partialBestTargetHScore
Protected
partialBestTargetPathNodeIndex

Current best target for the partial path.

Protected