NavigationPolygonInstance

Inherits: Node2D < CanvasItem < Node < Object A region of the 2D navigation map.

Description

Navigation2DServer what can be navigated and what cannot, based on its NavigationPolygon resource. World2D navigation map. If this node is a child of a Navigation2D node it will register to the navigation map of the navigation node. Navigation2DServer.map_set_edge_connection_margin. Note: Overlapping two regions’ polygons is not enough for connecting two regions. They must share a similar edge. enter_cost value. Note: This value is not added to the path cost when the start position is already inside this region. travel_cost multiplier.

Properties

Methods

Property Descriptions

• bool enabled NavigationPolygonInstance is enabled or disabled.

• float enter_cost enter_cost value is added to the path distance for determining the shortest path.

• int navigation_layers 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 NavigationPolygon resource to use.

• float travel_cost travel_cost for determining the shortest path.

  Method Descriptions

• RID get_region_rid ( ) const 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.