Class GridNode Extends GridNodeBase

void ClearConnections (

bool

alsoReverse

if true, neighbours will be requested to remove connections to this node.

)

Remove all connections from this node.

Vector3 ClosestPointOnNode (

Vector3

p

)

void DeserializeNode (

GraphSerializationContext

ctx

)

Deserializes the node data from a byte array.

int GetAllConnectionInternal ()

Bitpacked int containing all 8 grid connections.

bool GetConnectionInternal (

int

dir

)

True if the node has a connection in the specified direction.

void GetConnections (

System.Action<GraphNode>

action

)

Calls the delegate with all connections from this node.

node.GetConnections(connectedTo => {
Debug.DrawLine((Vector3)node.position, (Vector3)connectedTo.position, Color.red);
});
You can add all connected nodes to a list like this var connections = new List<GraphNode>();
node.GetConnections(connections.Add);


GridNodeBase GetNeighbourAlongDirection (

int

direction

)

Adjacent grid node in the specified direction.

This will return null if the node does not have a connection to a node in that direction.

The dir parameter corresponds to directions in the grid as: Z
|
|

6 2 5
\ | /
-- 3 - X - 1 ----- X
/ | \
7 0 4

|
|


bool GetPortal (

GraphNode	other	The node which is on the other side of the portal (strictly speaking it does not actually have to be on the other side of the portal though).
List<Vector3>	left	List of portal points on the left side of the funnel
List<Vector3>	right	List of portal points on the right side of the funnel
bool	backwards	If this is true, the call was made on a node with the other node as the node before this one in the path. In this case you may choose to do nothing since a similar call will be made to the other node with this node referenced as other (but then with backwards = true). You do not have to care about switching the left and right lists, that is done for you already.

)

Add a portal from this node to the specified node.

This function should add a portal to the left and right lists which is connecting the two nodes (this and other).

The default implementation simply returns false.

This function may add more than one portal if necessary.

GridNode ()

GridNode (

AstarPath

astar

)

bool HasConnectionInDirection (

int

dir

)

True if the node has a connection in the specified direction.

The dir parameter corresponds to directions in the grid as: Z
|
|

6 2 5
\ | /
-- 3 - X - 1 ----- X
/ | \
7 0 4

|
|


void Open (

Path	path
PathNode	pathNode
PathHandler	handler

)

Open the node.

Used internally for the A* algorithm.

void ResetConnectionsInternal ()

Disables all grid connections from this node.

void SerializeNode (

GraphSerializationContext

ctx

)

Serialized the node data to a byte array.

void SetAllConnectionInternal (

int

connections

a bitmask of the connections (bit 0 is the first connection, bit 1 the second connection, etc.).

)

Sets the state of all grid connections.

void SetConnectionInternal (

int	dir
bool	value

)

Enables or disables a connection in a specified direction on the graph.

void UpdateRecursiveG (

Path	path
PathNode	pathNode
PathHandler	handler

)

void ClearGridGraph (

int	graphIndex
GridGraph	graph

)

int FilterDiagonalConnections (

int	conns
NumNeighbours	neighbours
bool	cutCorners

)

Filters diagonal connections based on the non-diagonal ones to prevent corner cutting and similar things.

This involves some complicated bitshifting to calculate which diagonal connections should be active based on the non-diagonal ones. For example a path should not be able to pass from A to B if the #s represent nodes that we cannot traverse.

# B
A #


Additionally if corner cutting is disabled we will also prevent a connection from A to B in this case:

B
A #


If neighbours = 4 then only the 4 axis aligned connections will be enabled.

If neighbours = 6 then only the connections which are valid for hexagonal graphs will be enabled.

GridGraph GetGridGraph (

uint

graphIndex

)

void SetGridGraph (

int	graphIndex
GridGraph	graph

)

bool? EdgeNode

Work in progress for a feature that required info about which nodes were at the border of the graph.

bool HasAnyGridConnections => GetAllConnectionInternal() != 0

