Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

NavigationMesh

Inherits: Resource < RefCounted < Object

A navigation mesh that defines traversable areas and obstacles.

Description

A navigation mesh is a collection of polygons that define which areas of an environment are traversable to aid agents in pathfinding through complicated spaces.

Tutorials

• Using NavigationMeshes

• 3D Navmesh Demo

Properties

float	agent_height	1.5
float	agent_max_climb	0.25
float	agent_max_slope	45.0
float	agent_radius	0.5
float	cell_height	0.25
float	cell_size	0.25
float	detail_sample_distance	6.0
float	detail_sample_max_error	1.0
float	edge_max_error	1.3
float	edge_max_length	0.0
AABB	filter_baking_aabb	AABB(0, 0, 0, 0, 0, 0)
Vector3	filter_baking_aabb_offset	Vector3(0, 0, 0)
bool	filter_ledge_spans	false
bool	filter_low_hanging_obstacles	false
bool	filter_walkable_low_height_spans	false
int	geometry_collision_mask	4294967295
ParsedGeometryType	geometry_parsed_geometry_type	0
SourceGeometryMode	geometry_source_geometry_mode	0
StringName	geometry_source_group_name	&"navigation_mesh_source_group"
float	region_merge_size	20.0
float	region_min_size	2.0
SamplePartitionType	sample_partition_type	0
float	vertices_per_polygon	6.0

Methods

void	add_polygon ( PackedInt32Array polygon )
void	clear ( )
void	clear_polygons ( )
void	create_from_mesh ( Mesh mesh )
bool	get_collision_mask_value ( int layer_number ) const
PackedInt32Array	get_polygon ( int idx )
int	get_polygon_count ( ) const
PackedVector3Array	get_vertices ( ) const
void	set_collision_mask_value ( int layer_number, bool value )
void	set_vertices ( PackedVector3Array vertices )

---

Enumerations

enum SamplePartitionType:

SamplePartitionType SAMPLE_PARTITION_WATERSHED = 0

Watershed partitioning. Generally the best choice if you precompute the navigation mesh, use this if you have large open areas.

SamplePartitionType SAMPLE_PARTITION_MONOTONE = 1

Monotone partitioning. Use this if you want fast navigation mesh generation.

SamplePartitionType SAMPLE_PARTITION_LAYERS = 2

Layer partitioning. Good choice to use for tiled navigation mesh with medium and small sized tiles.

SamplePartitionType SAMPLE_PARTITION_MAX = 3

Represents the size of the SamplePartitionType enum.

---

enum ParsedGeometryType:

ParsedGeometryType PARSED_GEOMETRY_MESH_INSTANCES = 0

Parses mesh instances as geometry. This includes MeshInstance3D, CSGShape3D, and GridMap nodes.

ParsedGeometryType PARSED_GEOMETRY_STATIC_COLLIDERS = 1

Parses StaticBody3D colliders as geometry. The collider should be in any of the layers specified by geometry_collision_mask.

ParsedGeometryType PARSED_GEOMETRY_BOTH = 2

Both PARSED_GEOMETRY_MESH_INSTANCES and PARSED_GEOMETRY_STATIC_COLLIDERS.

ParsedGeometryType PARSED_GEOMETRY_MAX = 3

Represents the size of the ParsedGeometryType enum.

---

enum SourceGeometryMode:

SourceGeometryMode SOURCE_GEOMETRY_ROOT_NODE_CHILDREN = 0

Scans the child nodes of the root node recursively for geometry.

SourceGeometryMode SOURCE_GEOMETRY_GROUPS_WITH_CHILDREN = 1

Scans nodes in a group and their child nodes recursively for geometry. The group is specified by geometry_source_group_name.

SourceGeometryMode SOURCE_GEOMETRY_GROUPS_EXPLICIT = 2

Uses nodes in a group for geometry. The group is specified by geometry_source_group_name.

SourceGeometryMode SOURCE_GEOMETRY_MAX = 3

Represents the size of the SourceGeometryMode enum.

---

Property Descriptions

float agent_height = 1.5

• void set_agent_height ( float value )

• float get_agent_height ( )

The minimum floor to ceiling height that will still allow the floor area to be considered walkable.

Note: While baking, this value will be rounded up to the nearest multiple of cell_height.

---

float agent_max_climb = 0.25

• void set_agent_max_climb ( float value )

• float get_agent_max_climb ( )

The minimum ledge height that is considered to still be traversable.

Note: While baking, this value will be rounded down to the nearest multiple of cell_height.

---

float agent_max_slope = 45.0

• void set_agent_max_slope ( float value )

• float get_agent_max_slope ( )

The maximum slope that is considered walkable, in degrees.

---

float agent_radius = 0.5

• void set_agent_radius ( float value )

• float get_agent_radius ( )

The distance to erode/shrink the walkable area of the heightfield away from obstructions.

Note: While baking, this value will be rounded up to the nearest multiple of cell_size.

---

float cell_height = 0.25

• void set_cell_height ( float value )

• float get_cell_height ( )

The cell height used to rasterize the navigation mesh vertices on the Y axis. Must match with the cell height on the navigation map.

---

float cell_size = 0.25

• void set_cell_size ( float value )

• float get_cell_size ( )

The cell size used to rasterize the navigation mesh vertices on the XZ plane. Must match with the cell size on the navigation map.

---

float detail_sample_distance = 6.0

• void set_detail_sample_distance ( float value )

• float get_detail_sample_distance ( )

The sampling distance to use when generating the detail mesh, in cell unit.

---

float detail_sample_max_error = 1.0

• void set_detail_sample_max_error ( float value )

• float get_detail_sample_max_error ( )

The maximum distance the detail mesh surface should deviate from heightfield, in cell unit.

---

float edge_max_error = 1.3

• void set_edge_max_error ( float value )

• float get_edge_max_error ( )

The maximum distance a simplified contour's border edges should deviate the original raw contour.

---

float edge_max_length = 0.0

• void set_edge_max_length ( float value )

• float get_edge_max_length ( )

The maximum allowed length for contour edges along the border of the mesh. A value of 0.0 disables this feature.

Note: While baking, this value will be rounded up to the nearest multiple of cell_size.

---

AABB filter_baking_aabb = AABB(0, 0, 0, 0, 0, 0)

• void set_filter_baking_aabb ( AABB value )

• AABB get_filter_baking_aabb ( )

If the baking AABB has a volume the navigation mesh baking will be restricted to its enclosing area.

---

Vector3 filter_baking_aabb_offset = Vector3(0, 0, 0)

• void set_filter_baking_aabb_offset ( Vector3 value )