A server interface for low-level 3D navigation access. NavigationServer3D is the server that handles navigation maps, regions and agents. It does not handle A* navigation from [AStar3D]. 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 [NavigationServer3D] 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 [code]edge_connection_margin[/code] to the respective other edge's vertex. You may assign navigation layers to regions with [method NavigationServer3D.region_set_navigation_layers], which then can be checked upon when requesting a path with [method NavigationServer3D.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. [b]Note:[/b] 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. https://godotengine.org/asset-library/asset/124 $DOCS_URL/tutorials/navigation/navigation_using_navigationservers.html Creates the agent. Returns [code]true[/code] if the provided [param agent] has avoidance enabled. Returns the [code]avoidance_layers[/code] bitmask of the specified [param agent]. Returns the [code]avoidance_mask[/code] bitmask of the specified [param agent]. Returns the [code]avoidance_priority[/code] of the specified [param agent]. Returns the [code]height[/code] of the specified [param agent]. Returns the navigation map [RID] the requested [param agent] is currently assigned to. Returns the maximum number of other agents the specified [param agent] takes into account in the navigation. Returns the maximum speed of the specified [param agent]. Returns the maximum distance to other agents the specified [param agent] takes into account in the navigation. Returns [code]true[/code] if the specified [param agent] is paused. Returns the position of the specified [param agent] in world space. Returns the radius of the specified [param agent]. Returns the minimal amount of time for which the specified [param agent]'s velocities that are computed by the simulation are safe with respect to other agents. Returns the minimal amount of time for which the specified [param agent]'s velocities that are computed by the simulation are safe with respect to static avoidance obstacles. Returns [code]true[/code] if the provided [param agent] uses avoidance in 3D space Vector3(x,y,z) instead of horizontal 2D Vector2(x,y) / Vector3(x,0.0,z). Returns the velocity of the specified [param agent]. Return [code]true[/code] if the specified [param agent] has an avoidance callback. Returns true if the map got changed the previous frame. Sets the callback [Callable] that gets called after each avoidance processing step for the [param agent]. The calculated [code]safe_velocity[/code] will be dispatched with a signal to the object just before the physics calculations. [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_avoidance_callback] again with an empty [Callable]. If [param enabled] is [code]true[/code], the provided [param agent] calculates avoidance. Set the agent's [code]avoidance_layers[/code] bitmask. Set the agent's [code]avoidance_mask[/code] bitmask. Set the agent's [code]avoidance_priority[/code] with a [param priority] between 0.0 (lowest priority) to 1.0 (highest priority). The specified [param agent] does not adjust the velocity for other agents that would match the [code]avoidance_mask[/code] but have a lower [code] avoidance_priority[/code]. This in turn makes the other agents with lower priority adjust their velocities even more to avoid collision with this agent. Updates the provided [param agent] [param height]. 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. If [param paused] is true the specified [param agent] will not be processed, e.g. calculate avoidance velocities or receive avoidance callbacks. Sets the position of the agent in world space. Sets the radius of the agent. 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. 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. Sets if the agent uses the 2D avoidance or the 3D avoidance while avoidance is enabled. If [code]true[/code] the agent calculates avoidance velocities in 3D for the xyz-axis, e.g. for games that take place in air, underwater or space. The 3D using agent only avoids other 3D avoidance using agent's. The 3D using agent only reacts to radius based avoidance obstacles. The 3D using agent ignores any vertices based obstacles. The 3D using agent only avoids other 3D using agent's. If [code]false[/code] the agent calculates avoidance velocities in 2D along the xz-axis ignoring the y-axis. The 2D using agent only avoids other 2D avoidance using agent's. The 2D using agent reacts to radius avoidance obstacles. The 2D using agent reacts to vertices based avoidance obstacles. The 2D using agent only avoids other 2D using agent's. 2D using agents will ignore other 2D using agents or obstacles that are below their current position or above their current position including the agents height in 2D avoidance. Sets [param velocity] as the new wanted velocity for the specified [param 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 use [method agent_set_velocity_forced] as well to reset the internal simulation velocity. Replaces the internal velocity in the collision avoidance simulation with [param velocity] for the specified [param agent]. When an agent is teleported to a new position this function should be used in the same frame. If called frequently this function can get agents stuck. Bakes the provided [param navigation_mesh] with the data from the provided [param source_geometry_data]. After the process is finished the optional [param callback] will be called. Bakes the provided [param navigation_mesh] with the data from the provided [param source_geometry_data] as an async task running on a background thread. After the process is finished the optional [param callback] will be called. Destroys the given RID. Returns [code]true[/code] when the NavigationServer has debug enabled. 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. Returns information about the current state of the NavigationServer. See [enum ProcessInfo] for a list of available states. Returns [code]true[/code] when the provided navigation mesh is being baked on a background thread. Create a new link between two positions on a map. Returns [code]true[/code] if the specified [param link] is enabled. Returns the ending position of this [param link]. Returns the enter cost of this [param link]. Returns the navigation map [RID] the requested [param link] is currently assigned to. Returns the navigation layers for this [param link]. Returns the [code]ObjectID[/code] of the object which manages this link. Returns the starting position of this [param link]. Returns the travel cost of this [param link]. Returns whether this [param link] can be travelled in both directions. Sets whether this [param link] can be travelled in both directions. If [param enabled] is [code]true[/code], the specified [param link] will contribute to its current navigation map. Sets the exit position for the [param link]. Sets the [param enter_cost] for this [param link]. Sets the navigation map [RID] for the link. Set the links's navigation layers. This allows selecting links from a path request (when using [method NavigationServer3D.map_get_path]). Set the [code]ObjectID[/code] of the object which manages this link. Sets the entry position for this [param link]. Sets the [param travel_cost] for this [param link]. Create a new map. This function immediately forces synchronization of the specified navigation [param 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 [code]safe_velocity[/code] signals is unaffected 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 [param map]. Returns the map cell height used to rasterize the navigation mesh vertices on the Y axis. Returns the map cell size used to rasterize the navigation mesh vertices on the XZ plane. Returns the point closest to the provided [param to_point] 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 link connection radius of the map. This distance is the maximum range any link will search for navigation mesh polygons to connect to. Returns all navigation link [RID]s that are currently assigned to the requested navigation [param map]. Returns map's internal merge rasterizer cell scale. Returns all navigation obstacle [RID]s that are currently assigned to the requested navigation [param map]. Returns the navigation path to reach the destination from the origin. [param navigation_layers] is a bitmask of all region navigation layers that are allowed to be in the path. Returns a random position picked from all map region polygons with matching [param navigation_layers]. If [param uniformly] is [code]true[/code], all map regions, polygons, and faces are weighted by their surface area (slower). If [param uniformly] is [code]false[/code], just a random region and a random polygon are picked (faster). Returns all navigation regions [RID]s that are currently assigned to the requested navigation [param map]. Returns the map's up direction. Returns true if the navigation [param map] allows navigation regions to use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin. Returns true if the map is active. Sets the map active. Sets the map cell height used to rasterize the navigation mesh vertices on the Y axis. Must match with the cell height of the used navigation meshes. Sets the map cell size used to rasterize the navigation mesh vertices on the XZ plane. Must match with the cell size of the used navigation meshes. Set the map edge connection margin used to weld the compatible region edges. Set the map's link connection radius used to connect links to navigation polygons. Set the map's internal merge rasterizer cell scale used to control merging sensitivity. Sets the map up direction. Set the navigation [param map] edge connection use. If [param enabled] is [code]true[/code], 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. Creates a new obstacle. Returns [code]true[/code] if the provided [param obstacle] has avoidance enabled. Returns the [code]avoidance_layers[/code] bitmask of the specified [param obstacle]. Returns the [code]height[/code] of the specified [param obstacle]. Returns the navigation map [RID] the requested [param obstacle] is currently assigned to. Returns [code]true[/code] if the specified [param obstacle] is paused. Returns the position of the specified [param obstacle] in world space. Returns the radius of the specified dynamic [param obstacle]. Returns [code]true[/code] if the provided [param obstacle] uses avoidance in 3D space Vector3(x,y,z) instead of horizontal 2D Vector2(x,y) / Vector3(x,0.0,z). Returns the velocity of the specified dynamic [param obstacle]. Returns the outline vertices for the specified [param obstacle]. If [param enabled] is [code]true[/code], the provided [param obstacle] affects avoidance using agents. Set the obstacles's [code]avoidance_layers[/code] bitmask. Sets the [param height] for the [param obstacle]. In 3D agents will ignore obstacles that are above or below them while using 2D avoidance. Assigns the [param obstacle] to a navigation map. If [param paused] is true the specified [param obstacle] will not be processed, e.g. affect avoidance velocities. Updates the [param position] in world space for the [param obstacle]. Sets the radius of the dynamic obstacle. Sets if the [param obstacle] uses the 2D avoidance or the 3D avoidance while avoidance is enabled. Sets [param velocity] of the dynamic [param obstacle]. Allows other agents to better predict the movement of the dynamic obstacle. Only works in combination with the radius of the obstacle. 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. Parses the [SceneTree] for source geometry according to the properties of [param navigation_mesh]. Updates the provided [param source_geometry_data] resource with the resulting data. The resource can then be used to bake a navigation mesh with [method bake_from_source_geometry_data]. After the process is finished the optional [param callback] will be called. [b]Note:[/b] This function needs to run on the main thread or with a deferred call as the SceneTree is not thread-safe. [b]Performance:[/b] 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. Queries a path in a given navigation map. Start and target position and other parameters are defined through [NavigationPathQueryParameters3D]. Updates the provided [NavigationPathQueryResult3D] result object with the path among other results requested by the query. Bakes the [param navigation_mesh] with bake source geometry collected starting from the [param root_node]. [i]Deprecated.[/i] To upgrade existing code, first create a [NavigationMeshSourceGeometryData3D] resource. Use this resource with [method parse_source_geometry_data] to parse the SceneTree for nodes that should contribute to the navigation mesh baking. The SceneTree parsing needs to happen on the main thread. After the parsing is finished use the resource with [method bake_from_source_geometry_data] to bake a navigation mesh. Creates a new region. Returns the ending point of a connection door. [param connection] is an index between 0 and the return value of [method region_get_connections_count]. Returns the starting point of a connection door. [param connection] is an index between 0 and the return value of [method region_get_connections_count]. Returns how many connections this [param region] has with other regions in the map. Returns [code]true[/code] if the specified [param region] is enabled. Returns the enter cost of this [param region]. Returns the navigation map [RID] the requested [param region] is currently assigned to. Returns the region's navigation layers. Returns the [code]ObjectID[/code] of the object which manages this region. Returns a random position picked from all region polygons with matching [param navigation_layers]. If [param uniformly] is [code]true[/code], all region polygons and faces are weighted by their surface area (slower). If [param uniformly] is [code]false[/code], just a random polygon and face is picked (faster). Returns the global transformation of this [param region]. Returns the travel cost of this [param region]. Returns true if the navigation [param region] is set to use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin. Returns [code]true[/code] if the provided [param point] in world space is currently owned by the provided navigation [param 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. [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. If [param enabled] is [code]true[/code], the specified [param region] will contribute to its current navigation map. Sets the [param enter_cost] for this [param region]. Sets the map for the region. Set the region's navigation layers. This allows selecting regions from a path request (when using [method NavigationServer3D.map_get_path]). Sets the navigation mesh for the region. Set the [code]ObjectID[/code] of the object which manages this region. Sets the global transformation for the region. Sets the [param travel_cost] for this [param region]. If [param enabled] is [code]true[/code], the navigation [param region] will use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin. Control activation of this server. If [code]true[/code] enables debug mode on the NavigationServer. Emitted when avoidance debug settings are changed. Only available in debug builds. Emitted when a navigation map is updated, when a region moves or is modified. Emitted when navigation debug settings are changed. Only available in debug builds. Constant to get the number of active navigation maps. Constant to get the number of active navigation regions. Constant to get the number of active navigation agents processing avoidance. Constant to get the number of active navigation links. Constant to get the number of navigation mesh polygons. Constant to get the number of navigation mesh polygon edges. Constant to get the number of navigation mesh polygon edges that were merged due to edge key overlap. Constant to get the number of navigation mesh polygon edges that are considered connected by edge proximity. 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.