Index · Object → NavigationServer2D

NavigationServer2D

A server interface for low-level 2D navigation access.

Class Description

NavigationServer2D is the server that handles navigation maps, regions and agents. It does not handle A* navigation from AStar2D or AStarGrid2D.

Maps are divided into regions, which are composed of navigation polygons. Together, they define the traversable areas in the 2D world.

Note: Most NavigationServer2D changes take effect after the next physics frame and not immediately. This includes all changes made to maps, regions or agents by navigation-related nodes in the scene tree or made through scripts.

For two regions to be connected to each other, they must share a similar edge. An edge is considered connected to another if both of its two vertices are at a distance less than edge_connection_margin to the respective other edge's vertex.

You may assign navigation layers to regions with region_set_navigation_layers(), which then can be checked upon when requesting a path with map_get_path(). This can be used to allow or deny certain areas for some objects.

To use the collision avoidance system, you may use agents. You can set an agent's target velocity, then the servers will emit a callback with a modified velocity.

Note: The collision avoidance system ignores regions. Using the modified velocity directly may move an agent outside of the traversable area. This is a limitation of the collision avoidance system, any more complex situation may require the use of the physics engine.

This server keeps tracks of any call and executes them during the sync phase. This means that you can request any change to the map, using any thread, without worrying.

Methods

func agent_create() -> RID

Creates the agent.

func agent_get_avoidance_enabled(agent: RID) -> bool

Return true if the specified agent uses avoidance.

func agent_get_avoidance_layers(agent: RID) -> int

Returns the avoidance_layers bitmask of the specified agent.

func agent_get_avoidance_mask(agent: RID) -> int

Returns the avoidance_mask bitmask of the specified agent.

func agent_get_avoidance_priority(agent: RID) -> float

Returns the avoidance_priority of the specified agent.

func agent_get_map(agent: RID) -> RID

Returns the navigation map RID the requested agent is currently assigned to.

func agent_get_max_neighbors(agent: RID) -> int

Returns the maximum number of other agents the specified agent takes into account in the navigation.

func agent_get_max_speed(agent: RID) -> float

Returns the maximum speed of the specified agent.

func agent_get_neighbor_distance(agent: RID) -> float

Returns the maximum distance to other agents the specified agent takes into account in the navigation.

func agent_get_paused(agent: RID) -> bool

Returns true if the specified agent is paused.

func agent_get_position(agent: RID) -> Vector2

Returns the position of the specified agent in world space.

func agent_get_radius(agent: RID) -> float

Returns the radius of the specified agent.

func agent_get_time_horizon_agents(agent: RID) -> float

Returns the minimal amount of time for which the specified agent's velocities that are computed by the simulation are safe with respect to other agents.

func agent_get_time_horizon_obstacles(agent: RID) -> float

Returns the minimal amount of time for which the specified agent's velocities that are computed by the simulation are safe with respect to static avoidance obstacles.

func agent_get_velocity(agent: RID) -> Vector2

Returns the velocity of the specified agent.

func agent_has_avoidance_callback(agent: RID) -> bool

Return true if the specified agent has an avoidance callback.

func agent_is_map_changed(agent: RID) -> bool

Returns true if the map got changed the previous frame.

func agent_set_avoidance_callback(agent: RID, callback: Callable) -> void

Sets the callback Callable that gets called after each avoidance processing step for the agent. The calculated safe_velocity will be dispatched with a signal to the object just before the physics calculations.

Note: Created callbacks are always processed independently of the SceneTree state as long as the agent is on a navigation map and not freed. To disable the dispatch of a callback from an agent use agent_set_avoidance_callback() again with an empty Callable.

func agent_set_avoidance_enabled(agent: RID, enabled: bool) -> void

If enabled is true, the specified agent uses avoidance.

func agent_set_avoidance_layers(agent: RID, layers: int) -> void

Set the agent's avoidance_layers bitmask.

func agent_set_avoidance_mask(agent: RID, mask: int) -> void

Set the agent's avoidance_mask bitmask.

func agent_set_avoidance_priority(agent: RID, priority: float) -> void

