Function AstarPath.GetNearest

GraphNode GetNearest (

Ray

ray

)

Returns the node closest to the ray (slow).

NNInfo GetNearest (

Vector3

position

)

Returns the nearest node to a position.

This method will search through all graphs and query them for the closest node (walkable or unwalkable) to this position.

Equivalent to GetNearest(position, NearestNodeConstraint.None).

// Find the closest node to this GameObject's position
GraphNode node = AstarPath.active.GetNearest(transform.position).node;

if (node.Walkable) {
// Yay, the node is walkable, we can place a tower here or something
}


NNInfo GetNearest (

Vector3	position	The point to find nodes close to
NearestNodeConstraint	constraint	The constraint which determines which graphs and nodes are acceptable to search on.

)

Returns the nearest node to a point using the specified NearestNodeConstraint.

Searches through all graphs for their nearest nodes to the specified position and picks the closest one. The NearestNodeConstraint can be used to specify constraints on which nodes can be chosen such as only picking walkable nodes.

GraphNode node = AstarPath.active.GetNearest(transform.position, NearestNodeConstraint.Walkable).node;
var constraint = NearestNodeConstraint.None;

// Constrain the search to walkable nodes only
constraint.walkable = NearestNodeConstraint.WalkabilityConstraint.Walkable;

// Constrain the search to only nodes with tag 3 or tag 5
// The 'tags' field is a bitmask
constraint.tags = (1 << 3) | (1 << 5);

var info = AstarPath.active.GetNearest(transform.position, constraint);
var node = info.node;
var closestPoint = info.position;


NNInfo GetNearest (

Vector3	position
refNearestNodeConstraint	constraint

)

NNInfo GetNearest (

Vector3	position	The point to find nodes close to
NNConstraint	constraint	The constraint which determines which graphs and nodes are acceptable to search on. May be null, in which case all nodes will be considered acceptable.

)

Returns the nearest node to a point using the specified NNConstraint.

Searches through all graphs for their nearest nodes to the specified position and picks the closest one. The NNConstraint can be used to specify constraints on which nodes can be chosen such as only picking walkable nodes.

GraphNode node = AstarPath.active.GetNearest(transform.position, NearestNodeConstraint.Walkable).node;
var constraint = NearestNodeConstraint.None;

// Constrain the search to walkable nodes only
constraint.walkable = NearestNodeConstraint.WalkabilityConstraint.Walkable;

// Constrain the search to only nodes with tag 3 or tag 5
// The 'tags' field is a bitmask
constraint.tags = (1 << 3) | (1 << 5);

var info = AstarPath.active.GetNearest(transform.position, constraint);
var node = info.node;
var closestPoint = info.position;