NavigationPolygonInstance

Inherits: Node2D < CanvasItem < Node < Object

A region of the 2D navigation map.

Description

A region of the navigation map. It tells the Navigation2DServer what can be navigated and what cannot, based on its NavigationPolygon resource.

By default this node will register to the default World2D navigation map. If this node is a child of a Navigation2D node it will register to the navigation map of the navigation node.

Two regions can be connected to each other if they share a similar edge. You can set the minimum distance between two vertices required to connect two edges by using Navigation2DServer.map_set_edge_connection_margin.

Note: Overlapping two regions' polygons is not enough for connecting two regions. They must share a similar edge.

The pathfinding cost of entering this region from another region can be controlled with the enter_cost value.

Note: This value is not added to the path cost when the start position is already inside this region.

The pathfinding cost of traveling distances inside this region can be controlled with the travel_cost multiplier.

Properties

bool	enabled	true
float	enter_cost	0.0
int	navigation_layers	1
NavigationPolygon	navpoly
float	travel_cost	1.0

Methods

RID	get_region_rid ( ) const

---

Property Descriptions

bool enabled = true

• void set_enabled ( bool value )

• bool is_enabled ( )

Determines if the NavigationPolygonInstance is enabled or disabled.

---

float enter_cost = 0.0

• void set_enter_cost ( float value )

• float get_enter_cost ( )

When pathfinding enters this region's navmesh from another regions navmesh the enter_cost value is added to the path distance for determining the shortest path.

---

int navigation_layers = 1

• void set_navigation_layers ( int value )

• int get_navigation_layers ( )

A bitfield determining all navigation map layers the NavigationPolygon belongs to. On path requests with Navigation2DServer.map_get_path navmeshes without matching layers will be ignored and the navigation map will only proximity merge different navmeshes with matching layers.

---

NavigationPolygon navpoly

• void set_navigation_polygon ( NavigationPolygon value )

• NavigationPolygon get_navigation_polygon ( )

The NavigationPolygon resource to use.

---

float travel_cost = 1.0

• void set_travel_cost ( float value )

• float get_travel_cost ( )

When pathfinding moves inside this region's navmesh the traveled distances are multiplied with travel_cost for determining the shortest path.

---

Method Descriptions

RID get_region_rid ( ) const

Returns the RID of this region on the Navigation2DServer. Combined with Navigation2DServer.map_get_closest_point_owner can be used to identify the NavigationPolygonInstance closest to a point on the merged navigation map.