Set the agent's avoidance_priority with a priority between 0.0 (lowest priority) to 1.0 (highest priority).

The specified agent does not adjust the velocity for other agents that would match the avoidance_mask but have a lower avoidance_priority. This in turn makes the other agents with lower priority adjust their velocities even more to avoid collision with this agent.

func agent_set_map(agent: RID, map: RID) -> void

Puts the agent in the map.

func agent_set_max_neighbors(agent: RID, count: int) -> void

Sets the maximum number of other agents the agent takes into account in the navigation. The larger this number, the longer the running time of the simulation. If the number is too low, the simulation will not be safe.

func agent_set_max_speed(agent: RID, max_speed: float) -> void

Sets the maximum speed of the agent. Must be positive.

func agent_set_neighbor_distance(agent: RID, distance: float) -> void

Sets the maximum distance to other agents this agent takes into account in the navigation. The larger this number, the longer the running time of the simulation. If the number is too low, the simulation will not be safe.

func agent_set_paused(agent: RID, paused: bool) -> void

If paused is true the specified agent will not be processed. For example, it will not calculate avoidance velocities or receive avoidance callbacks.

func agent_set_position(agent: RID, position: Vector2) -> void

Sets the position of the agent in world space.

func agent_set_radius(agent: RID, radius: float) -> void

Sets the radius of the agent.

func agent_set_time_horizon_agents(agent: RID, time_horizon: float) -> void

The minimal amount of time for which the agent's velocities that are computed by the simulation are safe with respect to other agents. The larger this number, the sooner this agent will respond to the presence of other agents, but the less freedom this agent has in choosing its velocities. A too high value will slow down agents movement considerably. Must be positive.

func agent_set_time_horizon_obstacles(agent: RID, time_horizon: float) -> void

The minimal amount of time for which the agent's velocities that are computed by the simulation are safe with respect to static avoidance obstacles. The larger this number, the sooner this agent will respond to the presence of static avoidance obstacles, but the less freedom this agent has in choosing its velocities. A too high value will slow down agents movement considerably. Must be positive.

func agent_set_velocity(agent: RID, velocity: Vector2) -> void

Sets velocity as the new wanted velocity for the specified agent. The avoidance simulation will try to fulfill this velocity if possible but will modify it to avoid collision with other agent's and obstacles. When an agent is teleported to a new position far away use agent_set_velocity_forced() instead to reset the internal velocity state.

func agent_set_velocity_forced(agent: RID, velocity: Vector2) -> void

Replaces the internal velocity in the collision avoidance simulation with velocity for the specified agent. When an agent is teleported to a new position far away this function should be used in the same frame. If called frequently this function can get agents stuck.

func bake_from_source_geometry_data(navigation_polygon: NavigationPolygon, source_geometry_data: NavigationMeshSourceGeometryData2D, callback: Callable = Callable()) -> void

Bakes the provided navigation_polygon with the data from the provided source_geometry_data. After the process is finished the optional callback will be called.

func bake_from_source_geometry_data_async(navigation_polygon: NavigationPolygon, source_geometry_data: NavigationMeshSourceGeometryData2D, callback: Callable = Callable()) -> void

Bakes the provided navigation_polygon with the data from the provided source_geometry_data as an async task running on a background thread. After the process is finished the optional callback will be called.

func free_rid(rid: RID) -> void

Destroys the given RID.

func get_debug_enabled() -> bool

Returns true when the NavigationServer has debug enabled.

func get_maps() -> RID[]

Returns all created navigation map RIDs on the NavigationServer. This returns both 2D and 3D created navigation maps as there is technically no distinction between them.

func get_process_info(process_info: NavigationServer2D.ProcessInfo) -> int

Returns information about the current state of the NavigationServer.

func is_baking_navigation_polygon(navigation_polygon: NavigationPolygon) -> bool

Returns true when the provided navigation polygon is being baked on a background thread.

func map_create() -> RID

Create a new map.

func map_force_update(map: RID) -> void

This function immediately forces synchronization of the specified navigation map RID. By default navigation maps are only synchronized at the end of each physics frame. This function can be used to immediately (re)calculate all the navigation meshes and region connections of the navigation map. This makes it possible to query a navigation path for a changed map immediately and in the same frame (multiple times if needed).

