Class NavmeshBase Extends NavGraph, INavmesh, INavmeshHolder, ITransformedGraph, IRaycastableGraph

GraphTransform CalculateTransform ()

Returns a new transform which transforms graph space to world space.

Does not update the transform field.

void EndBatchTileUpdate ()

End batch updating of tiles.

During batch updating, tiles will not be connected if they are updating with ReplaceTile. When ending batching, all affected tiles will be connected. This is faster than not using batching.

NNInfoInternal GetNearest (

Vector3	position	The position to try to find a close node to
NNConstraint	constraint	Can for example tell the function to try to return a walkable node. If you do not get a good node back, consider calling GetNearestForce.
GraphNode	hint	Can be passed to enable some graph generators to find the nearest node faster.

)

Returns the nearest node to a position using the specified NNConstraint.

NNInfoInternal GetNearestForce (

Vector3	position
NNConstraint	constraint

)

Returns the nearest node to a position using the specified constraint .

void GetNodes (

System.Action<GraphNode>

action

)

Calls a delegate with all nodes in the graph.

This is the primary way of iterating through all nodes in a graph.

Do not change the graph structure inside the delegate.

var gg = AstarPath.active.data.gridGraph;

gg.GetNodes(node => {
// Here is a node
Debug.Log("I found a node at position " + (Vector3)node.position);
});
If you want to store all nodes in a list you can do this

var gg = AstarPath.active.data.gridGraph;

List<GraphNode> nodes = new List<GraphNode>();
gg.GetNodes((System.Action<GraphNode>)nodes.Add);


NavmeshTile GetTile (

int	x
int	z

)

Tile at the specified x, z coordinate pair.

The first tile is at (0,0), the last tile at (tileXCount-1, tileZCount-1).

var graph = AstarPath.active.data.recastGraph;
int tileX = 5;
int tileZ = 8;
NavmeshTile tile = graph.GetTile(tileX, tileZ);

for (int i = 0; i < tile.nodes.Length; i++) {
// ...
}
// or you can access the nodes like this:
tile.GetNodes(node => {
// ...
});


Bounds GetTileBounds (

IntRect

rect

)

Returns a bounds object with the bounding box of a group of tiles.

The bounding box is defined in world space.

Bounds GetTileBounds (

int	x
int	z
int	width=1
int	depth=1

)

Returns a bounds object with the bounding box of a group of tiles.

The bounding box is defined in world space.

Bounds GetTileBoundsInGraphSpace (

IntRect

rect

)

Bounds GetTileBoundsInGraphSpace (

int	x
int	z
int	width=1
int	depth=1

)

Returns an XZ bounds object with the bounds of a group of tiles in graph space.

Int2 GetTileCoordinates (

Vector3

position

)

Returns the tile coordinate which contains the specified position.

It is not necessarily a valid tile (i.e it could be out of bounds).

void GetTileCoordinates (

int	tileIndex
out int	x
out int	z

)

Tile coordinates from a tile index.

NavmeshTile[] GetTiles ()

All tiles.

IntRect GetTouchingTiles (

Bounds

bounds

)

Returns a rect containing the indices of all tiles touching the specified bounds.

IntRect GetTouchingTilesInGraphSpace (

Rect

rect

Graph space rectangle (in graph space all tiles are on the XZ plane regardless of graph rotation and other transformations, the first tile has a corner at the origin)

)

Returns a rect containing the indices of all tiles touching the specified bounds.

IntRect GetTouchingTilesRound (

Bounds

bounds

)

Returns a rect containing the indices of all tiles by rounding the specified bounds to tile borders.

This is different from GetTouchingTiles in that the tiles inside the rectangle returned from this method may not contain the whole bounds, while that is guaranteed for GetTouchingTiles.

Int3 GetVertex (

int

index

)

Vertex coordinate for the specified vertex index.

int GetVertexArrayIndex (

int

index

)

Int3 GetVertexInGraphSpace (

int

index

)

Vertex coordinate in graph space for the specified vertex index.

bool Linecast (

Vector3	origin
Vector3	end

)

Returns if there is an obstacle between origin and end on the graph.

This is not the same as Physics.Linecast, this function traverses the graph and looks for collisions instead of checking for collider intersection.

bool Linecast (

Vector3	origin	Point to linecast from
Vector3	end	Point to linecast to
GraphNode	hint	You need to pass the node closest to the start point

)

