Class LevelGridNode Extends GridNodeBase

void ClearConnections (

bool

alsoReverse

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

)

Remove all connections from this node.

void DeserializeNode (

GraphSerializationContext

ctx

)

Deserializes node data (for example when loading graphs from file).

void FloodFill (

Stack<GraphNode>	stack
uint	region

)

Internal method to run a flood fill in order to recalculate the Area property.

bool GetConnection (

int

i

)

Is there a grid connection in that direction.

void GetConnections (

System.Action<Connection>

action

)

Calls the delegate with all connections and respective costs from this node.

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 GetConnectionValue (

int

dir

Direction for the connection.

)

Which layer a grid connection goes to.

int GetGizmoHashCode ()

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

Will change when the gizmos for the node might change.

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.

bool HasAnyGridConnections ()

Does this node have any grid connections.

LevelGridNode (

AstarPath

astar

)

void Open (

Path	path
PathNode	pathNode
PathHandler	handler

)

Open the node.

Adds all neighbours of this node to the open list.

void ResetAllGridConnections ()

Removes all grid connections from this node.

void SerializeNode (

GraphSerializationContext

ctx

)

Serializes node data (for example when saving graphs to file).

void SetConnectionValue (

int	dir	Direction for the connection.
int	value	The layer of the connected node or NoConnection if there should be no connection in that direction.

)

Set which layer a grid connection goes to.

void SetPosition (

Int3

position

)

void UpdateRecursiveG (

Path	path
PathNode	pathNode
PathHandler	handler

)

Internal method to update the G score.

Internal method to update the G score for this node and all children of it in the search graph

LayerGridGraph GetGridGraph (

uint

graphIndex

)

void SetGridGraph (

int	graphIndex
LayerGridGraph	graph

)

const int ConnectionMask = 0xFF

ulong gridConnections

bool HasConnectionsToAllEightNeighbours

int LayerCoordinateInGrid

Layer coordinate of the node in the grid.

If there are multiple nodes in the same (x,z) cell, then they will be stored in different layers. Together with NodeInGridIndex, you can look up the node in the nodes array int index = node.NodeInGridIndex + node.LayerCoordinateInGrid * graph.width * graph.depth;
Assert(node == graph.nodes[index]);


const int MaxLayerCount = ConnectionMask

const int NoConnection = 0xFF

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.

For performance reasons the graph is split up into several connected components using a flood fill. This is done so that if a path request is made between two nodes for which there is no possible path then it should be able to abort quickly instead of having to search the whole graph (which can be very expensive). It is also used to better be able to search for target nodes for paths (it will try to find the closest target node that can be reached instead of just the closest node to the target point).

When a graph update is done, this value usually needs to be updated. When using a GraphUpdateObject, that is done automatically, but for other kinds of updates, you may need to call some functions to update it (see docs on updating graphs).

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

bool ContainsConnection (

GraphNode

node

)

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

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.

bool Destroyed

uint Flags

Holds various bitpacked variables.

void FloodFill (

System.Collections.Generic.Stack<GraphNode>	stack
uint	region

)

void GetConnections (

System.Action<Connection>

action

)

Calls the delegate with all connections and respective costs from this node.

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 MaxAreaIndex = FlagsAreaMask >> FlagsAreaOffset

const uint MaxGraphIndex = FlagsGraphMask >> FlagsGraphOffset

Max number of graphs-1.

int NodeIndex

Internal unique index.

This index is not necessarily correlated with e.g the position of the node in the graph.

Will be unique as long as the node is active. When the node is destroyed, the index may be reused by other nodes.

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.


void Open (

Path	path
PathNode	pathNode
PathHandler	handler

)

Open the node.

Adds all neighbours of this node to the open list.

void OpenCooperative (

CooperativeABPath	path
PathNodeCooperative	pathNode
CooperativePathHandler	handler

)

Open the node cooperatively.

Adds all neighbours of this node to the open list.

uint Penalty

Penalty cost for walking on this node.

This can be used to make it harder/slower to walk over certain areas. 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 all connection costs from this node.

Depending on the node type, this may or may not be supported. Nothing will be done if the operation is not supported

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.

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

)

Internal method to update the G score.

Internal method to update the G score for this node and all children of it in the search graph

bool Walkable

True if the node can be traversed.

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)

LayerGridGraph[] _gridGraphs = new LayerGridGraph[0]

const int ConnectionStride = 8

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.

uint flags

Bitpacked field holding several pieces of data.

ushort gridFlags

LayerGridGraph[] gridGraphs

int nodeInGridIndex

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

const int NodeInGridIndexLayerOffset = 24

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.