Due to technical restrictions the current NavigationServer command queue will be flushed. This means all already queued update commands for this physics frame will be executed, even those intended for other maps, regions and agents not part of the specified map. The expensive computation of the navigation meshes and region connections of a map will only be done for the specified map. Other maps will receive the normal synchronization at the end of the physics frame. Should the specified map receive changes after the forced update it will update again as well when the other maps receive their update.

Avoidance processing and dispatch of the safe_velocity signals is unaffected by this function and continues to happen for all maps and agents at the end of the physics frame.

Note: With great power comes great responsibility. This function should only be used by users that really know what they are doing and have a good reason for it. Forcing an immediate update of a navigation map requires locking the NavigationServer and flushing the entire NavigationServer command queue. Not only can this severely impact the performance of a game but it can also introduce bugs if used inappropriately without much foresight.

func map_get_agents(map: RID) -> RID[]

Returns all navigation agents RIDs that are currently assigned to the requested navigation map.

func map_get_cell_size(map: RID) -> float

Returns the map cell size used to rasterize the navigation mesh vertices.

func map_get_closest_point(map: RID, to_point: Vector2) -> Vector2

Returns the navigation mesh surface point closest to the provided to_point on the navigation map.

func map_get_closest_point_owner(map: RID, to_point: Vector2) -> RID

Returns the owner region RID for the navigation mesh surface point closest to the provided to_point on the navigation map.

func map_get_edge_connection_margin(map: RID) -> float

Returns the edge connection margin of the map. The edge connection margin is a distance used to connect two regions.

func map_get_iteration_id(map: RID) -> int

Returns the current iteration id of the navigation map. Every time the navigation map changes and synchronizes the iteration id increases. An iteration id of 0 means the navigation map has never synchronized.

Note: The iteration id will wrap back to 1 after reaching its range limit.

func map_get_merge_rasterizer_cell_scale(map: RID) -> float

Returns map's internal merge rasterizer cell scale.

func map_get_obstacles(map: RID) -> RID[]

Returns all navigation obstacle RIDs that are currently assigned to the requested navigation map.

func map_get_path(map: RID, origin: Vector2, destination: Vector2, optimize: bool, navigation_layers: int = 1) -> PackedVector2Array

Returns the navigation path to reach the destination from the origin. navigation_layers is a bitmask of all region navigation layers that are allowed to be in the path.

func map_get_random_point(map: RID, navigation_layers: int, uniformly: bool) -> Vector2

Returns a random position picked from all map region polygons with matching navigation_layers.

If uniformly is true, all map regions, polygons, and faces are weighted by their surface area (slower).

If uniformly is false, just a random region and a random polygon are picked (faster).

func map_get_regions(map: RID) -> RID[]

Returns all navigation regions RIDs that are currently assigned to the requested navigation map.

func map_get_use_async_iterations(map: RID) -> bool

Returns true if the map synchronization uses an async process that runs on a background thread.

func map_get_use_edge_connections(map: RID) -> bool

Returns whether the navigation map allows navigation regions to use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin.

func map_is_active(map: RID) -> bool

Returns true if the map is active.

func map_set_active(map: RID, active: bool) -> void

Sets the map active.

func map_set_cell_size(map: RID, cell_size: float) -> void

Sets the map cell size used to rasterize the navigation mesh vertices. Must match with the cell size of the used navigation meshes.

func map_set_edge_connection_margin(map: RID, margin: float) -> void

Set the map edge connection margin used to weld the compatible region edges.

func map_set_merge_rasterizer_cell_scale(map: RID, scale: float) -> void

Set the map's internal merge rasterizer cell scale used to control merging sensitivity.

func map_set_use_async_iterations(map: RID, enabled: bool) -> void

If enabled is true the map synchronization uses an async process that runs on a background thread.

func map_set_use_edge_connections(map: RID, enabled: bool) -> void

Set the navigation map edge connection use. If enabled is true, the navigation map allows navigation regions to use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin.

func obstacle_create() -> RID

