Server interface for low-level 3D navigation access.
NavigationServer is the server responsible for all 3D navigation. It handles several objects, namely maps, regions and agents. Maps are made up of regions, which are made of navigation meshes. Together, they define the navigable areas in the 3D 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 [member Navigation.edge_connection_margin] to the respective other edge's vertex. 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. [b]Note:[/b] By default, the expensive calculations for avoidance are done in a thread. In HTML5 exports without thread support, they will be done on the main thread, which can lead to performance issues. 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/124
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.
Returns all created navigation map [RID]s on the NavigationServer. This returns both 2D and 3D created navigation maps as there is technically no distinction between them.
Create a new map.
This function immediately forces synchronization of the specified navigation [code]map[/code] [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 [code]safe_velocity[/code] signals is untouched by this function and continues to happen for all maps and agents at the end of the physics frame. [b]Note:[/b] 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.
Returns all navigation agents [RID]s that are currently assigned to the requested navigation [code]map[/code].
Returns the map cell height.
Returns the map cell size.
Returns the point closest to the provided [code]to_point[/code] on the navigation mesh surface.
Returns the normal for the point returned by [method map_get_closest_point].
Returns the owner region RID for the point returned by [method map_get_closest_point].
Returns the closest point between the navigation surface and the segment.
Returns the edge connection margin of the map. This distance is the minimum vertex distance needed to connect two edges from different 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 the map's up direction.
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.
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.
Sets the map up direction.
Process the collision avoidance agents. The result of this process is needed by the physics server, so this must be called in the main thread. [b]Note:[/b] This function is not thread safe.
Bakes the navigation mesh.
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].
Returns [code]true[/code] if the provided [code]point[/code] in world space is currently owned by the provided navigation [code]region[/code]. 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. [b]Note:[/b] If navigation meshes from different navigation regions overlap (which should be avoided in general) the result might not be what is expected.
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 NavigationServer.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].
Control activation of this server.
Emitted when a navigation map is updated, when a region moves or is modified.