NavigationMeshInstance

    An instance of a NavigationMesh.

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

    By default this node will register to the default 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 .

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

    Properties

    void

    bake_navigation_mesh ( on_thread=true )

    RID

    ( ) const

    Signals

    • bake_finished ( )

    Notifies when the navigation mesh bake operation is completed.

    • navigation_mesh_changed ( )

    Notifies when the has changed.

    • enabled

    Determines if the NavigationMeshInstance is enabled or disabled.

    Default

    0.0

    Setter

    set_enter_cost(value)

    Getter

    get_enter_cost()

    • int navigation_layers

    A bitfield determining all navigation map layers the 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.

    • navmesh

    Setter

    set_navigation_mesh(value)

    Getter

    get_navigation_mesh()

    The NavigationMesh resource to use.

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

    Bakes the NavigationMesh. If on_thread is set to (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 . 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).