Creates a new navigation obstacle.

func obstacle_get_avoidance_enabled(obstacle: RID) -> bool

Returns true if the provided obstacle has avoidance enabled.

func obstacle_get_avoidance_layers(obstacle: RID) -> int

Returns the avoidance_layers bitmask of the specified obstacle.

func obstacle_get_map(obstacle: RID) -> RID

Returns the navigation map RID the requested obstacle is currently assigned to.

func obstacle_get_paused(obstacle: RID) -> bool

Returns true if the specified obstacle is paused.

func obstacle_get_position(obstacle: RID) -> Vector2

Returns the position of the specified obstacle in world space.

func obstacle_get_radius(obstacle: RID) -> float

Returns the radius of the specified dynamic obstacle.

func obstacle_get_velocity(obstacle: RID) -> Vector2

Returns the velocity of the specified dynamic obstacle.

func obstacle_get_vertices(obstacle: RID) -> PackedVector2Array

Returns the outline vertices for the specified obstacle.

func obstacle_set_avoidance_enabled(obstacle: RID, enabled: bool) -> void

If enabled is true, the provided obstacle affects avoidance using agents.

func obstacle_set_avoidance_layers(obstacle: RID, layers: int) -> void

Set the obstacles's avoidance_layers bitmask.

func obstacle_set_map(obstacle: RID, map: RID) -> void

Sets the navigation map RID for the obstacle.

func obstacle_set_paused(obstacle: RID, paused: bool) -> void

If paused is true the specified obstacle will not be processed. For example, it will no longer affect avoidance velocities.

func obstacle_set_position(obstacle: RID, position: Vector2) -> void

Sets the position of the obstacle in world space.

func obstacle_set_radius(obstacle: RID, radius: float) -> void

Sets the radius of the dynamic obstacle.

func obstacle_set_velocity(obstacle: RID, velocity: Vector2) -> void

Sets velocity of the dynamic obstacle. Allows other agents to better predict the movement of the dynamic obstacle. Only works in combination with the radius of the obstacle.

func obstacle_set_vertices(obstacle: RID, vertices: PackedVector2Array) -> void

Sets the outline vertices for the obstacle. If the vertices are winded in clockwise order agents will be pushed in by the obstacle, else they will be pushed out.

func parse_source_geometry_data(navigation_polygon: NavigationPolygon, source_geometry_data: NavigationMeshSourceGeometryData2D, root_node: Node, callback: Callable = Callable()) -> void

Parses the SceneTree for source geometry according to the properties of navigation_polygon. Updates the provided source_geometry_data resource with the resulting data. The resource can then be used to bake a navigation mesh with bake_from_source_geometry_data(). After the process is finished the optional callback will be called.

Note: This function needs to run on the main thread or with a deferred call as the SceneTree is not thread-safe.

Performance: While convenient, reading data arrays from Mesh resources can affect the frame rate negatively. The data needs to be received from the GPU, stalling the RenderingServer in the process. For performance prefer the use of e.g. collision shapes or creating the data arrays entirely in code.

func query_path(parameters: NavigationPathQueryParameters2D, result: NavigationPathQueryResult2D, callback: Callable = Callable()) -> void

Queries a path in a given navigation map. Start and target position and other parameters are defined through NavigationPathQueryParameters2D. Updates the provided NavigationPathQueryResult2D result object with the path among other results requested by the query. After the process is finished the optional callback will be called.

func region_create() -> RID

Creates a new region.

func region_get_bounds(region: RID) -> Rect2

Returns the axis-aligned rectangle for the region's transformed navigation mesh.

func region_get_closest_point(region: RID, to_point: Vector2) -> Vector2

Returns the navigation mesh surface point closest to the provided to_point on the navigation region.

func region_get_connection_pathway_end(region: RID, connection: int) -> Vector2

Returns the ending point of a connection door. connection is an index between 0 and the return value of region_get_connections_count().

func region_get_connection_pathway_start(region: RID, connection: int) -> Vector2

Returns the starting point of a connection door. connection is an index between 0 and the return value of region_get_connections_count().

func region_get_connections_count(region: RID) -> int

