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

Public Methods

XPath ()
Public

Public Static Methods

Construct (start, end, callback=null)
Public Static

Public Variables

endingCondition

Ending Condition for the path.

Public

Inherited Public Members

BlockUntilCalculated ()

Blocks until this path has been calculated and returned.

Public
CanTraverse (node)

Returns if the node can be traversed.

Public
Claim (o)

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

Public
CompleteState

Current state of the path.

Public
Construct (start, end, callback=null)

Construct a path with a start and end point.

Public Static
Error ()

Aborts the path because of an error.

Public
FailWithError (msg)

Causes the path to fail and sets errorLog to msg.

Public
FakePath (vectorPath, nodePath=null)

Creates a fake path.

Public Static
FloodingPath

True for paths that want to search all nodes and not jump over nodes as optimizations.

Public
GetConnectionSpecialCost (a, b, currentCost)

May be called by graph nodes to get a special cost for some connections.

Public
GetTagPenalty (tag)

Returns penalty for the given tag.

Public
GetTotalLength ()

Total Length of the path.

Public
GetTraversalCost (node)

Returns the cost of traversing the given node.

Public
IsDone ()

True if this path is done calculating.

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

Public
WaitForPath ()

Waits until this path has been calculated and returned.

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

Which graph tags are traversable.

Public
endNode

End node of the path.

Public
endPoint

End point of 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
nnConstraint

Constraint for how to search for nodes.

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
startIntPoint

Start point in integer coordinates.

Public
startNode

Start node of the path.

Public
startPoint

Start point of the path.

Public
tagPenalties

Penalties for each tag.

Public
traversalProvider

Provides additional traversal information to a path request.

Public
vectorPath

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

Public

Private/Protected Members

CalculateHScore (node)

Estimated cost from the specified node to the target.

Internal
CalculateStep (targetTick)

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

Protected
ChangeEndNode (target)

Changes the endNode to target and resets some temporary flags on the previous node.

Private
Cleanup ()

Always called after the path has been calculated.

Protected
CompletePathIfStartIsValidTarget ()

The start node need to be special cased and checked here if it is a valid target.

Protected
DebugString (logMode)

Returns a debug string for this path.

Protected
DebugStringPrefix (logMode, text)

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

Protected
DebugStringSuffix (logMode, text)

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

Protected
EndPointGridGraphSpecialCase (closestWalkableEndNode)

Applies a special case for grid nodes.

Protected
GetHTarget ()
Protected
Initialize ()

Initializes the path.

Protected
OnEnterPool ()

Called when the path enters the pool.

Protected
Prepare ()

Prepares the path.

Protected
PrepareBase (pathHandler)

Prepares low level path variables for calculation.

Protected
Reset ()

Reset all values to their default values.

Protected
ReturnPath ()

Calls callback to return the calculated path.

Protected
Setup (start, end, callbackDelegate)
Protected
Trace (from)

Traces the calculated path from the end node to the start.

Protected
UpdateStartEnd (start, end)

Sets the start and end points.

Protected
completeState

Backing field for CompleteState.

Protected
currentR

The node currently being processed.

Protected
endNodeCosts

Saved original costs for the end node.

Protected
hTarget

Target to use for H score calculations.

Protected
hTargetNode

Target to use for H score calculation.

Protected
hasBeenReset

True if the Reset function has been called.

Protected
hasEndPoint

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

Protected
internalTagPenalties

The tag penalties that are actually used.

Protected
manualTagPenalties

Tag penalties set by other scripts.

Protected
next

Internal linked list implementation.

Internal
partialBestTarget

Current best target for the partial path.

Protected
pathHandler

Data for the thread calculating this path.

Protected