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

337 lines
15 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" ?>
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
2022-02-14 13:18:53 +00:00
<class name="NavigationServer2D" inherits="Object" version="4.0" 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>
Server interface for low-level 2D navigation access
</brief_description>
<description>
Implement Navigation layers
2021-03-08 19:56:33 +00:00
NavigationServer2D is the server responsible for all 2D 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 polygons. Together, they define the navigable areas in the 2D world.
[b]Note:[/b] Most NavigationServer changes take effect after the next physics frame and not immediately. This includes all changes made to maps, regions or agents by navigation related Nodes in the SceneTree or made through scripts.
For two regions to be connected to each other, they must share a similar edge. An edge is considered connected to another if both of its two vertices are at a distance less than [code]edge_connection_margin[/code] to the respective other edge's vertex.
Implement Navigation layers
2021-03-08 19:56:33 +00:00
You may assign navigation layers to regions with [method NavigationServer2D.region_set_layers], which then can be checked upon when requesting a path with [method NavigationServer2D.map_get_path]. This allows allowing or forbidding some areas to 2D objects.
To use the collision avoidance system, you may use agents. You can set an agent's target velocity, then the servers will emit a callback with a modified velocity.
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="2D Navigation Demo">https://godotengine.org/asset-library/asset/117</link>
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
</tutorials>
<methods>
<method name="agent_create" 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" />
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" />
<argument index="0" name="agent" type="RID" />
<description>
Returns the navigation map [RID] the requested [code]agent[/code] is currently assigned to.
</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" />
<argument 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>
<method name="agent_set_callback" 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="void" />
<argument index="0" name="agent" type="RID" />
<argument index="1" name="receiver" type="Object" />
<argument index="2" name="method" type="StringName" />
<argument index="3" name="userdata" type="Variant" default="null" />
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
<description>
Document NavigationServer API navigation agent callbacks Document NavigationServer API navigation agent callbacks.
2022-06-14 14:49:02 +00:00
Callback called at the end of the RVO process. If a callback is created manually and the agent is placed on a navigation map it will calculate avoidance for the agent and dispatch the calculated [code]safe_velocity[/code] to the [code]receiver[/code] object with a signal to the chosen [code]method[/code] name.
[b]Note:[/b] Created callbacks are always processed independently of the SceneTree state as long as the agent is on a navigation map and not freed. To disable the dispatch of a callback from an agent use [method agent_set_callback] again with a [code]null[/code] object as the [code]receiver[/code].
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
</description>
</method>
<method name="agent_set_map" 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="void" />
<argument index="0" name="agent" type="RID" />
<argument 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>
<method name="agent_set_max_neighbors" 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="void" />
<argument index="0" name="agent" type="RID" />
<argument 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>
<method name="agent_set_max_speed" 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="void" />
<argument index="0" name="agent" type="RID" />
<argument 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>
<method name="agent_set_neighbor_dist" 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="void" />
<argument index="0" name="agent" type="RID" />
<argument index="1" name="dist" 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>
<method name="agent_set_position" 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="void" />
<argument index="0" name="agent" type="RID" />
<argument index="1" name="position" type="Vector2" />
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>
<method name="agent_set_radius" 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="void" />
<argument index="0" name="agent" type="RID" />
<argument 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>
<method name="agent_set_target_velocity" 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="void" />
<argument index="0" name="agent" type="RID" />
<argument index="1" name="target_velocity" type="Vector2" />
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>
<method name="agent_set_time_horizon" 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="void" />
<argument index="0" name="agent" type="RID" />
<argument 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>
<method name="agent_set_velocity" 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="void" />
<argument index="0" name="agent" type="RID" />
<argument index="1" name="velocity" type="Vector2" />
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>
Rename NavigationServer's free method to free_rid
2022-04-08 09:39:17 +00:00
<method name="free_rid" 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="void" />
Rename NavigationServer's free method to free_rid
2022-04-08 09:39:17 +00:00
<argument 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>
<method name="map_create" 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" />
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 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">
<return type="Array" />
<argument index="0" name="map" type="RID" />
<description>
Returns all navigation agents [RID]s that are currently assigned to the requested navigation [code]map[/code].
</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" />
<argument 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="Vector2" />
<argument index="0" name="map" type="RID" />
<argument index="1" name="to_point" type="Vector2" />
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 point closest to the provided [code]to_point[/code] 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_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" />
<argument index="0" name="map" type="RID" />
<argument index="1" name="to_point" type="Vector2" />
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>
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" />
<argument 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>
doc: Sync classref with current source
2020-02-19 08:55:47 +00:00
Returns the edge connection margin of the map. The edge connection margin is a distance used to connect two 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>
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="PackedVector2Array" />
<argument index="0" name="map" type="RID" />
<argument index="1" name="origin" type="Vector2" />
<argument index="2" name="destination" type="Vector2" />
<argument index="3" name="optimize" type="bool" />
<argument index="4" name="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>
Implement Navigation layers
2021-03-08 19:56:33 +00:00
Returns the navigation path to reach the destination from the origin. [code]layers[/code] is a bitmask of all region 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">
<return type="Array" />
<argument index="0" name="map" type="RID" />
<description>
Returns all navigation regions [RID]s that are currently assigned to the requested navigation [code]map[/code].
</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_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" />
<argument index="0" name="nap" 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>
<method name="map_set_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="void" />
<argument index="0" name="map" type="RID" />
<argument 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>
<method name="map_set_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="void" />
<argument index="0" name="map" type="RID" />
<argument 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>
<method name="map_set_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="void" />
<argument index="0" name="map" type="RID" />
<argument 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>
Set the map edge connection margin used to weld the compatible region edges.
</description>
</method>
<method name="region_create" 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" />
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>
Implement Navigation layers
2021-03-08 19:56:33 +00:00
</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="Vector2" />
<argument index="0" name="region" type="RID" />
<argument index="1" name="connection" type="int" />
Allow Navigation to be more flexible
2021-03-15 11:45:28 +00:00
<description>
Returns the ending point of a connection door. [code]connection[/code] is an index between 0 and the return value of [method region_get_connections_count].
</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="Vector2" />
<argument index="0" name="region" type="RID" />
<argument index="1" name="connection" type="int" />
Allow Navigation to be more flexible
2021-03-15 11:45:28 +00:00
<description>
Returns the starting point of a connection door. [code]connection[/code] is an index between 0 and the return value of [method region_get_connections_count].
</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" />
<argument index="0" name="region" type="RID" />
Allow Navigation to be more flexible
2021-03-15 11:45:28 +00:00
<description>
Returns how many connections this [code]region[/code] has with other regions in the map.
</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" />
<argument index="0" name="region" type="RID" />
<description>
Returns the [code]enter_cost[/code] of this [code]region[/code].
</description>
</method>
Implement Navigation layers
2021-03-08 19:56:33 +00:00
<method name="region_get_layers" 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" />
<argument index="0" name="region" type="RID" />
Implement Navigation layers
2021-03-08 19:56:33 +00:00
<description>
Returns the region's layers.
</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="region_get_map" qualifiers="const">
<return type="RID" />
<argument index="0" name="region" type="RID" />
<description>
Returns the navigation map [RID] the requested [code]region[/code] is currently assigned to.
</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" />
<argument index="0" name="region" type="RID" />
<description>
Returns the [code]travel_cost[/code] of this [code]region[/code].
</description>
</method>
<method name="region_set_enter_cost" qualifiers="const">
<return type="void" />
<argument index="0" name="region" type="RID" />
<argument index="1" name="enter_cost" type="float" />
<description>
Sets the [code]enter_cost[/code] for this [code]region[/code].
</description>
</method>
Implement Navigation layers
2021-03-08 19:56:33 +00:00
<method name="region_set_layers" 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="void" />
<argument index="0" name="region" type="RID" />
<argument index="1" name="layers" type="int" />
Implement Navigation layers
2021-03-08 19:56:33 +00:00
<description>
Set the region's layers. This allows selecting regions from a path request (when using [method NavigationServer2D.map_get_path]).
</description>
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
</method>
<method name="region_set_map" 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="void" />
<argument index="0" name="region" type="RID" />
<argument 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>
Sets the map for the region.
</description>
</method>
<method name="region_set_navpoly" 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="void" />
<argument index="0" name="region" type="RID" />
<argument index="1" name="nav_poly" type="NavigationPolygon" />
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>
<method name="region_set_transform" 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="void" />
<argument index="0" name="region" type="RID" />
<argument index="1" name="transform" type="Transform2D" />
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>
Add NavigationRegion costs for pathfinding Add NavigationRegion costs for pathfinding.
2022-06-06 03:24:11 +00:00
<method name="region_set_travel_cost" qualifiers="const">
<return type="void" />
<argument index="0" name="region" type="RID" />
<argument index="1" name="travel_cost" type="float" />
<description>
Sets the [code]travel_cost[/code] for this [code]region[/code].
</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">
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
<argument 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>
</signals>
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 14:24:00 +00:00
</class>