bool HasConnectionsToAllEightNeighbours

void AddConnection (

GraphNode	node
uint	cost

)

Add a connection from this node to the specified node.

If the connection already exists, the cost will simply be updated and no extra connection added.

uint Area

Connected component that contains the node.

This is visualized in the scene view as differently colored nodes (if the graph coloring mode is set to 'Areas'). Each area represents a set of nodes such that there is no valid path between nodes of different colors.

void ClearConnections (

bool

alsoReverse

if true, neighbours will be requested to remove connections to this node.

)

Remove all connections from this node.

void ClearCustomConnections (

bool

alsoReverse

)

Same as ClearConnections, but does not clear grid connections, only custom ones (e.g added by AddConnection or a NodeLink component)

Connection[] connections

Custon non-grid connections from this node.

This field is removed if the ASTAR_GRID_NO_CUSTOM_CONNECTIONS compiler directive is used. Removing it can save a tiny bit of memory. You can enable the define in the Optimizations tab in the A* inspector.

bool ContainsConnection (

GraphNode

node

)

Checks if this node has a connection to the specified node.

AstarPath.active.AddWorkItem(new AstarWorkItem(ctx => {
// Connect two nodes
var node1 = AstarPath.active.GetNearest(transform.position, NNConstraint.None).node;
var node2 = AstarPath.active.GetNearest(transform.position + Vector3.right, NNConstraint.None).node;
var cost = (uint)(node2.position - node1.position).costMagnitude;
node1.AddConnection(node2, cost);
node2.AddConnection(node1, cost);

node1.ContainsConnection(node2); // True

node1.RemoveConnection(node2);
node2.RemoveConnection(node1);
}));


void DeserializeReferences (

GraphSerializationContext

ctx

)

Used to deserialize references to other nodes e.g connections.

Use the GraphSerializationContext.GetNodeIdentifier and GraphSerializationContext.GetNodeFromIdentifier methods for serialization and deserialization respectively.

Nodes must override this method and serialize their connections. Graph generators do not need to call this method, it will be called automatically on all nodes at the correct time by the serializer.

void Destroy ()

Destroys the node.

Cleans up any temporary pathfinding data used for this node. The graph is responsible for calling this method on nodes when they are destroyed, including when the whole graph is destoyed. Otherwise memory leaks might present themselves.

Once called the Destroyed property will return true and subsequent calls to this method will not do anything.

bool Destroyed

uint Flags

Holds various bitpacked variables.

Bit 0: Walkable Bits 1 through 17: HierarchicalNodeIndex Bit 18: IsHierarchicalNodeDirty Bits 19 through 23: Tag Bits 24 through 31: GraphIndex

void GetConnections (

System.Action<GraphNode>

action

)

Calls the delegate with all connections from this node.

node.GetConnections(connectedTo => {
Debug.DrawLine((Vector3)node.position, (Vector3)connectedTo.position, Color.red);
});
You can add all connected nodes to a list like this var connections = new List<GraphNode>();
node.GetConnections(connections.Add);


int GetGizmoHashCode ()

Hash code used for checking if the gizmos need to be updated.

Will change when the gizmos for the node might change.

NavGraph? Graph

Graph which this node belongs to.

If you know the node belongs to a particular graph type, you can cast it to that type: GraphNode node = ...;
GridGraph graph = node.Graph as GridGraph;


Will return null if the node has been destroyed.

uint GraphIndex

Graph which contains this node.

const uint MaxGraphIndex = FlagsGraphMask >> FlagsGraphOffset

Max number of graphs-1.

const uint MaxHierarchicalNodeIndex = HierarchicalIndexMask >> FlagsHierarchicalIndexOffset

const int MaxTagIndex = 32 - 1

Max number of tags - 1.

Always a power of 2 minus one

int NodeIndex

Internal unique index.

Every node will get a unique index. This index is not necessarily correlated with e.g the position of the node in the graph.

