NavigationMeshInstance

Inherits: Spatial < Node < Object NavigationMesh.

Description

NavigationMesh. It tells the Navigation node what can be navigated and what cannot, based on the NavigationMesh resource. World navigation map. If this node is a child of a Navigation node it will register to the navigation map of the navigation node. NavigationServer.map_set_edge_connection_margin. Note: Overlapping two regions’ navmeshes 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

Signals

• bake_finished ( ) Notifies when the navigation mesh bake operation is completed.

• navigation_mesh_changed ( ) NavigationMesh has changed.

  Property Descriptions

• bool enabled NavigationMeshInstance is enabled or disabled.

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

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

• float travel_cost travel_cost for determining the shortest path.

  Method Descriptions

• bake_navigation_mesh ( bool on_thread=true ) 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 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.