Returns if there is an obstacle between origin and end on the graph.

This is not the same as Physics.Linecast, this function traverses the graph and looks for collisions instead of checking for collider intersection.

bool Linecast (

Vector3	origin	Point to linecast from
Vector3	end	Point to linecast to
GraphNode	hint	You need to pass the node closest to the start point
outGraphHitInfo	hit	Contains info on what was hit, see GraphHitInfo

)

Returns if there is an obstacle between origin and end on the graph.

This is not the same as Physics.Linecast, this function traverses the graph and looks for collisions instead of checking for collider intersection.

bool Linecast (

Vector3	origin	Point to linecast from
Vector3	end	Point to linecast to
GraphNode	hint	You need to pass the node closest to the start point
outGraphHitInfo	hit	Contains info on what was hit, see GraphHitInfo
List<GraphNode>	trace	If a list is passed, then it will be filled with all nodes the linecast traverses

)

Returns if there is an obstacle between origin and end on the graph.

This is not the same as Physics.Linecast, this function traverses the graph and looks for collisions instead of checking for collider intersection.

void OnDrawGizmos (

Pathfinding.Util.RetainedGizmos	gizmos
bool	drawNodes

)

GraphNode PointOnNavmesh (

Vector3	position
NNConstraint	constraint

)

Finds the first node which contains position.

"Contains" is defined as position is inside the triangle node when seen from above. So only XZ space matters. In case of a multilayered environment, which node of the possibly several nodes containing the point is undefined.

Returns null if there was no node containing the point. This serves as a quick check for "is this point on the navmesh or not".

Note that the behaviour of this method is distinct from the GetNearest method. The GetNearest method will return the closest node to a point, which is not necessarily the one which contains it in XZ space.

void RelocateNodes (

Matrix4x4

deltaMatrix

)

Moves the nodes in this graph.

Multiplies all node positions by deltaMatrix.

For example if you want to move all your nodes in e.g a point graph 10 units along the X axis from the initial position var graph = AstarPath.data.pointGraph;
var m = Matrix4x4.TRS (new Vector3(10,0,0), Quaternion.identity, Vector3.one);
graph.RelocateNodes (m);


void RelocateNodes (

GraphTransform

newTransform

)

Moves the nodes in this graph.

Moves all the nodes in such a way that the specified transform is the new graph space to world space transformation for the graph. You usually use this together with the CalculateTransform method.

So for example if you want to move and rotate all your nodes in e.g a recast graph you can do var graph = AstarPath.data.recastGraph;
graph.rotation = new Vector3(45, 0, 0);
graph.forcedBoundsCenter = new Vector3(20, 10, 10);
var transform = graph.CalculateTransform();
graph.RelocateNodes(transform);
This will move all the nodes to new positions as if the new graph settings had been there from the start.

void ReplaceTile (

int	x
int	z
Int3[]	verts
int []	tris

)

Replace tile at index with nodes created from specified navmesh.

void ReplaceTile (

int	x
int	z
int	w
int	d
Int3[]	verts
int []	tris

)

Replaces a tile with a new mesh.

This will create new nodes and link them to the adjacent tile (unless batching has been started in which case that will be done when batching ends).

The vertices are assumed to be in 'tile space', that is being in a rectangle with one corner at the origin and one at (TileWorldSizeX, 0, TileWorldSizeZ).

void StartBatchTileUpdate ()

Start batch updating of tiles.

During batch updating, tiles will not be connected if they are updating with ReplaceTile. When ending batching, all affected tiles will be connected. This is faster than not using batching.

int GetTileIndex (

int

index

)

Tile index from a vertex index.

bool Linecast (

NavmeshBase	graph	The graph to perform the search on
Vector3	origin	Point to start from
Vector3	end	Point to linecast to
GraphNode	hint	You need to pass the node closest to the start point, if null, a search for the closest node will be done
outGraphHitInfo	hit	Contains info on what was hit, see GraphHitInfo

)

Returns if there is an obstacle between origin and end on the graph.

This is not the same as Physics.Linecast, this function traverses the graph and looks for collisions instead of checking for collider intersection.

