Inheritance #

NavigationPolygon #

is_refcounted, is_instantiable, resource, core, not_builtin_classes

A 2D navigation mesh that describes a traversable surface for pathfinding.

A navigation mesh can be created either by baking it with the help of the NavigationServer2D, or by adding vertices and convex polygon indices arrays manually.

To bake a navigation mesh at least one outline needs to be added that defines the outer bounds of the baked area.

GDScript

var new_navigation_mesh = NavigationPolygon.new()
var bounding_outline = PackedVector2Array([Vector2(0, 0), Vector2(0, 50), Vector2(50, 50), Vector2(50, 0)])
new_navigation_mesh.add_outline(bounding_outline)
NavigationServer2D.bake_from_source_geometry_data(new_navigation_mesh, NavigationMeshSourceGeometryData2D.new());
$NavigationRegion2D.navigation_polygon = new_navigation_mesh

C#

var newNavigationMesh = new NavigationPolygon();
Vector2[] boundingOutline = [new Vector2(0, 0), new Vector2(0, 50), new Vector2(50, 50), new Vector2(50, 0)];
newNavigationMesh.AddOutline(boundingOutline);
NavigationServer2D.BakeFromSourceGeometryData(newNavigationMesh, new NavigationMeshSourceGeometryData2D());
GetNode("NavigationRegion2D").NavigationPolygon = newNavigationMesh;

Adding vertices and polygon indices manually.

GDScript

var new_navigation_mesh = NavigationPolygon.new()
var new_vertices = PackedVector2Array([Vector2(0, 0), Vector2(0, 50), Vector2(50, 50), Vector2(50, 0)])
new_navigation_mesh.vertices = new_vertices
var new_polygon_indices = PackedInt32Array([0, 1, 2, 3])
new_navigation_mesh.add_polygon(new_polygon_indices)
$NavigationRegion2D.navigation_polygon = new_navigation_mesh

C#

var newNavigationMesh = new NavigationPolygon();
Vector2[] newVertices = [new Vector2(0, 0), new Vector2(0, 50), new Vector2(50, 50), new Vector2(50, 0)];
newNavigationMesh.Vertices = newVertices;
int[] newPolygonIndices = [0, 1, 2, 3];
newNavigationMesh.AddPolygon(newPolygonIndices);
GetNode("NavigationRegion2D").NavigationPolygon = newNavigationMesh;

Members #

var agent_radius: float = 10.0#

The distance to erode/shrink the walkable surface when baking the navigation mesh.

var baking_rect: Rect2 = Rect2(0, 0, 0, 0)#

If the baking Rect2 has an area the navigation mesh baking will be restricted to its enclosing area.

var baking_rect_offset: Vector2 = Vector2(0, 0)#

The position offset applied to the baking_rect Rect2.

var border_size: float = 0.0#

The size of the non-navigable border around the bake bounding area defined by the baking_rect Rect2.

In conjunction with the baking_rect the border size can be used to bake tile aligned navigation meshes without the tile edges being shrunk by agent_radius.

var cell_size: float = 1.0#

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

var parsed_collision_mask: int = 4294967295#

The physics layers to scan for static colliders.

Only used when parsed_geometry_type is PARSED_GEOMETRY_STATIC_COLLIDERS or PARSED_GEOMETRY_BOTH.

var parsed_geometry_type = PARSED_GEOMETRY_BOTH#

Determines which type of nodes will be parsed as geometry. See ParsedGeometryType for possible values.

var sample_partition_type = SAMPLE_PARTITION_CONVEX_PARTITION#

Partitioning algorithm for creating the navigation mesh polys. See SamplePartitionType for possible values.

var source_geometry_group_name: StringName = &"navigation_polygon_source_geometry_group"#

The group name of nodes that should be parsed for baking source geometry.

Only used when source_geometry_mode is SOURCE_GEOMETRY_GROUPS_WITH_CHILDREN or SOURCE_GEOMETRY_GROUPS_EXPLICIT.

var source_geometry_mode = SOURCE_GEOMETRY_ROOT_NODE_CHILDREN#

The source of the geometry used when baking. See SourceGeometryMode for possible values.

Methods #

Annotations #

Constants #

const SAMPLE_PARTITION_CONVEX_PARTITION = 0 enum SamplePartitionType#

Convex partitioning that yields navigation mesh with convex polygons.

const SAMPLE_PARTITION_TRIANGULATE = 1 enum SamplePartitionType#

Triangulation partitioning that yields navigation mesh with triangle polygons.

const SAMPLE_PARTITION_MAX = 2 enum SamplePartitionType#

Represents the size of the SamplePartitionType enum.

const PARSED_GEOMETRY_MESH_INSTANCES = 0 enum ParsedGeometryType#

Parses mesh instances as obstruction geometry. This includes Polygon2D, MeshInstance2D, MultiMeshInstance2D, and TileMap nodes.

Meshes are only parsed when they use a 2D vertices surface format.

const PARSED_GEOMETRY_STATIC_COLLIDERS = 1 enum ParsedGeometryType#

Parses StaticBody2D and TileMap colliders as obstruction geometry. The collider should be in any of the layers specified by parsed_collision_mask.

const PARSED_GEOMETRY_BOTH = 2 enum ParsedGeometryType#

Both PARSED_GEOMETRY_MESH_INSTANCES and PARSED_GEOMETRY_STATIC_COLLIDERS.

const PARSED_GEOMETRY_MAX = 3 enum ParsedGeometryType#

Represents the size of the ParsedGeometryType enum.

const SOURCE_GEOMETRY_ROOT_NODE_CHILDREN = 0 enum SourceGeometryMode#

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

const SOURCE_GEOMETRY_GROUPS_WITH_CHILDREN = 1 enum SourceGeometryMode#

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

const SOURCE_GEOMETRY_GROUPS_EXPLICIT = 2 enum SourceGeometryMode#

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

const SOURCE_GEOMETRY_MAX = 3 enum SourceGeometryMode#

Represents the size of the SourceGeometryMode enum.

Constructors #

Enums #

SamplePartitionType#

ParsedGeometryType#

SourceGeometryMode#

Operators #

Signals #

Theme Items #

Tutorials #