Class Seeker Extends VersionedMonoBehaviour

bool detailedGizmos

Enables drawing of the non-postprocessed path using Gizmos.

The path will show up in orange.

Requires that drawGizmos is true.

This will show the path before any post processing such as smoothing is applied.

bool drawGizmos = true

Enables drawing of the last calculated path using Gizmos.

The path will show up in green.

GraphMask graphMask = GraphMask.everything

Graphs that this Seeker can use.

This field determines which graphs will be considered when searching for the start and end nodes of a path. It is useful in numerous situations, for example if you want to make one graph for small units and one graph for large units.

This is a bitmask so if you for example want to make the agent only use graph index 3 then you can set this to: seeker.graphMask = 1 << 3;


Note that this field only stores which graph indices that are allowed. This means that if the graphs change their ordering then this mask may no longer be correct.

If you know the name of the graph you can use the Pathfinding.GraphMask.FromGraphName method: GraphMask mask1 = GraphMask.FromGraphName("My Grid Graph");
GraphMask mask2 = GraphMask.FromGraphName("My Other Grid Graph");

NNConstraint nn = NNConstraint.Walkable;

nn.graphMask = mask1 | mask2;

// Find the node closest to somePoint which is either in 'My Grid Graph' OR in 'My Other Grid Graph'
var info = AstarPath.active.GetNearest(somePoint, nn);
Some overloads of the StartPath methods take a graphMask parameter. If those overloads are used then they will override the graph mask for that path request.

OnPathDelegate postProcessPath

Called after a path has been calculated, right before modifiers are executed.

OnPathDelegate preProcessPath

Called before pathfinding is started.

StartEndModifier startEndModifier = new StartEndModifier()

Path modifier which tweaks the start and end points of a path.

int[] tagPenalties = new int[32]

Penalties for each tag.

Tag 0 which is the default tag, will have added a penalty of tagPenalties[0]. These should only be positive values since the A* algorithm cannot handle negative penalties.

The length of this array should be exactly 32, one for each tag.

int traversableTags = -1

The tags which the Seeker can traverse.

ITraversalProvider traversalProvider

Custom traversal provider to calculate which nodes are traversable and their penalties.

This can be used to override the built-in pathfinding logic.

seeker.traversalProvider = new MyCustomTraversalProvider();


ModifierPass

int graphMaskCompatibility = -1

Used for serialization backwards compatibility.

List<GraphNode> lastCompletedNodePath

Used for drawing gizmos.

List<Vector3> lastCompletedVectorPath

Used for drawing gizmos.

uint lastPathID

The path ID of the last path queried.

List<IPathModifier> modifiers = new List<IPathModifier>()

Internal list of all modifiers.

OnPathDelegate onPartialPathDelegate

Cached delegate to avoid allocating one every time a path is started.

OnPathDelegate onPathDelegate

Cached delegate to avoid allocating one every time a path is started.

Path path

The current path.

Path prevPath

Previous path.

Used to draw gizmos

OnPathDelegate tmpPathCallback

Temporary callback only called for the current path.

This value is set by the StartPath functions

OnPathDelegate pathCallback

Callback for when a path is completed.

Movement scripts should register to this delegate.
A temporary callback can also be set when calling StartPath, but that delegate will only be called for that path

public void Start () {
// Assumes a Seeker component is attached to the GameObject
Seeker seeker = GetComponent<Seeker>();

// seeker.pathCallback is a OnPathDelegate, we add the function OnPathComplete to it so it will be called whenever a path has finished calculating on that seeker
seeker.pathCallback += OnPathComplete;
}

public void OnPathComplete (Path p) {
Debug.Log("This is called when a path is completed on the seeker attached to this GameObject");
}