A* Pathfinding Project  3.6
The A* Pathfinding Project for Unity 3D
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties Events Macros Groups Pages
Public Member Functions | Properties | List of all members
PathNNConstraint Class Reference

A special NNConstraint which can use different logic for the start node and end node in a path. More...

Detailed Description

A special NNConstraint which can use different logic for the start node and end node in a path.

A PathNNConstraint can be assigned to the Path.nnConstraint field, the path will first search for the start node, then it will call SetStart and proceed with searching for the end node (nodes in the case of a MultiTargetPath).
The default PathNNConstraint will constrain the end point to lie inside the same area as the start point.

Public Member Functions

virtual void SetStart (GraphNode node)
 Called after the start node has been found.
 
- Public Member Functions inherited from NNConstraint
 NNConstraint ()
 Default constructor.
 
virtual bool Suitable (GraphNode node)
 Returns whether or not the node conforms to this NNConstraint's rules.
 
virtual bool SuitableGraph (int graphIndex, NavGraph graph)
 Returns whether or not the graph conforms to this NNConstraint's rules.
 

Properties

static new PathNNConstraint Default [get]
 
- Properties inherited from NNConstraint
static NNConstraint Default [get]
 The default NNConstraint.
 
static NNConstraint None [get]
 Returns a constraint which will not filter the results.
 

Additional Inherited Members

- Public Attributes inherited from NNConstraint
int area = -1
 Area ID to constrain to.
 
bool constrainArea = false
 Only treat nodes in the area area as suitable.
 
bool constrainDistance = true
 Constrain distance to node.
 
bool constrainTags = true
 Sets if tags should be constrained.
 
bool constrainWalkability = true
 Only treat nodes with the walkable flag set to the same as walkable as suitable.
 
bool distanceXZ = false
 if available, do an XZ check instead of checking on all axes.
 
int graphMask = -1
 Graphs treated as valid to search on.
 
int tags = -1
 Nodes which have any of these tags set are suitable.
 
bool walkable = true
 What must the walkable flag on a node be for it to be suitable.
 

Member Function Documentation

virtual void SetStart ( GraphNode  node)
virtual

Called after the start node has been found.

This is used to get different search logic for the start and end nodes in a path

Property Documentation

new PathNNConstraint Default
staticget
The documentation for this class was generated from the following file: