Class ConstantPath Extends Path

Public

Finds all nodes within a specified distance from the start.

This class will search outwards from the start point and find all nodes which it costs less than EndingConditionDistance.maxGScore to reach, this is usually the same as the distance to them multiplied with 1000.

The path can be called like: // Here you create a new path and set how far it should search.
ConstantPath cpath = ConstantPath.Construct(transform.position, 20000, null);
AstarPath.StartPath(cpath);

// Block until the path has been calculated. You can also calculate it asynchronously
// by providing a callback in the constructor above.
cpath.BlockUntilCalculated();

// Draw a line upwards from all nodes within range
for (int i = 0; i < cpath.allNodes.Count; i++) {
Debug.DrawRay((Vector3)cpath.allNodes[i].position, Vector3.up, Color.red, 2f);
}
When the path has been calculated, all nodes it searched will be stored in the variable ConstantPath.allNodes (remember that you need to cast it from Path to ConstantPath first to get the variable).

This list will be sorted by the cost to reach that node (more specifically the G score if you are familiar with the terminology for search algorithms).

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

OnVisitNode (ctx, pathNode, hScore, gScore)

Called for every node that the path visits.

Public Static Methods

Construct (start, maxGScore, callback=null)

Constructs a ConstantPath starting from the specified point.

Public Variables

allNodes

Contains all nodes the path found.

Public
endingCondition

Determines when the path calculation should stop.

Public
originalStartPoint
Public
startNode
Public
startPoint
Public

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

MarkerOpenCandidateConnectionsToEnd
Public Static Readonly
MarkerTrace
Public Static Readonly
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.

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

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 string with information about it.

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.

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)

Called before the path is started.

PrepareBase (pathHandler)

Prepares low level path variables for calculation.

Reset ()

Reset the path to default values.

Calls callback to return the calculated path.

Setup (start, maxGScore, callback)

Sets up a ConstantPath starting from the specified point.

Trace (ctx, fromPathNodeIndex, [reverse])

completeState

Backing field for CompleteState.

Protected
hasBeenReset

True if the Reset function has been called.

Protected