Server interface for low-level 2D navigation access.
Navigation2DServer is the server responsible for all 2D navigation. It handles several objects, namely maps, regions and agents. Maps are made up of regions, which are made of navigation polygons. Together, they define the navigable areas in the 2D world. [b]Note:[/b] Most NavigationServer 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 SceneTree 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 navigation map [code]edge_connection_margin[/code] to the respective other edge's vertex. You may assign navigation layers to regions with [method Navigation2DServer.region_set_navigation_layers], which then can be checked upon when requesting a path with [method Navigation2DServer.map_get_path]. This allows allowing or forbidding some areas to 2D 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. [b]Note:[/b] The collision avoidance system ignores regions. Using the modified velocity as-is might lead to pushing and agent outside of a navigable 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.
https://godotengine.org/asset-library/asset/117
Creates the agent.
Returns the navigation map [RID] the requested [code]agent[/code] is currently assigned to.
Returns [code]true[/code] if the map got changed the previous frame.
Callback called at the end of the RVO process. If a callback is created manually and the agent is placed on a navigation map it will calculate avoidance for the agent and dispatch the calculated [code]safe_velocity[/code] to the [code]receiver[/code] object with a signal to the chosen [code]method[/code] name. [b]Note:[/b] 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 [method agent_set_callback] again with a [code]null[/code] object as the [code]receiver[/code].
Puts the agent in the map.
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.
Sets the maximum speed of the agent. Must be positive.
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.
Sets the position of the agent in world space.
Sets the radius of the agent.
Sets the new target velocity.
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. Must be positive.
Sets the current velocity of the agent.
Destroys the given RID.
Create a new map.
Returns all navigation agents [RID]s that are currently assigned to the requested navigation [code]map[/code].
Returns the map cell height. [b]Note:[/b] Currently not implemented.
Returns the map cell size.
Returns the point closest to the provided [code]to_point[/code] on the navigation mesh surface.
Returns the owner region RID for the point returned by [method map_get_closest_point].
Returns the edge connection margin of the map. The edge connection margin is a distance used to connect two regions.
Returns the navigation path to reach the destination from the origin. [code]navigation_layers[/code] is a bitmask of all region layers that are allowed to be in the path.
Returns all navigation regions [RID]s that are currently assigned to the requested navigation [code]map[/code].
Returns [code]true[/code] if the map is active.
Sets the map active.
Set the map cell height used to weld the navigation mesh polygons. [b]Note:[/b] Currently not implemented.
Set the map cell size used to weld the navigation mesh polygons.
Set the map edge connection margin used to weld the compatible region edges.
Creates a new region.
Returns the ending point of a connection door. [code]connection[/code] is an index between 0 and the return value of [method region_get_connections_count].
Returns the starting point of a connection door. [code]connection[/code] is an index between 0 and the return value of [method region_get_connections_count].
Returns how many connections this [code]region[/code] has with other regions in the map.
Returns the [code]enter_cost[/code] of this [code]region[/code].
Returns the navigation map [RID] the requested [code]region[/code] is currently assigned to.
Returns the region's navigation layers.
Returns the [code]travel_cost[/code] of this [code]region[/code].
Sets the [code]enter_cost[/code] for this [code]region[/code].
Sets the map for the region.
Set the region's navigation layers. This allows selecting regions from a path request (when using [method Navigation2DServer.map_get_path]).
Sets the navigation mesh for the region.
Sets the global transformation for the region.
Sets the [code]travel_cost[/code] for this [code]region[/code].
Emitted when a navigation map is updated, when a region moves or is modified.