godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/NavigationServer3D.xml

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

635 lines
27 KiB
XML
Raw Normal View History

Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
Bump version to 4.1-dev Can't stop, won't stop, they said, huh?
2023-03-01 00:44:37 +00:00
<class name="NavigationServer3D" inherits="Object" is_experimental="true" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
<brief_description>
Add missing period for sentences in classref
2023-02-11 16:18:33 +00:00
Server interface for low-level 3D navigation access.
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
</brief_description>
<description>
Implement Navigation layers
2021-03-08 19:56:33 +00:00
NavigationServer3D is the server responsible for all 3D navigation. It handles several objects, namely maps, regions and agents.
Add class doc that NavigationServer changes are not instant Add class doc that NavigationServer changes are not instant.
2022-06-01 05:49:08 +00:00
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 [code]edge_connection_margin[/code] to the respective other edge's vertex.
Streamline Navigation layer function names. Streamline Navigation layer function names.
2022-06-14 21:34:43 +00:00
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 allows allowing or forbidding some areas to 3D objects.
Implement Navigation layers
2021-03-08 19:56:33 +00:00
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.
doc: Fix style inconsistencies for `[b]Note:[/b]` paragraphs And fix up formatting not supported by makerst.
2021-10-05 12:24:34 +00:00
[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.
Implement Navigation layers
2021-03-08 19:56:33 +00:00
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.
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
</description>
<tutorials>
Link to demos from within the class reference
2020-10-01 08:34:47 +00:00
<link title="3D Navmesh Demo">https://godotengine.org/asset-library/asset/124</link>
Add navigation tutorial links inside class doc Adds navigation tutorial links inside the class doc to the related and more detailed godot-docs pages.
2023-01-11 05:05:04 +00:00
<link title="Using NavigationServer">$DOCS_URL/tutorials/navigation/navigation_using_navigationservers.html</link>
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
</tutorials>
<methods>
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
<method name="agent_create">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="RID" />
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
<description>
Creates the agent.
</description>
</method>
Add NavigationServer2D/3D API functions to find missing RID info Utility functions for NavigationServer2D/3D to find missing RID information when working with Server API directly. e.g. from map to regions and agents, from agent or region to map, from region to map and agents and so on .... Requirement to work with NavigationServer API exklusive without SceneTree nodes and when juggling agents and regions between multiple navigation maps.
2022-05-12 00:52:48 +00:00
<method name="agent_get_map" qualifiers="const">
<return type="RID" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="agent" type="RID" />
Add NavigationServer2D/3D API functions to find missing RID info Utility functions for NavigationServer2D/3D to find missing RID information when working with Server API directly. e.g. from map to regions and agents, from agent or region to map, from region to map and agents and so on .... Requirement to work with NavigationServer API exklusive without SceneTree nodes and when juggling agents and regions between multiple navigation maps.
2022-05-12 00:52:48 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters (5)
2022-08-12 13:36:48 +00:00
Returns the navigation map [RID] the requested [param agent] is currently assigned to.
Add NavigationServer2D/3D API functions to find missing RID info Utility functions for NavigationServer2D/3D to find missing RID information when working with Server API directly. e.g. from map to regions and agents, from agent or region to map, from region to map and agents and so on .... Requirement to work with NavigationServer API exklusive without SceneTree nodes and when juggling agents and regions between multiple navigation maps.
2022-05-12 00:52:48 +00:00
</description>
</method>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 08:59:06 +00:00
<method name="agent_is_map_changed" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="agent" type="RID" />
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
<description>
Returns true if the map got changed the previous frame.
</description>
</method>
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
<method name="agent_set_callback">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="agent" type="RID" />
Use Callable for Navigation Agent callbacks
2023-01-28 04:15:10 +00:00
<param index="1" name="callback" type="Callable" />
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
<description>
Use Callable for Navigation Agent callbacks
2023-01-28 04:15:10 +00:00
Sets the callback that gets called after each avoidance processing step for the [param agent]. The calculated [code]safe_velocity[/code] will be passed as the first parameter 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_callback] again with an empty [Callable].
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
</description>
</method>
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
<method name="agent_set_map">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="agent" type="RID" />
<param index="1" name="map" type="RID" />
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
<description>
Puts the agent in the map.
</description>
</method>
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
<method name="agent_set_max_neighbors">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="agent" type="RID" />
<param index="1" name="count" type="int" />
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
<description>
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.
</description>
</method>
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
<method name="agent_set_max_speed">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="agent" type="RID" />
<param index="1" name="max_speed" type="float" />
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
<description>
Sets the maximum speed of the agent. Must be positive.
</description>
</method>
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
<method name="agent_set_neighbor_distance">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="agent" type="RID" />
Rename Navigation's `neighbor_dist` to `neightbor_distance` NavigationAgent2D/3D.`neighbor_dist` -> `neighbor_distance` (also affects setters and getters) NavigationServer2D/3D.`agent_set_neighbor_dist()` -> `agent_set_neighbor_distance()` Also changes their parameters' names. Doesn't affect "Agent.neighborDist_" in Agent.h
2022-08-13 10:26:13 +00:00
<param index="1" name="distance" type="float" />
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
<description>
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.
</description>
</method>
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
<method name="agent_set_position">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="agent" type="RID" />
<param index="1" name="position" type="Vector3" />
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
<description>
Sets the position of the agent in world space.
</description>
</method>
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
<method name="agent_set_radius">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="agent" type="RID" />
<param index="1" name="radius" type="float" />
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
<description>
Sets the radius of the agent.
</description>
</method>
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
<method name="agent_set_target_velocity">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="agent" type="RID" />
<param index="1" name="target_velocity" type="Vector3" />
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
<description>
Sets the new target velocity.
</description>
</method>
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
<method name="agent_set_time_horizon">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="agent" type="RID" />
<param index="1" name="time" type="float" />
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
<description>
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.
</description>
</method>
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
<method name="agent_set_velocity">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="agent" type="RID" />
<param index="1" name="velocity" type="Vector3" />
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
<description>
Sets the current velocity of the agent.
</description>
</method>
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
<method name="free_rid">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="rid" type="RID" />
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
<description>
Rename NavigationServer's free method to free_rid
2022-04-08 09:39:17 +00:00
Destroys the given RID.
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
</description>
</method>
Fix navigation debug not toggleable in scripts Fixes that navigation debug was not toggleable in script while even the docs mentioned it.
2023-02-13 11:17:24 +00:00
<method name="get_debug_enabled" qualifiers="const">
<return type="bool" />
<description>
Returns [code]true[/code] when the NavigationServer has debug enabled.
</description>
</method>
Add Navigation function to get all navigation maps Added new function that returns all created navigation map RIDs from the NavigationServer. The function returns both 2D and 3D created navigation maps as technically there is no distinction between them.
2022-06-22 13:33:40 +00:00
<method name="get_maps" qualifiers="const">
Replace Array return types with TypedArray 2
2022-08-05 18:35:08 +00:00
<return type="RID[]" />
Add Navigation function to get all navigation maps Added new function that returns all created navigation map RIDs from the NavigationServer. The function returns both 2D and 3D created navigation maps as technically there is no distinction between them.
2022-06-22 13:33:40 +00:00
<description>
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.
</description>
</method>
Add NavigationServer Performance Monitor Adds Performance Monitor for NavigationServer3D.
2022-12-30 04:19:15 +00:00
<method name="get_process_info" qualifiers="const">
<return type="int" />
<param index="0" name="process_info" type="int" enum="NavigationServer3D.ProcessInfo" />
<description>
Returns information about the current state of the NavigationServer. See [enum ProcessInfo] for a list of available states.
</description>
</method>
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
<method name="link_create">
Added node for Navigation links
2022-01-30 23:39:52 +00:00
<return type="RID" />
<description>
Rename Navigation uses of 'location' to 'position' Contrary to the entire rest of the engine NavigationAgent's and NavigationLinks decided to deal with locations instead of positions.
2022-12-06 22:32:11 +00:00
Create a new link between two positions on a map.
Added node for Navigation links
2022-01-30 23:39:52 +00:00
</description>
</method>
Rename Navigation uses of 'location' to 'position' Contrary to the entire rest of the engine NavigationAgent's and NavigationLinks decided to deal with locations instead of positions.
2022-12-06 22:32:11 +00:00
<method name="link_get_end_position" qualifiers="const">
Added node for Navigation links
2022-01-30 23:39:52 +00:00
<return type="Vector3" />
<param index="0" name="link" type="RID" />
<description>
Rename Navigation uses of 'location' to 'position' Contrary to the entire rest of the engine NavigationAgent's and NavigationLinks decided to deal with locations instead of positions.
2022-12-06 22:32:11 +00:00
Returns the ending position of this [code]link[/code].
Added node for Navigation links
2022-01-30 23:39:52 +00:00
</description>
</method>
<method name="link_get_enter_cost" qualifiers="const">
<return type="float" />
<param index="0" name="link" type="RID" />
<description>
More class reference fixes Mostly typos. Also renamed the remaining "Vulkan Clustered" to "Forward+".
2023-02-24 02:42:07 +00:00
Returns the enter cost of this [param link].
Added node for Navigation links
2022-01-30 23:39:52 +00:00
</description>
</method>
<method name="link_get_map" qualifiers="const">
<return type="RID" />
<param index="0" name="link" type="RID" />
<description>
Returns the navigation map [RID] the requested [code]link[/code] is currently assigned to.
</description>
</method>
<method name="link_get_navigation_layers" qualifiers="const">
<return type="int" />
<param index="0" name="link" type="RID" />
<description>
Returns the navigation layers for this [code]link[/code].
</description>
</method>
Enable assigning an owner to navigation regions and links This allows users of the server APIs to get back the nodes that created certain regions and links.
2022-10-01 05:49:39 +00:00
<method name="link_get_owner_id" qualifiers="const">
<return type="int" />
<param index="0" name="link" type="RID" />
<description>
Returns the [code]ObjectID[/code] of the object which manages this link.
</description>
</method>
Rename Navigation uses of 'location' to 'position' Contrary to the entire rest of the engine NavigationAgent's and NavigationLinks decided to deal with locations instead of positions.
2022-12-06 22:32:11 +00:00
<method name="link_get_start_position" qualifiers="const">
Added node for Navigation links
2022-01-30 23:39:52 +00:00
<return type="Vector3" />
<param index="0" name="link" type="RID" />
<description>
Rename Navigation uses of 'location' to 'position' Contrary to the entire rest of the engine NavigationAgent's and NavigationLinks decided to deal with locations instead of positions.
2022-12-06 22:32:11 +00:00
Returns the starting position of this [code]link[/code].
Added node for Navigation links
2022-01-30 23:39:52 +00:00
</description>
</method>
<method name="link_get_travel_cost" qualifiers="const">
<return type="float" />
<param index="0" name="link" type="RID" />
<description>
More class reference fixes Mostly typos. Also renamed the remaining "Vulkan Clustered" to "Forward+".
2023-02-24 02:42:07 +00:00
Returns the travel cost of this [param link].
Added node for Navigation links
2022-01-30 23:39:52 +00:00
</description>
</method>
<method name="link_is_bidirectional" qualifiers="const">
<return type="bool" />
<param index="0" name="link" type="RID" />
<description>
Returns whether this [code]link[/code] can be travelled in both directions.
</description>
</method>
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
<method name="link_set_bidirectional">
Added node for Navigation links
2022-01-30 23:39:52 +00:00
<return type="void" />
<param index="0" name="link" type="RID" />
<param index="1" name="bidirectional" type="bool" />
<description>
Sets whether this [code]link[/code] can be travelled in both directions.
</description>
</method>
Rename Navigation uses of 'location' to 'position' Contrary to the entire rest of the engine NavigationAgent's and NavigationLinks decided to deal with locations instead of positions.
2022-12-06 22:32:11 +00:00
<method name="link_set_end_position">
Added node for Navigation links
2022-01-30 23:39:52 +00:00
<return type="void" />
<param index="0" name="link" type="RID" />
Rename Navigation uses of 'location' to 'position' Contrary to the entire rest of the engine NavigationAgent's and NavigationLinks decided to deal with locations instead of positions.
2022-12-06 22:32:11 +00:00
<param index="1" name="position" type="Vector3" />
Added node for Navigation links
2022-01-30 23:39:52 +00:00
<description>
Rename Navigation uses of 'location' to 'position' Contrary to the entire rest of the engine NavigationAgent's and NavigationLinks decided to deal with locations instead of positions.
2022-12-06 22:32:11 +00:00
Sets the exit position for the [code]link[/code].
Added node for Navigation links
2022-01-30 23:39:52 +00:00
</description>
</method>
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
<method name="link_set_enter_cost">
Added node for Navigation links
2022-01-30 23:39:52 +00:00
<return type="void" />
<param index="0" name="link" type="RID" />
<param index="1" name="enter_cost" type="float" />
<description>
Sets the [code]enter_cost[/code] for this [code]link[/code].
</description>
</method>
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
<method name="link_set_map">
Added node for Navigation links
2022-01-30 23:39:52 +00:00
<return type="void" />
<param index="0" name="link" type="RID" />
<param index="1" name="map" type="RID" />
<description>
Sets the navigation map [RID] for the link.
</description>
</method>
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
<method name="link_set_navigation_layers">
Added node for Navigation links
2022-01-30 23:39:52 +00:00
<return type="void" />
<param index="0" name="link" type="RID" />
<param index="1" name="navigation_layers" type="int" />
<description>
Set the links's navigation layers. This allows selecting links from a path request (when using [method NavigationServer3D.map_get_path]).
</description>
</method>
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
<method name="link_set_owner_id">
Enable assigning an owner to navigation regions and links This allows users of the server APIs to get back the nodes that created certain regions and links.
2022-10-01 05:49:39 +00:00
<return type="void" />
<param index="0" name="link" type="RID" />
<param index="1" name="owner_id" type="int" />
<description>
Set the [code]ObjectID[/code] of the object which manages this link.
</description>
</method>
Rename Navigation uses of 'location' to 'position' Contrary to the entire rest of the engine NavigationAgent's and NavigationLinks decided to deal with locations instead of positions.
2022-12-06 22:32:11 +00:00
<method name="link_set_start_position">
Added node for Navigation links
2022-01-30 23:39:52 +00:00
<return type="void" />
<param index="0" name="link" type="RID" />
Rename Navigation uses of 'location' to 'position' Contrary to the entire rest of the engine NavigationAgent's and NavigationLinks decided to deal with locations instead of positions.
2022-12-06 22:32:11 +00:00
<param index="1" name="position" type="Vector3" />
Added node for Navigation links
2022-01-30 23:39:52 +00:00
<description>
Rename Navigation uses of 'location' to 'position' Contrary to the entire rest of the engine NavigationAgent's and NavigationLinks decided to deal with locations instead of positions.
2022-12-06 22:32:11 +00:00
Sets the entry position for this [code]link[/code].
Added node for Navigation links
2022-01-30 23:39:52 +00:00
</description>
</method>
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
<method name="link_set_travel_cost">
Added node for Navigation links
2022-01-30 23:39:52 +00:00
<return type="void" />
<param index="0" name="link" type="RID" />
<param index="1" name="travel_cost" type="float" />
<description>
Sets the [code]travel_cost[/code] for this [code]link[/code].
</description>
</method>
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
<method name="map_create">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="RID" />
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
<description>
Create a new map.
</description>
</method>
Add NavigationServer map_force_update() function Adds map_force_update() function to NavigationServer. This function immediately flushes the Navigationserver command queue and recalculates all navigationmeshes and region connections for a specific map.
2022-06-22 08:16:38 +00:00
<method name="map_force_update">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="map" type="RID" />
Add NavigationServer map_force_update() function Adds map_force_update() function to NavigationServer. This function immediately flushes the Navigationserver command queue and recalculates all navigationmeshes and region connections for a specific map.
2022-06-22 08:16:38 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters (5)
2022-08-12 13:36:48 +00:00
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).
Add NavigationServer map_force_update() function Adds map_force_update() function to NavigationServer. This function immediately flushes the Navigationserver command queue and recalculates all navigationmeshes and region connections for a specific map.
2022-06-22 08:16:38 +00:00
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.
</description>
</method>
Add NavigationServer2D/3D API functions to find missing RID info Utility functions for NavigationServer2D/3D to find missing RID information when working with Server API directly. e.g. from map to regions and agents, from agent or region to map, from region to map and agents and so on .... Requirement to work with NavigationServer API exklusive without SceneTree nodes and when juggling agents and regions between multiple navigation maps.
2022-05-12 00:52:48 +00:00
<method name="map_get_agents" qualifiers="const">
Replace Array return types with TypedArray 2
2022-08-05 18:35:08 +00:00
<return type="RID[]" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="map" type="RID" />
Add NavigationServer2D/3D API functions to find missing RID info Utility functions for NavigationServer2D/3D to find missing RID information when working with Server API directly. e.g. from map to regions and agents, from agent or region to map, from region to map and agents and so on .... Requirement to work with NavigationServer API exklusive without SceneTree nodes and when juggling agents and regions between multiple navigation maps.
2022-05-12 00:52:48 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters (5)
2022-08-12 13:36:48 +00:00
Returns all navigation agents [RID]s that are currently assigned to the requested navigation [param map].
Add NavigationServer2D/3D API functions to find missing RID info Utility functions for NavigationServer2D/3D to find missing RID information when working with Server API directly. e.g. from map to regions and agents, from agent or region to map, from region to map and agents and so on .... Requirement to work with NavigationServer API exklusive without SceneTree nodes and when juggling agents and regions between multiple navigation maps.
2022-05-12 00:52:48 +00:00
</description>
</method>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 08:59:06 +00:00
<method name="map_get_cell_size" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="float" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="map" type="RID" />
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
<description>
Returns the map cell size.
</description>
</method>
doc: Sync classref with current source
2020-02-19 08:55:47 +00:00
<method name="map_get_closest_point" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Vector3" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="map" type="RID" />
<param index="1" name="to_point" type="Vector3" />
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters (5)
2022-08-12 13:36:48 +00:00
Returns the point closest to the provided [param to_point] on the navigation mesh surface.
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
</description>
</method>
doc: Sync classref with current source
2020-02-19 08:55:47 +00:00
<method name="map_get_closest_point_normal" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Vector3" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="map" type="RID" />
<param index="1" name="to_point" type="Vector3" />
doc: Sync classref with current source
2020-02-19 08:55:47 +00:00
<description>
Returns the normal for the point returned by [method map_get_closest_point].
</description>
</method>
<method name="map_get_closest_point_owner" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="RID" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="map" type="RID" />
<param index="1" name="to_point" type="Vector3" />
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
<description>
doc: Sync classref with current source
2020-02-19 08:55:47 +00:00
Returns the owner region RID for the point returned by [method map_get_closest_point].
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
</description>
</method>
Added utility functions to the new NavigationServer: - Vector3 get_closest_point_to_segment(const Vector3 &p_from, const Vector3 &p_to, const bool &p_use_collision = false); - Vector3 get_closest_point(const Vector3 &p_point); - Vector3 get_closest_point_normal(const Vector3 &p_point); - Object *get_closest_point_owner(const Vector3 &p_point);
2020-02-18 16:08:34 +00:00
<method name="map_get_closest_point_to_segment" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Vector3" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="map" type="RID" />
<param index="1" name="start" type="Vector3" />
<param index="2" name="end" type="Vector3" />
<param index="3" name="use_collision" type="bool" default="false" />
Added utility functions to the new NavigationServer: - Vector3 get_closest_point_to_segment(const Vector3 &p_from, const Vector3 &p_to, const bool &p_use_collision = false); - Vector3 get_closest_point(const Vector3 &p_point); - Vector3 get_closest_point_normal(const Vector3 &p_point); - Object *get_closest_point_owner(const Vector3 &p_point);
2020-02-18 16:08:34 +00:00
<description>
Returns the closest point between the navigation surface and the segment.
</description>
</method>
doc: Sync classref with current source
2020-02-19 08:55:47 +00:00
<method name="map_get_edge_connection_margin" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="float" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="map" type="RID" />
Added utility functions to the new NavigationServer: - Vector3 get_closest_point_to_segment(const Vector3 &p_from, const Vector3 &p_to, const bool &p_use_collision = false); - Vector3 get_closest_point(const Vector3 &p_point); - Vector3 get_closest_point_normal(const Vector3 &p_point); - Object *get_closest_point_owner(const Vector3 &p_point);
2020-02-18 16:08:34 +00:00
<description>
Implement Navigation layers
2021-03-08 19:56:33 +00:00
Returns the edge connection margin of the map. This distance is the minimum vertex distance needed to connect two edges from different regions.
Added utility functions to the new NavigationServer: - Vector3 get_closest_point_to_segment(const Vector3 &p_from, const Vector3 &p_to, const bool &p_use_collision = false); - Vector3 get_closest_point(const Vector3 &p_point); - Vector3 get_closest_point_normal(const Vector3 &p_point); - Object *get_closest_point_owner(const Vector3 &p_point);
2020-02-18 16:08:34 +00:00
</description>
</method>
Added node for Navigation links
2022-01-30 23:39:52 +00:00
<method name="map_get_link_connection_radius" qualifiers="const">
<return type="float" />
<param index="0" name="map" type="RID" />
<description>
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.
</description>
</method>
<method name="map_get_links" qualifiers="const">
<return type="RID[]" />
<param index="0" name="map" type="RID" />
<description>
Returns all navigation link [RID]s that are currently assigned to the requested navigation [code]map[/code].
</description>
</method>
doc: Sync classref with current source
2020-02-19 08:55:47 +00:00
<method name="map_get_path" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="PackedVector3Array" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="map" type="RID" />
<param index="1" name="origin" type="Vector3" />
<param index="2" name="destination" type="Vector3" />
<param index="3" name="optimize" type="bool" />
<param index="4" name="navigation_layers" type="int" default="1" />
Added utility functions to the new NavigationServer: - Vector3 get_closest_point_to_segment(const Vector3 &p_from, const Vector3 &p_to, const bool &p_use_collision = false); - Vector3 get_closest_point(const Vector3 &p_point); - Vector3 get_closest_point_normal(const Vector3 &p_point); - Object *get_closest_point_owner(const Vector3 &p_point);
2020-02-18 16:08:34 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters (5)
2022-08-12 13:36:48 +00:00
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.
Added utility functions to the new NavigationServer: - Vector3 get_closest_point_to_segment(const Vector3 &p_from, const Vector3 &p_to, const bool &p_use_collision = false); - Vector3 get_closest_point(const Vector3 &p_point); - Vector3 get_closest_point_normal(const Vector3 &p_point); - Object *get_closest_point_owner(const Vector3 &p_point);
2020-02-18 16:08:34 +00:00
</description>
</method>
Add NavigationServer2D/3D API functions to find missing RID info Utility functions for NavigationServer2D/3D to find missing RID information when working with Server API directly. e.g. from map to regions and agents, from agent or region to map, from region to map and agents and so on .... Requirement to work with NavigationServer API exklusive without SceneTree nodes and when juggling agents and regions between multiple navigation maps.
2022-05-12 00:52:48 +00:00
<method name="map_get_regions" qualifiers="const">
Replace Array return types with TypedArray 2
2022-08-05 18:35:08 +00:00
<return type="RID[]" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="map" type="RID" />
Add NavigationServer2D/3D API functions to find missing RID info Utility functions for NavigationServer2D/3D to find missing RID information when working with Server API directly. e.g. from map to regions and agents, from agent or region to map, from region to map and agents and so on .... Requirement to work with NavigationServer API exklusive without SceneTree nodes and when juggling agents and regions between multiple navigation maps.
2022-05-12 00:52:48 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters (5)
2022-08-12 13:36:48 +00:00
Returns all navigation regions [RID]s that are currently assigned to the requested navigation [param map].
Add NavigationServer2D/3D API functions to find missing RID info Utility functions for NavigationServer2D/3D to find missing RID information when working with Server API directly. e.g. from map to regions and agents, from agent or region to map, from region to map and agents and so on .... Requirement to work with NavigationServer API exklusive without SceneTree nodes and when juggling agents and regions between multiple navigation maps.
2022-05-12 00:52:48 +00:00
</description>
</method>
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
<method name="map_get_up" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Vector3" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="map" type="RID" />
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
<description>
Returns the map's up direction.
</description>
</method>
<method name="map_is_active" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
Fix a typo in navigation server documentation
2022-08-17 14:05:46 +00:00
<param index="0" name="map" type="RID" />
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
<description>
Returns true if the map is active.
</description>
</method>
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
<method name="map_set_active">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="map" type="RID" />
<param index="1" name="active" type="bool" />
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
<description>
Sets the map active.
</description>
</method>
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
<method name="map_set_cell_size">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="map" type="RID" />
<param index="1" name="cell_size" type="float" />
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
<description>
Set the map cell size used to weld the navigation mesh polygons.
</description>
</method>
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
<method name="map_set_edge_connection_margin">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="map" type="RID" />
<param index="1" name="margin" type="float" />
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
<description>
Implement Navigation layers
2021-03-08 19:56:33 +00:00
Set the map edge connection margin used to weld the compatible region edges.
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
</description>
</method>
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
<method name="map_set_link_connection_radius">
Added node for Navigation links
2022-01-30 23:39:52 +00:00
<return type="void" />
<param index="0" name="map" type="RID" />
<param index="1" name="radius" type="float" />
<description>
Set the map's link connection radius used to connect links to navigation polygons.
</description>
</method>
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
<method name="map_set_up">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="map" type="RID" />
<param index="1" name="up" type="Vector3" />
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
<description>
Sets the map up direction.
</description>
</method>
Add NavigationPathQuery Adds NavigationPathQueryParameters objects that can be used with NavigationServer.query_path() to query a customized navigation path.
2022-06-26 10:43:01 +00:00
<method name="query_path" qualifiers="const">
<return type="void" />
<param index="0" name="parameters" type="NavigationPathQueryParameters3D" />
<param index="1" name="result" type="NavigationPathQueryResult3D" />
<description>
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.
</description>
</method>
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
<method name="region_bake_navigation_mesh">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Fix Navigation API abbreviations inconsistency Schema for navigation to name user facing API with "navigation" without abbreviation and e.g. NavigationServer internals with abbr "nav".
2022-12-11 17:02:35 +00:00
<param index="0" name="navigation_mesh" type="NavigationMesh" />
<param index="1" name="root_node" type="Node" />
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
<description>
Fix Navigation API abbreviations inconsistency Schema for navigation to name user facing API with "navigation" without abbreviation and e.g. NavigationServer internals with abbr "nav".
2022-12-11 17:02:35 +00:00
Bakes the [param navigation_mesh] with bake source geometry collected starting from the [param root_node].
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
</description>
</method>
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
<method name="region_create">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="RID" />
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
<description>
Creates a new region.
</description>
</method>
Allow Navigation to be more flexible
2021-03-15 11:45:28 +00:00
<method name="region_get_connection_pathway_end" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Vector3" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="region" type="RID" />
<param index="1" name="connection" type="int" />
Allow Navigation to be more flexible
2021-03-15 11:45:28 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters (5)
2022-08-12 13:36:48 +00:00
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].
Allow Navigation to be more flexible
2021-03-15 11:45:28 +00:00
</description>
</method>
<method name="region_get_connection_pathway_start" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Vector3" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="region" type="RID" />
<param index="1" name="connection" type="int" />
Allow Navigation to be more flexible
2021-03-15 11:45:28 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters (5)
2022-08-12 13:36:48 +00:00
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].
Allow Navigation to be more flexible
2021-03-15 11:45:28 +00:00
</description>
</method>
<method name="region_get_connections_count" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="region" type="RID" />
Allow Navigation to be more flexible
2021-03-15 11:45:28 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters (5)
2022-08-12 13:36:48 +00:00
Returns how many connections this [param region] has with other regions in the map.
Allow Navigation to be more flexible
2021-03-15 11:45:28 +00:00
</description>
</method>
Add NavigationRegion costs for pathfinding Add NavigationRegion costs for pathfinding.
2022-06-06 03:24:11 +00:00
<method name="region_get_enter_cost" qualifiers="const">
<return type="float" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="region" type="RID" />
Add NavigationRegion costs for pathfinding Add NavigationRegion costs for pathfinding.
2022-06-06 03:24:11 +00:00
<description>
More class reference fixes Mostly typos. Also renamed the remaining "Vulkan Clustered" to "Forward+".
2023-02-24 02:42:07 +00:00
Returns the enter cost of this [param region].
Add NavigationRegion costs for pathfinding Add NavigationRegion costs for pathfinding.
2022-06-06 03:24:11 +00:00
</description>
</method>
Streamline Navigation layer function names. Streamline Navigation layer function names.
2022-06-14 21:34:43 +00:00
<method name="region_get_map" qualifiers="const">
<return type="RID" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="region" type="RID" />
Implement Navigation layers
2021-03-08 19:56:33 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters (5)
2022-08-12 13:36:48 +00:00
Returns the navigation map [RID] the requested [param region] is currently assigned to.
Implement Navigation layers
2021-03-08 19:56:33 +00:00
</description>
</method>
Streamline Navigation layer function names. Streamline Navigation layer function names.
2022-06-14 21:34:43 +00:00
<method name="region_get_navigation_layers" qualifiers="const">
<return type="int" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="region" type="RID" />
Add NavigationServer2D/3D API functions to find missing RID info Utility functions for NavigationServer2D/3D to find missing RID information when working with Server API directly. e.g. from map to regions and agents, from agent or region to map, from region to map and agents and so on .... Requirement to work with NavigationServer API exklusive without SceneTree nodes and when juggling agents and regions between multiple navigation maps.
2022-05-12 00:52:48 +00:00
<description>
Streamline Navigation layer function names. Streamline Navigation layer function names.
2022-06-14 21:34:43 +00:00
Returns the region's navigation layers.
Add NavigationServer2D/3D API functions to find missing RID info Utility functions for NavigationServer2D/3D to find missing RID information when working with Server API directly. e.g. from map to regions and agents, from agent or region to map, from region to map and agents and so on .... Requirement to work with NavigationServer API exklusive without SceneTree nodes and when juggling agents and regions between multiple navigation maps.
2022-05-12 00:52:48 +00:00
</description>
</method>
Enable assigning an owner to navigation regions and links This allows users of the server APIs to get back the nodes that created certain regions and links.
2022-10-01 05:49:39 +00:00
<method name="region_get_owner_id" qualifiers="const">
<return type="int" />
<param index="0" name="region" type="RID" />
<description>
Returns the [code]ObjectID[/code] of the object which manages this region.
</description>
</method>
Add NavigationRegion costs for pathfinding Add NavigationRegion costs for pathfinding.
2022-06-06 03:24:11 +00:00
<method name="region_get_travel_cost" qualifiers="const">
<return type="float" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="region" type="RID" />
Add NavigationRegion costs for pathfinding Add NavigationRegion costs for pathfinding.
2022-06-06 03:24:11 +00:00
<description>
More class reference fixes Mostly typos. Also renamed the remaining "Vulkan Clustered" to "Forward+".
2023-02-24 02:42:07 +00:00
Returns the travel cost of this [param region].
Add NavigationRegion costs for pathfinding Add NavigationRegion costs for pathfinding.
2022-06-06 03:24:11 +00:00
</description>
</method>
Add NavigationServer.region_owns_point() helper function Adds a helper function to check if a world space position is currently owned by a navigation region.
2022-06-23 17:16:47 +00:00
<method name="region_owns_point" qualifiers="const">
<return type="bool" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="region" type="RID" />
<param index="1" name="point" type="Vector3" />
Add NavigationServer.region_owns_point() helper function Adds a helper function to check if a world space position is currently owned by a navigation region.
2022-06-23 17:16:47 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters (5)
2022-08-12 13:36:48 +00:00
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.
Add NavigationServer.region_owns_point() helper function Adds a helper function to check if a world space position is currently owned by a navigation region.
2022-06-23 17:16:47 +00:00
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.
</description>
</method>
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
<method name="region_set_enter_cost">
Add NavigationRegion costs for pathfinding Add NavigationRegion costs for pathfinding.
2022-06-06 03:24:11 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="region" type="RID" />
<param index="1" name="enter_cost" type="float" />
Add NavigationRegion costs for pathfinding Add NavigationRegion costs for pathfinding.
2022-06-06 03:24:11 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters (5)
2022-08-12 13:36:48 +00:00
Sets the [param enter_cost] for this [param region].
Add NavigationRegion costs for pathfinding Add NavigationRegion costs for pathfinding.
2022-06-06 03:24:11 +00:00
</description>
</method>
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
<method name="region_set_map">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="region" type="RID" />
<param index="1" name="map" type="RID" />
Implement Navigation layers
2021-03-08 19:56:33 +00:00
<description>
Streamline Navigation layer function names. Streamline Navigation layer function names.
2022-06-14 21:34:43 +00:00
Sets the map for the region.
Implement Navigation layers
2021-03-08 19:56:33 +00:00
</description>
</method>
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
<method name="region_set_navigation_layers">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="region" type="RID" />
<param index="1" name="navigation_layers" type="int" />
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
<description>
Streamline Navigation layer function names. Streamline Navigation layer function names.
2022-06-14 21:34:43 +00:00
Set the region's navigation layers. This allows selecting regions from a path request (when using [method NavigationServer3D.map_get_path]).
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
</description>
</method>
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
<method name="region_set_navigation_mesh">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="region" type="RID" />
Fix Navigation API abbreviations inconsistency Schema for navigation to name user facing API with "navigation" without abbreviation and e.g. NavigationServer internals with abbr "nav".
2022-12-11 17:02:35 +00:00
<param index="1" name="navigation_mesh" type="NavigationMesh" />
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
<description>
Sets the navigation mesh for the region.
</description>
</method>
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
<method name="region_set_owner_id">
Enable assigning an owner to navigation regions and links This allows users of the server APIs to get back the nodes that created certain regions and links.
2022-10-01 05:49:39 +00:00
<return type="void" />
<param index="0" name="region" type="RID" />
<param index="1" name="owner_id" type="int" />
<description>
Set the [code]ObjectID[/code] of the object which manages this region.
</description>
</method>
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
<method name="region_set_transform">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="region" type="RID" />
<param index="1" name="transform" type="Transform3D" />
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
<description>
Sets the global transformation for the region.
</description>
</method>
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
<method name="region_set_travel_cost">
Add NavigationRegion costs for pathfinding Add NavigationRegion costs for pathfinding.
2022-06-06 03:24:11 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="region" type="RID" />
<param index="1" name="travel_cost" type="float" />
Add NavigationRegion costs for pathfinding Add NavigationRegion costs for pathfinding.
2022-06-06 03:24:11 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters (5)
2022-08-12 13:36:48 +00:00
Sets the [param travel_cost] for this [param region].
Add NavigationRegion costs for pathfinding Add NavigationRegion costs for pathfinding.
2022-06-06 03:24:11 +00:00
</description>
</method>
Rework const on NavigationServer methods `const` is used on all methods, even when they cause modification of the server. This reworks the methods of the server to only use `const` on method that don't change the state of the server.
2022-12-21 22:21:43 +00:00
<method name="set_active">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="active" type="bool" />
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
<description>
Control activation of this server.
</description>
</method>
Fix navigation debug not toggleable in scripts Fixes that navigation debug was not toggleable in script while even the docs mentioned it.
2023-02-13 11:17:24 +00:00
<method name="set_debug_enabled">
<return type="void" />
<param index="0" name="enabled" type="bool" />
<description>
If [code]true[/code] enables debug mode on the NavigationServer.
</description>
</method>
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
</methods>
Allow Navigation to be more flexible
2021-03-15 11:45:28 +00:00
<signals>
<signal name="map_changed">
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="map" type="RID" />
Allow Navigation to be more flexible
2021-03-15 11:45:28 +00:00
<description>
Emitted when a navigation map is updated, when a region moves or is modified.
</description>
</signal>
Add more detailed Navigation Debug Visualization - Adds more customization options to ProjectSettings. - Displays navregion edge connections and navigation polygon edges in editor and at runtime. - Majority of debug code moved from SceneTree to NavigationServer. - Removes the irritating debug MeshInstance child node from NavigationRegion3D and replaces it with direct RenderingServer API.
2022-07-01 16:58:03 +00:00
<signal name="navigation_debug_changed">
<description>
Emitted when navigation debug settings are changed. Only available in debug builds.
</description>
</signal>
Allow Navigation to be more flexible
2021-03-15 11:45:28 +00:00
</signals>
Add NavigationServer Performance Monitor Adds Performance Monitor for NavigationServer3D.
2022-12-30 04:19:15 +00:00
<constants>
<constant name="INFO_ACTIVE_MAPS" value="0" enum="ProcessInfo">
Constant to get the number of active navigation maps.
</constant>
<constant name="INFO_REGION_COUNT" value="1" enum="ProcessInfo">
Constant to get the number of active navigation regions.
</constant>
<constant name="INFO_AGENT_COUNT" value="2" enum="ProcessInfo">
Constant to get the number of active navigation agents processing avoidance.
</constant>
<constant name="INFO_LINK_COUNT" value="3" enum="ProcessInfo">
Constant to get the number of active navigation links.
</constant>
<constant name="INFO_POLYGON_COUNT" value="4" enum="ProcessInfo">
Constant to get the number of navigation mesh polygons.
</constant>
<constant name="INFO_EDGE_COUNT" value="5" enum="ProcessInfo">
Constant to get the number of navigation mesh polygon edges.
</constant>
<constant name="INFO_EDGE_MERGE_COUNT" value="6" enum="ProcessInfo">
Constant to get the number of navigation mesh polygon edges that were merged due to edge key overlap.
</constant>
<constant name="INFO_EDGE_CONNECTION_COUNT" value="7" enum="ProcessInfo">
Constant to get the number of navigation mesh polygon edges that are considered connected by edge proximity.
</constant>
<constant name="INFO_EDGE_FREE_COUNT" value="8" enum="ProcessInfo">
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.
</constant>
</constants>
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
</class>