bool Linecast (

NavmeshBase	graph	The graph to perform the search on
Vector3	origin	Point to start from. This point should be on the navmesh. It will be snapped to the closest point on the navmesh otherwise.
Vector3	end	Point to linecast to
GraphNode	hint	If you already know the node which contains the origin point, you may pass it here for slighly improved performance. If null, a search for the closest node will be done.
outGraphHitInfo	hit	Contains info on what was hit, see GraphHitInfo
List<GraphNode>	trace	If a list is passed, then it will be filled with all nodes along the line up until it hits an obstacle or reaches the end.

)

Returns if there is an obstacle between origin and end on the graph.

This is not the same as Physics.Linecast, this function traverses the graph and looks for collisions instead of checking for collider intersections.

Vector3 forcedBoundsSize = new Vector3(100, 40, 100)

Size of the bounding box.

bool nearestSearchOnlyXZ

Perform nearest node searches in XZ space only.

Recomended for single-layered environments. Faster but can be inaccurate esp. in multilayered contexts. You should not use this if the graph is rotated since then the XZ plane no longer corresponds to the ground plane.

This can be important on sloped surfaces. See the image below in which the closest point for each blue point is queried for:

You can also control this using a field on an NNConstraint object.

System.Action<NavmeshTile[]> OnRecalculatedTiles

Called when tiles have been completely recalculated.

This is called after scanning the graph and after performing graph updates that completely recalculate tiles (not ones that simply modify e.g penalties). It is not called after NavmeshCut updates.

bool showMeshOutline = true

Show an outline of the polygons in the Unity Editor.

bool showMeshSurface

Show the surface of the navmesh.

bool showNodeConnections

Show the connections between the polygons in the Unity Editor.

const int TileIndexMask = 0x7FFFF

const int TileIndexOffset = 12

float TileWorldSizeX

Size of a tile in world units along the X axis.

float TileWorldSizeZ

Size of a tile in world units along the Z axis.

int tileXCount

Number of tiles along the X-axis.

int tileZCount

Number of tiles along the Z-axis.

GraphTransform transform = new GraphTransform(Matrix4x4.identity)

Determines how the graph transforms graph space to world space.

const int VertexIndexMask = 0xFFF

AstarPath active

Reference to the AstarPath object in the scene.

int CountNodes ()

Number of nodes in the graph.

Note that this is, unless the graph type has overriden it, an O(n) operation.

This is an O(1) operation for grid graphs and point graphs. For layered grid graphs it is an O(n) operation.

bool drawGizmos = true

Enable to draw gizmos in the Unity scene view.

In the inspector this value corresponds to the state of the 'eye' icon in the top left corner of every graph inspector.

NNInfoInternal GetNearest (

Vector3

position

The position to try to find a close node to

)

Returns the nearest node to a position.

NNInfoInternal GetNearest (

Vector3	position	The position to try to find a close node to
NNConstraint	constraint	Can for example tell the function to try to return a walkable node. If you do not get a good node back, consider calling GetNearestForce.

)

Returns the nearest node to a position using the specified NNConstraint.

void GetNodes (

System.Func<GraphNode, bool>

action

)

Calls a delegate with all nodes in the graph until the delegate returns false.

uint graphIndex

Index of the graph, used for identification purposes.

Guid guid

Used as an ID of the graph, considered to be unique.

bool infoScreenOpen

Used in the editor to check if the info screen is open.

Should be inside UNITY_EDITOR only #ifs but just in case anyone tries to serialize a NavGraph instance using Unity, I have left it like this as it would otherwise cause a crash when building. Version 3.0.8.1 was released because of this bug only

uint initialPenalty

Default penalty to apply to all nodes.

string name

Name of the graph.

Can be set in the unity editor

void OnDrawGizmos (

RetainedGizmos	gizmos
bool	drawNodes

)

Draw gizmos for the graph.

bool open

Is the graph open in the editor.

void Scan ()

Scan the graph.

Consider using AstarPath.Scan() instead since this function only scans this graph and if you are using multiple graphs with connections between them, then it is better to scan all graphs at once.

bool batchTileUpdate

Currently updating tiles in a batch.

List<int> batchUpdatedTiles = new List<int>()

List of tiles updating during batch.

void ClearTiles (

int	x
int	z
int	w
int	d

)

Clear all tiles within the rectangle with one corner at (x,z), width w and depth d.

void ConnectTiles (

NavmeshTile	tile1
NavmeshTile	tile2

)

Generate connections between the two tiles.

The tiles must be adjacent.

