Attention

You are reading the latest (unstable) version of this documentation, which may document features not available or compatible with Godot 3.x.

Checking the stable version of the documentation...

Work in progress

Godot documentation is being updated to reflect the latest changes in version 4.0. Some documentation pages may still state outdated information. This banner will tell you if you're reading one of such pages.

The contents of this page are up to date. If you can still find outdated information, please open an issue.

NavigationRegion2D¶

Inherits: Node2D < CanvasItem < Node < Object

A region of the 2D navigation map.

Description¶

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

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 NavigationServer2D.map_set_edge_connection_margin.

Note: Overlapping two regions' navigation 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.

Note: This node caches changes to its properties, so if you make changes to the underlying region RID in NavigationServer2D, they will not be reflected in this node's properties.

Tutorials¶

Using NavigationRegions

Properties¶

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

Methods¶

bool	get_navigation_layer_value ( int layer_number ) const
RID	get_region_rid ( ) const
void	set_navigation_layer_value ( int layer_number, bool value )

Property Descriptions¶

bool enabled = true

void set_enabled ( bool value )
bool is_enabled ( )

Determines if the NavigationRegion2D 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 navigation mesh from another regions navigation mesh 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 layers the region belongs to. These navigation layers can be checked upon when requesting a path with NavigationServer2D.map_get_path.

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 navigation mesh the traveled distances are multiplied with travel_cost for determining the shortest path.

Method Descriptions¶

Returns whether or not the specified layer of the navigation_layers bitmask is enabled, given a layer_number between 1 and 32.

RID get_region_rid ( ) const

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

Based on value, enables or disables the specified layer in the navigation_layers bitmask, given a layer_number between 1 and 32.