Returns how many connections this region has with other regions in the map.

func region_get_enabled(region: RID) -> bool

Returns true if the specified region is enabled.

func region_get_enter_cost(region: RID) -> float

Returns the enter cost of this region.

func region_get_iteration_id(region: RID) -> int

Returns the current iteration ID of the navigation region. Every time the navigation region changes and synchronizes, the iteration ID increases. An iteration ID of 0 means the navigation region has never synchronized.

Note: The iteration ID will wrap around to 1 after reaching its range limit.

func region_get_map(region: RID) -> RID

Returns the navigation map RID the requested region is currently assigned to.

func region_get_navigation_layers(region: RID) -> int

Returns the region's navigation layers.

func region_get_owner_id(region: RID) -> int

Returns the ObjectID of the object which manages this region.

func region_get_random_point(region: RID, navigation_layers: int, uniformly: bool) -> Vector2

Returns a random position picked from all region polygons with matching navigation_layers.

If uniformly is true, all region polygons and faces are weighted by their surface area (slower).

If uniformly is false, just a random polygon and face is picked (faster).

func region_get_transform(region: RID) -> Transform2D

Returns the global transformation of this region.

func region_get_travel_cost(region: RID) -> float

Returns the travel cost of this region.

func region_get_use_async_iterations(region: RID) -> bool

Returns true if the region uses an async synchronization process that runs on a background thread.

func region_get_use_edge_connections(region: RID) -> bool

Returns whether the navigation region is set to use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin.

func region_owns_point(region: RID, point: Vector2) -> bool

Returns true if the provided point in world space is currently owned by the provided navigation region. Owned in this context means that one of the region's navigation mesh polygon faces has a possible position at the closest distance to this point compared to all other navigation meshes from other navigation regions that are also registered on the navigation map of the provided region.

If multiple navigation meshes have positions at equal distance the navigation region whose polygons are processed first wins the ownership. Polygons are processed in the same order that navigation regions were registered on the NavigationServer.

Note: If navigation meshes from different navigation regions overlap (which should be avoided in general) the result might not be what is expected.

func region_set_enabled(region: RID, enabled: bool) -> void

If enabled is true the specified region will contribute to its current navigation map.

func region_set_enter_cost(region: RID, enter_cost: float) -> void

Sets the enter_cost for this region.

func region_set_map(region: RID, map: RID) -> void

Sets the map for the region.

func region_set_navigation_layers(region: RID, navigation_layers: int) -> void

Set the region's navigation layers. This allows selecting regions from a path request (when using map_get_path()).

func region_set_navigation_polygon(region: RID, navigation_polygon: NavigationPolygon) -> void

Sets the navigation_polygon for the region.

func region_set_owner_id(region: RID, owner_id: int) -> void

Set the ObjectID of the object which manages this region.

func region_set_transform(region: RID, transform: Transform2D) -> void

Sets the global transformation for the region.

func region_set_travel_cost(region: RID, travel_cost: float) -> void

Sets the travel_cost for this region.

func region_set_use_async_iterations(region: RID, enabled: bool) -> void

If enabled is true the region uses an async synchronization process that runs on a background thread.

func region_set_use_edge_connections(region: RID, enabled: bool) -> void

If enabled is true, the navigation region will use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin.

func set_active(active: bool) -> void

Control activation of this server.

func set_debug_enabled(enabled: bool) -> void

If true enables debug mode on the NavigationServer.

func simplify_path(path: PackedVector2Array, epsilon: float) -> PackedVector2Array

Returns a simplified version of path with less critical path points removed. The simplification amount is in worlds units and controlled by epsilon. The simplification uses a variant of Ramer-Douglas-Peucker algorithm for curve point decimation.

Path simplification can be helpful to mitigate various path following issues that can arise with certain agent types and script behaviors. E.g. "steering" agents or avoidance in "open fields".

func source_geometry_parser_create() -> RID

Creates a new source geometry parser. If a Callable is set for the parser with source_geometry_parser_set_callback() the callback will be called for every single node that gets parsed whenever parse_source_geometry_data() is used.

func source_geometry_parser_set_callback(parser: RID, callback: Callable) -> void