void ConnectTileWithNeighbours (

NavmeshTile	tile
bool	onlyUnflagged=false

)

void CreateNavmeshOutlineVisualization (

NavmeshTile	tile
GraphGizmoHelper	helper

)

Creates an outline of the navmesh for use in OnDrawGizmos in the editor.

void CreateNavmeshSurfaceVisualization (

NavmeshTile	tile
GraphGizmoHelper	helper

)

Creates a mesh of the surfaces of the navmesh for use in OnDrawGizmos in the editor.

void CreateNodeConnections (

TriangleMeshNode[]

nodes

)

Create connections between all nodes.

TriangleMeshNode[] CreateNodes (

int []	tris
int	tileIndex
uint	graphIndex

)

void DeserializeExtraInfo (

GraphSerializationContext

ctx

)

Deserializes graph type specific node data.

void DestroyAllNodes ()

Destroys all nodes in the graph.

void DrawUnwalkableNodes (

float

size

)

bool exists

True if the graph exists, false if it has been destroyed.

void FillWithEmptyTiles ()

Fills graph with tiles created by NewEmptyTile.

byte [] LinecastShapeEdgeLookup

Used to optimize linecasts by precomputing some values.

float MaxTileConnectionEdgeDistance

Maximum (vertical) distance between the sides of two nodes for them to be connected across a tile edge.

When tiles are connected to each other, the nodes sometimes do not line up perfectly so some allowance must be made to allow tiles that do not match exactly to be connected with each other.

static NavmeshBase ()

NavmeshTile NewEmptyTile (

int	x
int	z

)

Creates a single new empty tile.

NNConstraint NNConstraintDistanceXZ = new NNConstraint { distanceXZ = true }

NNConstraint NNConstraintNone = NNConstraint.None

Cached NNConstraint.None to reduce allocations.

void OnDestroy ()

Function for cleaning up references.

This will be called on the same time as OnDisable on the gameObject which the AstarPath script is attached to (remember, not in the editor). Use for any cleanup code such as cleaning up static variables which otherwise might prevent resources from being collected. Use by creating a function overriding this one in a graph class, but always call base.OnDestroy () in that function. All nodes should be destroyed in this function otherwise a memory leak will arise.

void PostDeserialization (

GraphSerializationContext

ctx

)

Called after all deserialization has been done for all graphs.

Can be used to set up more graph data which is not serialized

bool RecalculateNormals

Determines how normals are calculated.

Disable for spherical graphs or other complicated surfaces that allow the agents to e.g walk on walls or ceilings.

By default the normals of the mesh will be flipped so that they point as much as possible in the upwards direction. The normals are important when connecting adjacent nodes. Two adjacent nodes will only be connected if they are oriented the same way. This is particularly important if you have a navmesh on the walls or even on the ceiling of a room. Or if you are trying to make a spherical navmesh. If you do one of those things then you should set disable this setting and make sure the normals in your source mesh are properly set.

If you for example take a look at the image below. In the upper case then the nodes on the bottom half of the mesh haven't been connected with the nodes on the upper half because the normals on the lower half will have been modified to point inwards (as that is the direction that makes them face upwards the most) while the normals on the upper half point outwards. This causes the nodes to not connect properly along the seam. When this option is set to false instead the nodes are connected properly as in the original mesh all normals point outwards.

The default value of this field is true to reduce the risk for errors in the common case. If a mesh is supplied that has all normals pointing downwards and this option is false, then some methods like PointOnNavmesh will not work correctly as they assume that the normals point upwards. For a more complicated surface like a spherical graph those methods make no sense anyway as there is no clear definition of what it means to be "inside" a triangle when there is no clear up direction.

void RemoveConnectionsFromTile (

NavmeshTile

tile

)

void RemoveConnectionsFromTo (

NavmeshTile	a
NavmeshTile	b

)

void SerializeExtraInfo (

GraphSerializationContext

ctx

)

Serializes Node Info.

Should serialize:

• Base

  • Node Flags

  • Node Penalties

  • Node

• Node Positions (if applicable)

• Any other information necessary to load the graph in-game All settings marked with json attributes (e.g JsonMember) have already been saved as graph settings and do not need to be handled here.

It is not necessary for this implementation to be forward or backwards compatible.

NavmeshTile[] tiles

All tiles.

GraphTransformITransformedGraph. transform