int NodeInGridIndex

The index of the node in the grid.

This is x + z*graph.width So you can get the X and Z indices using int index = node.NodeInGridIndex;
int x = index % graph.width;
int z = index / graph.width;
// where graph is GridNode.GetGridGraph (node.graphIndex), i.e the graph the nodes are contained in.


const int NodeInGridIndexLayerOffset = 24

void Open (

Path	path
PathNode	pathNode
PathHandler	handler

)

Open the node.

Used internally for the A* algorithm.

uint? Penalty

Penalty cost for walking on this node.

This can be used to make it harder/slower to walk over certain nodes. A cost of 1000 (Int3.Precision) corresponds to the cost of moving 1 world unit.

Int3 position

Position of the node in world space.

Vector3 RandomPointOnSurface ()

A random point on the surface of the node.

For point nodes and other nodes which do not have a surface, this will always return the position of the node.

void RecalculateConnectionCosts ()

Recalculates a node's connection costs.

void RemoveConnection (

GraphNode

node

)

Removes any connection from this node to the specified node.

If no such connection exists, nothing will be done.

void SerializeReferences (

GraphSerializationContext

ctx

)

Used to serialize references to other nodes e.g connections.

Use the GraphSerializationContext.GetNodeIdentifier and GraphSerializationContext.GetNodeFromIdentifier methods for serialization and deserialization respectively.

Nodes must override this method and serialize their connections. Graph generators do not need to call this method, it will be called automatically on all nodes at the correct time by the serializer.

void SetConnectivityDirty ()

Inform the system that the node's connectivity has changed.

This is used for recalculating the connected components of the graph.

You must call this method if you change the connectivity or walkability of the node without going through the high level methods such as the Walkable property or the AddConnection method. For example if your manually change the Pathfinding.MeshNode.connections array you need to call this method.

float SurfaceArea ()

The surface area of the node in square world units.

uint Tag

Node tag.

bool? TmpWalkable

Temporary variable used internally when updating the graph.

void UpdateRecursiveG (

Path	path
PathNode	pathNode
PathHandler	handler

)

bool? Walkable

True if the node is traversable.

bool? WalkableErosion

Stores walkability before erosion is applied.

Used internally when updating the graph.

int XCoordinateInGrid

X coordinate of the node in the grid.

The node in the bottom left corner has (x,z) = (0,0) and the one in the opposite corner has (x,z) = (width-1, depth-1)

int ZCoordinateInGrid

Z coordinate of the node in the grid.

The node in the bottom left corner has (x,z) = (0,0) and the one in the opposite corner has (x,z) = (width-1, depth-1)

GridGraph[] _gridGraphs = new GridGraph[0]

uint flags

Bitpacked field holding several pieces of data.

ushort gridFlags

const int GridFlagsConnectionBit0 = 1 << GridFlagsConnectionOffset

const int GridFlagsConnectionMask = 0xFF << GridFlagsConnectionOffset

const int GridFlagsConnectionOffset = 0

const int GridFlagsEdgeNodeMask = 1 << GridFlagsEdgeNodeOffset

const int GridFlagsEdgeNodeOffset = 10

int HierarchicalNodeIndex

Hierarchical Node that contains this node.

The graph is divided into clusters of small hierarchical nodes in which there is a path from every node to every other node. This structure is used to speed up connected component calculations which is used to quickly determine if a node is reachable from another node.

ushort InternalGridFlags

Internal use only.

bool? IsHierarchicalNodeDirty

Some internal bookkeeping.

int nodeInGridIndex

Bitfield containing the x and z coordinates of the node as well as the layer (for layered grid graphs).

const int NodeInGridIndexMask = 0xFFFFFF

bool? TemporaryFlag1

Temporary flag for internal purposes.

May only be used in the Unity thread. Must be reset to false after every use.

bool? TemporaryFlag2

Temporary flag for internal purposes.

May only be used in the Unity thread. Must be reset to false after every use.