NavigationPolygonInstance

    A region of the 2D navigation map.

    A region of the navigation map. It tells the what can be navigated and what cannot, based on its NavigationPolygon resource.

    By default this node will register to the default navigation map. If this node is a child of a Navigation2D 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’ polygons is not enough for connecting two regions. They must share a similar edge.

    The pathfinding 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 pathfinding cost of traveling distances inside this region can be controlled with the multiplier.

    RID

    ( ) const

    • enabled

    Determines if the NavigationPolygonInstance is enabled or disabled.

    Default

    0.0

    Setter

    set_enter_cost(value)

    Getter

    get_enter_cost()

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

    • navpoly

    Setter

    set_navigation_polygon(value)

    Getter

    get_navigation_polygon()

    The NavigationPolygon resource to use.

    • travel_cost
    • get_region_rid ( ) const

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