Table of Contents

Class NavigationRegion2D

A traversable 2D region that NavigationAgent2Ds can use for pathfinding.

Inheritance
NavigationRegion2D

A traversable 2D region based on a NavigationPolygon that NavigationAgent2Ds can use for pathfinding.

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 a 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.

See Also

Using NavigationRegions

Properties

Determines if the NavigationRegion2D is enabled or disabled.

var enabled : bool = true

Property Value

bool
  • void set_enabled(bool value)
  • bool is_enabled

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.

var enter_cost : float = 0.0

Property Value

float
  • void set_enter_cost(float value)
  • float get_enter_cost

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.

var navigation_layers : int = 1

Property Value

int
  • void set_navigation_layers(int value)
  • int get_navigation_layers

The NavigationPolygon resource to use.

var navigation_polygon : NavigationPolygon

Property Value

NavigationPolygon

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

var travel_cost : float = 1.0

Property Value

float
  • void set_travel_cost(float value)
  • float get_travel_cost

If enabled the navigation region will use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin.

var use_edge_connections : bool = true

Property Value

bool
  • void set_use_edge_connections(bool value)
  • bool get_use_edge_connections

Methods

bake_navigation_polygon(bool)

Bakes the NavigationPolygon. If on_thread is set to true (default), the baking is done on a separate thread.

void bake_navigation_polygon(bool on_thread)

Parameters

on_thread bool

Qualifiers: const

Returns the axis-aligned rectangle for the region's transformed navigation mesh.

Rect2 get_bounds

get_navigation_layer_value(int)

Qualifiers: const

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

bool get_navigation_layer_value(int layer_number)

Parameters

layer_number int

Qualifiers: const

Returns the current navigation map RID used by this region.

RID get_navigation_map

Qualifiers: const

Returns the RID of this region on the NavigationServer2D.

RID get_region_rid

Qualifiers: 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.

RID get_rid

Qualifiers: const

Returns true when the NavigationPolygon is being baked on a background thread.

bool is_baking

set_navigation_layer_value(int, bool)

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

void set_navigation_layer_value(int layer_number, bool value)

Parameters

layer_number int
value bool

set_navigation_map(RID)

Sets the RID of the navigation map this region should use. By default the region will automatically join the World2D default navigation map so this function is only required to override the default map.

void set_navigation_map(RID navigation_map)

Parameters

navigation_map RID

Events

Emitted when a navigation polygon bake operation is completed.

signal bake_finished

Emitted when the used navigation polygon is replaced or changes to the internals of the current navigation polygon are committed.

signal navigation_polygon_changed