Sets the callback Callable for the specific source geometry parser. The Callable will receive a call with the following parameters:

- navigation_mesh - The NavigationPolygon reference used to define the parse settings. Do NOT edit or add directly to the navigation mesh.

- source_geometry_data - The NavigationMeshSourceGeometryData2D reference. Add custom source geometry for navigation mesh baking to this object.

- node - The Node that is parsed.

Inherited from Object (62)
func _get(property: StringName) -> Variant
func _get_property_list() -> Dictionary[]
func _init() -> void
func _iter_get(iter: Variant) -> Variant
func _iter_init(iter: Array) -> bool
func _iter_next(iter: Array) -> bool
func _notification(what: int) -> void
func _set(property: StringName, value: Variant) -> bool
func _to_string() -> String
func _validate_property(property: Dictionary) -> void
func add_user_signal(signal: String, arguments: Array = []) -> void
func call(method: StringName) -> Variant
func callv(method: StringName, arg_array: Array) -> Variant
func cancel_free() -> void
func connect(signal: StringName, callable: Callable, flags: int = 0) -> Error
func disconnect(signal: StringName, callable: Callable) -> void
func emit_signal(signal: StringName) -> Error
func free() -> void
func get(property: StringName) -> Variant
func get_class() -> String
func get_incoming_connections() -> Dictionary[]
func get_indexed(property_path: NodePath) -> Variant
func get_meta(name: StringName, default: Variant = null) -> Variant
func get_meta_list() -> StringName[]
func get_method_list() -> Dictionary[]
func get_property_list() -> Dictionary[]
func get_signal_connection_list(signal: StringName) -> Dictionary[]
func get_signal_list() -> Dictionary[]
func has_meta(name: StringName) -> bool
func has_method(method: StringName) -> bool
func has_signal(signal: StringName) -> bool
func is_class(class: StringName) -> bool
func is_connected(signal: StringName, callable: Callable) -> bool
func notification(what: int, reversed: bool = false) -> void
func remove_meta(name: StringName) -> void
func remove_user_signal(signal: StringName) -> void
func set(property: StringName, value: Variant) -> void
func set_block_signals(enable: bool) -> void
func set_deferred(property: StringName, value: Variant) -> void
func set_indexed(property_path: NodePath, value: Variant) -> void
func set_message_translation(enable: bool) -> void
func set_meta(name: StringName, value: Variant) -> void
func set_script(script: Variant) -> void
func set_translation_domain(domain: StringName) -> void
func to_string() -> String
func tr(message: StringName, context: StringName = &"") -> String
func tr_n(message: StringName, plural_message: StringName, n: int, context: StringName = &"") -> String

Signals

signal avoidance_debug_changed()

Emitted when avoidance debug settings are changed. Only available in debug builds.

signal map_changed(map: RID)

Emitted when a navigation map is updated, when a region moves or is modified.

signal navigation_debug_changed()

Emitted when navigation debug settings are changed. Only available in debug builds.

Inherited from Object (2)

Enums & Constants

enum ProcessInfo
INFO_ACTIVE_MAPS = 0

Constant to get the number of active navigation maps.

INFO_REGION_COUNT = 1

Constant to get the number of active navigation regions.

INFO_AGENT_COUNT = 2

Constant to get the number of active navigation agents processing avoidance.

INFO_LINK_COUNT = 3

Constant to get the number of active navigation links.

INFO_POLYGON_COUNT = 4

Constant to get the number of navigation mesh polygons.

INFO_EDGE_COUNT = 5

Constant to get the number of navigation mesh polygon edges.

INFO_EDGE_MERGE_COUNT = 6

Constant to get the number of navigation mesh polygon edges that were merged due to edge key overlap.

INFO_EDGE_CONNECTION_COUNT = 7

Constant to get the number of navigation mesh polygon edges that are considered connected by edge proximity.

INFO_EDGE_FREE_COUNT = 8

Constant to get the number of navigation mesh polygon edges that could not be merged but may be still connected by edge proximity or with links.

INFO_OBSTACLE_COUNT = 9

Constant to get the number of active navigation obstacles.