NavigationMeshInstance

Inherits: Spatial < Node < Object

An instance of a NavigationMesh.

Description

An instance of a NavigationMesh. It tells the Navigation node what can be navigated and what cannot, based on the NavigationMesh resource.

By default this node will register to the default World navigation map. If this node is a child of a Navigation 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 NavigationServer.map_set_edge_connection_margin.

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

The 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 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
NavigationMesh	navmesh
float	travel_cost	1.0

Methods

void	bake_navigation_mesh ( bool on_thread=true )
RID	get_region_rid ( ) const

---

Signals

bake_finished ( )

Notifies when the navigation mesh bake operation is completed.

---

navigation_mesh_changed ( )

Notifies when the NavigationMesh has changed.

---

Property Descriptions

bool enabled = true

• void set_enabled ( bool value )

• bool is_enabled ( )

Determines if the NavigationMeshInstance 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 NavigationMesh belongs to. On path requests with NavigationServer.map_get_path navmeshes without matching layers will be ignored and the navigation map will only proximity merge different navmeshes with matching layers.

---

NavigationMesh navmesh

• void set_navigation_mesh ( NavigationMesh value )

• NavigationMesh get_navigation_mesh ( )

The NavigationMesh 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

void bake_navigation_mesh ( bool on_thread=true )

Bakes the NavigationMesh. If on_thread is set to true (default), the baking is done on a separate thread. Baking on separate thread is useful because navigation baking is not a cheap operation. When it is completed, it automatically sets the new NavigationMesh. Please note that baking on separate thread may be very slow if geometry is parsed from meshes as async access to each mesh involves heavy synchronization. Also, please note that baking on a separate thread is automatically disabled on operating systems that cannot use threads (such as HTML5 with threads disabled).

---

RID get_region_rid ( ) const

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