Class FloodPathConstraint Extends NNConstraint

FloodPathConstraint (

FloodPath

path

)

bool Suitable (

GraphNode

node

)

Returns whether or not the node conforms to this NNConstraint's rules.

NNConstraint Default

The default NNConstraint.

Equivalent to new NNConstraint (). This NNConstraint has settings which works for most, it only finds walkable nodes and it constrains distance set by A* Inspector -> Settings -> Max Nearest Node Distance

NNConstraint None

Returns a constraint which does not filter the results.

bool SuitableGraph (

int	graphIndex
NavGraph	graph

)

Returns whether or not the graph conforms to this NNConstraint's rules.

Note that only the first 31 graphs are considered using this function. If the graphMask has bit 31 set (i.e the last graph possible to fit in the mask), all graphs above index 31 will also be considered suitable.

int area = -1

Area ID to constrain to.

Will not affect anything if less than 0 (zero) or if constrainArea is false

bool constrainArea

Only treat nodes in the area area as suitable.

Does not affect anything if area is less than 0 (zero)

bool constrainDistance = true

Constrain distance to node.

Uses distance from AstarPath.maxNearestNodeDistance. If this is false, it will completely ignore the distance limit.

If there are no suitable nodes within the distance limit then the search will terminate with a null node as a result.

bool constrainTags = true

Sets if tags should be constrained.

bool constrainWalkability = true

Constrain the search to only walkable or unwalkable nodes depending on walkable.

bool distanceXZ

if available, do an XZ check instead of checking on all axes.

The navmesh/recast graph supports this.

This can be important on sloped surfaces. See the image below in which the closest point for each blue point is queried for:

The navmesh/recast graphs also contain a global option for this: nearestSearchOnlyXZ.

GraphMask graphMask = -1

Graphs treated as valid to search on.

This is a bitmask meaning that bit 0 specifies whether or not the first graph in the graphs list should be able to be included in the search, bit 1 specifies whether or not the second graph should be included and so on. // Enables the first and third graphs to be included, but not the rest
myNNConstraint.graphMask = (1 << 0) | (1 << 2);
GraphMask mask1 = GraphMask.FromGraphName("My Grid Graph");
GraphMask mask2 = GraphMask.FromGraphName("My Other Grid Graph");

NNConstraint nn = NNConstraint.Default;

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);


int tags = -1

Nodes which have any of these tags set are suitable.

This is a bitmask, i.e bit 0 indicates that tag 0 is good, bit 3 indicates tag 3 is good etc.

bool walkable = true

Only search for walkable or unwalkable nodes if constrainWalkability is enabled.

If true, only walkable nodes will be searched for, otherwise only unwalkable nodes will be searched for. Does not affect anything if constrainWalkability if false.

FloodPath path