Class GridNode Extends GridNodeBase

bool? EdgeNode

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

bool HasAnyGridConnections

True if this node has any grid connections.

bool HasConnectionsToAllAxisAlignedNeighbours

True if the node has grid connections to all its 4 axis-aligned neighbours.

bool HasConnectionsToAllEightNeighbours

True if the node has grid connections to all its 8 neighbours.

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.

Vector2Int CoordinatesInGrid

The X and Z coordinates 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)

bool Destroyed

const uint DestroyedNodeIndex = NodeIndexMask - 1

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

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 InvalidGraphIndex = (FlagsGraphMask) >> FlagsGraphOffset

const int InvalidNodeIndex = 0

const uint MaxGraphIndex = (FlagsGraphMask-1) >> 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 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

uint 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.

uint? Penalty

Penalty cost for walking on this node.

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

uint Tag

Node tag.

bool? TmpWalkable

Temporary variable used internally when updating the graph.

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)

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.

Int3 position

Position of the node in world space.

const int GridFlagsAxisAlignedConnectionMask = 0xF << GridFlagsConnectionOffset

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.

const int NodeInGridIndexMask = 0xFFFFFF

int PathNodeVariants

How many path node variants should be created for each node.

This should be a constant for each node type.

Typically this is 1, but for example the triangle mesh node type has 3 variants, one for each edge.

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.

GridGraph[] _gridGraphs = new GridGraph[0]

uint flags

Bitpacked field holding several pieces of data.

ushort gridFlags

int nodeInGridIndex

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

int[] offsetToDirection = { 7, 0, 4, 3, -1, 1, 6, 2, 5 }

Converts from dx + 3*dz to a neighbour direction.

Used by OffsetToConnectionDirection.

Assumes that dx and dz are both in the range [0,2].