Class NodeLink3Node Extends PointNode

GraphNode GetOther (

GraphNode

a

)

bool GetPortal (

GraphNode	other	The node which is on the other side of the portal.
out Vector3	left	Output left side of the portal.
out Vector3	right	Output right side of the portal.

)

Add a portal from this node to the specified node.

This function returns a portal which connects this node to the given adjacenet node.

The default implementation simply returns false.

NodeLink3Node (

AstarPath

astar

)

NodeLink3 link

Vector3 portalA

Vector3 portalB

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.

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


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.

Vector3 ClosestPointOnNode (

Vector3

p

)

Closest point on the surface of this node to the point p.

For a point node this is always the node's position sicne it has no surface.

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


bool ContainsPoint (

Int3

point

)

Checks if point is inside the node when seen from above.

bool ContainsPoint (

Vector3

point

)

Checks if point is inside the node when seen from above.

Since point nodes have no surface area, this method always returns false.

bool ContainsPointInGraphSpace (

Int3

point

)

Checks if point is inside the node in graph space.

Since point nodes have no surface area, this method always returns false.

Int3 DecodeVariantPosition (

uint	pathNodeIndex
uint	fractionAlongEdge

)

The position of the path node during the search.

When an A* search on triangle nodes is carried out, each edge of the node is a separate path node variant. The search will additionally decide where on that edge the path node is located. This is encoded by the fractionAlongEdge variable. This function decodes the position of the path node.

void DeserializeNode (

GraphSerializationContext

ctx

)

Deserializes the node data from a byte array.

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

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

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


void GetConnections<T> (

GetConnectionsWithData<T>	action
ref T	data

)

Calls the delegate with all connections from this node and passes a custom data value to the delegate.

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


delegate void GetConnectionsWithData<T> (

GraphNode	node
ref T	data

)

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 int InvalidNodeIndex = 0

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

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.

void Open (

Path	path
uint	pathNodeIndex
uint	gScore

)

Open the node.

Used internally by the A* algorithm.

void OpenAtPoint (

Path	path
uint	pathNodeIndex
Int3	position
uint	gScore

)

Open the node at a specific point.

Used internally by the A* algorithm.

Used when a path starts inside a node, or when an off-mesh link is used to move to a point inside this node.

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.

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

GraphNode

node

)

Removes any connection from this node to the specified node.

If no such connection exists, nothing will be done.

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

GraphSerializationContext

ctx

)

Serialized the node data to a byte array.

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.

void SetPosition (

Int3

value

)

float SurfaceArea ()

The surface area of the node in square world units.

uint Tag

Node tag.

bool? Walkable

True if the node is traversable.

Connection[] connections

All connections from this node.

GameObject gameObject

GameObject this node was created from (if any).

var node = AstarPath.active.GetNearest(transform.position).node;
var pointNode = node as PointNode;

if (pointNode != null) {
Debug.Log("That node was created from the GameObject named " + pointNode.gameObject.name);
} else {
Debug.Log("That node is not a PointNode");
}


Int3 position

Position of the node in world space.

GraphNode GetOtherInternal (

GraphNode

a

)

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.

bool? IsHierarchicalNodeDirty

Some internal bookkeeping.

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.

uint flags

Bitpacked field holding several pieces of data.