A* Pathfinding Project
4.3.5
The A* Pathfinding Project for Unity 3D
|
Floods the area completely for easy computation of any path to a single point. More...
Floods the area completely for easy computation of any path to a single point.
This path is a bit special, because it does not do anything useful by itself. What it does is that it calculates paths to all nodes it can reach, it floods the graph. This data will remain stored in the path. Then you can call a FloodPathTracer path, that path will trace the path from it's starting point all the way to where this path started flooding and thus generating a path extremely quickly.
It is very useful in for example TD (Tower Defence) games where all your AIs will walk to the same point, but from different places, and you do not update the graph or change the target point very often, what changes is their positions and new AIs spawn all the time (which makes it hard to use the MultiTargetPath).
With this path type, it can all be handled easily.
Here follows some example code of the above list of steps:
When searching for a new path to someTargetPosition from let's say transform.position, you do
Where OnPathComplete is your callback function.
Another thing to note is that if you are using NNConstraints on the FloodPathTracer, they must always inherit from Pathfinding.PathIDConstraint.
The easiest is to just modify the instance of PathIDConstraint which is created as the default one.
Public Member Functions | |
FloodPath () | |
Default constructor. More... | |
GraphNode | GetParent (GraphNode node) |
bool | HasPathTo (GraphNode node) |
![]() | |
void | BlockUntilCalculated () |
Blocks until this path has been calculated and returned. More... | |
void | Claim (System.Object o) |
Claim this path (pooling). More... | |
void | Error () |
Aborts the path because of an error. More... | |
PathState | GetState () |
Returns the state of the path in the pathfinding pipeline. More... | |
uint | GetTagPenalty (int tag) |
Returns penalty for the given tag. More... | |
float | GetTotalLength () |
Total Length of the path. More... | |
bool | IsDone () |
Returns if this path is done calculating. More... | |
void | Release (System.Object o, bool silent=false) |
Releases a path claim (pooling). More... | |
IEnumerator | WaitForPath () |
Waits until this path has been calculated and returned. More... | |
Static Public Member Functions | |
static FloodPath | Construct (Vector3 start, OnPathDelegate callback=null) |
static FloodPath | Construct (GraphNode start, OnPathDelegate callback=null) |
Public Attributes | |
Vector3 | originalStartPoint |
bool | saveParents = true |
If false, will not save any information. More... | |
GraphNode | startNode |
Vector3 | startPoint |
![]() | |
OnPathDelegate | callback |
Callback to call when the path is complete. More... | |
float | duration |
How long it took to calculate this path in milliseconds. More... | |
int | enabledTags = -1 |
Which graph tags are traversable. More... | |
Heuristic | heuristic |
Determines which heuristic to use. More... | |
float | heuristicScale = 1F |
Scale of the heuristic values. More... | |
OnPathDelegate | immediateCallback |
Immediate callback to call when the path is complete. More... | |
NNConstraint | nnConstraint = PathNNConstraint.Default |
Constraint for how to search for nodes. More... | |
List< GraphNode > | path |
Holds the path as a Node array. More... | |
ITraversalProvider | traversalProvider |
Provides additional traversal information to a path request. More... | |
List< Vector3 > | vectorPath |
Holds the (possibly post processed) path as a Vector3 list. More... | |
Protected Member Functions | |
override void | CalculateStep (long targetTick) |
Opens nodes until there are none left to search (or until the max time limit has been exceeded) More... | |
override void | Initialize () |
Initializes the path. More... | |
override void | Prepare () |
Called before the path is started. More... | |
override void | Reset () |
Reset all values to their default values. More... | |
void | Setup (Vector3 start, OnPathDelegate callback) |
void | Setup (GraphNode start, OnPathDelegate callback) |
![]() | |
virtual void | Cleanup () |
Always called after the path has been calculated. More... | |
void | DebugStringPrefix (PathLog logMode, System.Text.StringBuilder text) |
Writes text shared for all overrides of DebugString to the string builder. More... | |
void | DebugStringSuffix (PathLog logMode, System.Text.StringBuilder text) |
Writes text shared for all overrides of DebugString to the string builder. More... | |
virtual void | OnEnterPool () |
Called when the path enters the pool. More... | |
void | PrepareBase (PathHandler pathHandler) |
Prepares low level path variables for calculation. More... | |
virtual void | ReturnPath () |
Calls callback to return the calculated path. More... | |
virtual void | Trace (PathNode from) |
Traces the calculated path from the end node to the start. More... | |
Protected Attributes | |
Dictionary< GraphNode, GraphNode > | parents |
![]() | |
PathCompleteState | completeState |
Backing field for CompleteState. More... | |
PathNode | currentR |
The node currently being processed. More... | |
bool | hasBeenReset |
True if the Reset function has been called. More... | |
Int3 | hTarget |
Target to use for H score calculations. More... | |
GraphNode | hTargetNode |
Target to use for H score calculation. More... | |
int [] | internalTagPenalties |
The tag penalties that are actually used. More... | |
int [] | manualTagPenalties |
Tag penalties set by other scripts. More... | |
PathHandler | pathHandler |
Data for the thread calculating this path. More... | |
Properties | |
override bool | FloodingPath [get] |
![]() | |
PathCompleteState | CompleteState [get, protected set] |
Current state of the path. More... | |
bool | error [get] |
If the path failed, this is true. More... | |
string | errorLog [get, private set] |
Additional info on why a path failed. More... | |
virtual bool | FloodingPath [get] |
True for paths that want to search all nodes and not jump over nodes as optimizations. More... | |
PathHandler IPathInternals. | PathHandler [get] |
ushort | pathID [get, private set] |
ID of this path. More... | |
PathState | PipelineState [get, private set] |
Returns the state of the path in the pathfinding pipeline. More... | |
bool IPathInternals. | Pooled [get, set] |
True if the path is currently pooled. More... | |
bool | recycled [get] |
True if the path is currently recycled (i.e in the path pool). More... | |
int [] | tagPenalties [get, set] |
Penalties for each tag. More... | |
![]() | |
PathHandler | PathHandler [get] |
bool | Pooled [get, set] |
Additional Inherited Members | |
![]() | |
uint | CalculateHScore (GraphNode node) |
Estimated cost from the specified node to the target. More... | |
bool | CanTraverse (GraphNode node) |
Returns if the node can be traversed. More... | |
virtual string | DebugString (PathLog logMode) |
Returns a string with information about it. More... | |
void | FailWithError (string msg) |
Causes the path to fail and sets errorLog to msg. More... | |
virtual uint | GetConnectionSpecialCost (GraphNode a, GraphNode b, uint currentCost) |
May be called by graph nodes to get a special cost for some connections. More... | |
Int3 | GetHTarget () |
uint | GetTraversalCost (GraphNode node) |
void | Log (string msg) |
Appends a message to the errorLog. More... | |
void | LogError (string msg) |
Logs an error. More... | |
void | ReleaseSilent (System.Object o) |
Releases the path silently (pooling). More... | |
![]() | |
Path | next |
Internal linked list implementation. More... | |
int | searchedNodes |
Number of nodes this path has searched. More... | |
FloodPath | ( | ) |
Default constructor.
Do not use this. Instead use the static Construct method which can handle path pooling.
|
protectedvirtual |
Opens nodes until there are none left to search (or until the max time limit has been exceeded)
Implements Path.
|
static |
|
static |
bool HasPathTo | ( | GraphNode | node | ) |
|
protectedvirtual |
|
protectedvirtual |
|
protectedvirtual |
Reset all values to their default values.
Reimplemented from Path.
|
protected |
|
protected |
Vector3 originalStartPoint |
bool saveParents = true |
If false, will not save any information.
Used by some internal parts of the system which doesn't need it.
GraphNode startNode |
Vector3 startPoint |
|
getpackage |