PathEndingCondition Class Reference

Customized ending condition for a path. More...

Inheritance diagram for PathEndingCondition:

Collaboration diagram for PathEndingCondition:

Public Member Functions
	PathEndingCondition (Path p)
virtual bool	TargetFound (NodeRun node)
	Has the ending condition been fulfilled.

Protected Attributes
Path	p

Detailed Description

Customized ending condition for a path.

This class can be used to implement a custom ending condition for e.g an Pathfinding::XPath.
Inherit from this class and override the TargetFound function to implement you own ending condition logic.

For example, you might want to create an Ending Condition which stops when a node is close enough to a given point.
Then what you do is that you create your own class, let's call it EndingConditionProximity and override the function TargetFound to specify our own logic.

public class EndingConditionProximity : Pathfinding.PathEndingCondition {
    
    //The maximum distance to the target node before terminating the path
    public float maxDistance = 10;
    
    public override bool TargetFound (Path p, Node node) {
        return ((Vector3)node.position - p.originalEndPoint).sqrMagnitude <= maxDistance*maxDistance;
    }
}

One part at a time. We need to cast the node's position to a Vector3 since internally, it is stored as an integer coordinate (Int3). Then we subtract the Pathfinding::Path::originalEndPoint from it to get their difference. The original end point is always the exact point specified when calling the path. As a last step we check the squared magnitude (squared distance, it is much faster than the non-squared distance) and check if it is lower or equal to our maxDistance squared.
There you have it, it is as simple as that. Then you simply assign it to the endingCondition variable on, for example an XPath which uses the EndingCondition.

EndingConditionProximity ec = new EndingConditionProximity ();
ec.maxDistance = 100; //Or some other value
myXPath.endingCondition = ec;

//Call the path!
mySeeker.StartPath (ec);

Where mySeeker is a Seeker component, and myXPath is an Pathfinding::XPath.

Note

The above was written without testing. I hope I haven't made any mistakes, if you try it out, and it doesn't seem to work. Please post a comment below.

Written for 3.0.8.3

Version

Method structure changed in 3.2

See Also

Pathfinding::XPath

Pathfinding::ConstantPath

Member Function Documentation

virtual bool TargetFound ( NodeRun  node )

virtual

Has the ending condition been fulfilled.

Parameters

node	The current node. This is per default the same as asking if node == p.endNode

Reimplemented in EndingConditionDistance, and ABPathEndingCondition.

Here is the caller graph for this function:

---

The documentation for this class was generated from the following file:

• /Users/aron/Unity/AstarPathfindingGIT/Assets/AstarPathfindingProject/Pathfinders/XPath.cs