asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
virtualx-engine/doc/classes/NavigationAgent2D.xml

140 lines
7.1 KiB
XML
Raw Normal View History

Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 15:24:00 +01: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 14:18:53 +01:00
<class name="NavigationAgent2D" inherits="Node" 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 15:24:00 +01:00
<brief_description>
2D Agent used in navigation for collision avoidance.
</brief_description>
<description>
Remove Navigation2D/3D nodes, and move the navigation map to the world resource
2021-03-08 09:47:18 +01:00
2D Agent that is used in navigation to reach a location while avoiding static and dynamic obstacles. The dynamic obstacles are avoided using RVO collision avoidance. The agent needs navigation data to work correctly. [NavigationAgent2D] is physics safe.
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 15:24:00 +01:00
</description>
<tutorials>
</tutorials>
<methods>
<method name="distance_to_target" 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 15:28:05 +02:00
<return type="float" />
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 15:24:00 +01:00
<description>
Returns the distance to the target location, using the agent's global position. The user must set the target location with [method set_target_location] in order for this to be accurate.
</description>
</method>
<method name="get_final_location">
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 15:28:05 +02:00
<return type="Vector2" />
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 15:24:00 +01:00
<description>
Misc documentation improvements
2022-01-08 15:38:55 +01:00
Returns the reachable final location in global coordinates. This can change if the navigation path is altered in any way. Because of this, it would be best to check this each frame.
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 15:24:00 +01:00
</description>
</method>
<method name="get_nav_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 15:28:05 +02:00
<return type="PackedVector2Array" />
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 15:24:00 +01:00
<description>
Returns the path from start to finish in global coordinates.
</description>
</method>
<method name="get_nav_path_index" 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 15:28:05 +02:00
<return type="int" />
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 15:24:00 +01:00
<description>
doc: Sync classref with current source Handle removal of Pool*Array types and other recent changes.
2020-02-18 13:59:24 +01:00
Returns which index the agent is currently on in the navigation path's [PackedVector2Array].
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 15:24:00 +01:00
</description>
</method>
<method name="get_next_location">
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 15:28:05 +02:00
<return type="Vector2" />
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 15:24:00 +01:00
<description>
Returns a [Vector2] in global coordinates, that can be moved to, making sure that there are no static objects in the way. If the agent does not have a navigation path, it will return the position of the agent's parent.
</description>
</method>
doc: Sync classref with current source And typo fix from https://github.com/godotengine/godot-docs/pull/4882.
2021-04-29 12:10:58 +02:00
<method name="get_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 15:28:05 +02:00
<return type="RID" />
doc: Sync classref with current source And typo fix from https://github.com/godotengine/godot-docs/pull/4882.
2021-04-29 12:10:58 +02:00
<description>
Process NavigationAgent2D/3D avoidance on demand only Changes NavigationAgent avoidance callback to a toggle that is disabled by default. Also fixes a few missing descriptions / wrong warnings.
2022-05-20 22:55:27 +02:00
Returns the [RID] of this agent on the [NavigationServer2D].
doc: Sync classref with current source And typo fix from https://github.com/godotengine/godot-docs/pull/4882.
2021-04-29 12:10:58 +02:00
</description>
</method>
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 15:24:00 +01:00
<method name="get_target_location" 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 15:28:05 +02:00
<return type="Vector2" />
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 15:24:00 +01:00
<description>
Returns the user defined [Vector2] after setting the target location.
</description>
</method>
<method name="is_navigation_finished">
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 15:28:05 +02:00
<return type="bool" />
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 15:24:00 +01:00
<description>
Returns true if the navigation path's final location has been reached.
</description>
</method>
<method name="is_target_reachable">
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 15:28:05 +02:00
<return type="bool" />
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 15:24:00 +01:00
<description>
Returns true if the target location is reachable. The target location is set using [method set_target_location].
</description>
</method>
<method name="is_target_reached" 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 15:28:05 +02:00
<return type="bool" />
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 15:24:00 +01:00
<description>
Returns true if the target location is reached. The target location is set using [method set_target_location]. It may not always be possible to reach the target location. It should always be possible to reach the final location though. See [method get_final_location].
</description>
</method>
<method name="set_target_location">
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 15:28:05 +02:00
<return type="void" />
<argument index="0" name="location" type="Vector2" />
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 15:24:00 +01:00
<description>
Sets the user desired final location. This will clear the current navigation path.
</description>
</method>
<method name="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 15:28:05 +02:00
<return type="void" />
<argument index="0" name="velocity" type="Vector2" />
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 15:24:00 +01:00
<description>
Sends the passed in velocity to the collision avoidance algorithm. It will adjust the velocity to avoid collisions. Once the adjustment to the velocity is complete, it will emit the [signal velocity_computed] signal.
</description>
</method>
</methods>
<members>
Process NavigationAgent2D/3D avoidance on demand only Changes NavigationAgent avoidance callback to a toggle that is disabled by default. Also fixes a few missing descriptions / wrong warnings.
2022-05-20 22:55:27 +02:00
<member name="avoidance_enabled" type="bool" setter="set_avoidance_enabled" getter="get_avoidance_enabled" default="false">
If [code]true[/code] the agent is registered for an RVO avoidance callback on the [NavigationServer2D]. When [method NavigationAgent2D.set_velocity] is used and the processing is completed a [code]safe_velocity[/code] Vector2 is received with a signal connection to [signal velocity_computed]. Avoidance processing with many registered agents has a significant performance cost and should only be enabled on agents that currently require it.
</member>
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 15:24:00 +01:00
<member name="max_neighbors" type="int" setter="set_max_neighbors" getter="get_max_neighbors" default="10">
The maximum number of neighbors for the agent to consider.
</member>
<member name="max_speed" type="float" setter="set_max_speed" getter="get_max_speed" default="200.0">
The maximum speed that an agent can move.
</member>
Expose navigable layers for NavigationAgent2D/3D
2022-03-19 21:47:02 +01:00
<member name="navigable_layers" type="int" setter="set_navigable_layers" getter="get_navigable_layers" default="1">
A bitfield determining what layers of navigation regions this agent will use to calculate path. Changing it runtime will clear current navigation path and generate new one, according to new layers.
</member>
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 09:59:06 +01:00
<member name="neighbor_dist" type="float" setter="set_neighbor_dist" getter="get_neighbor_dist" default="500.0">
The distance to search for other agents.
</member>
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 15:24:00 +01:00
<member name="path_max_distance" type="float" setter="set_path_max_distance" getter="get_path_max_distance" default="3.0">
Fix various typos Found via `codespell`
2020-03-11 18:59:18 +01:00
The maximum distance the agent is allowed away from the ideal path to the final location. This can happen due to trying to avoid collisions. When the maximum distance is exceeded, it recalculates the ideal path.
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 15:24:00 +01:00
</member>
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 09:59:06 +01:00
<member name="radius" type="float" setter="set_radius" getter="get_radius" default="10.0">
The radius of the agent.
</member>
<member name="target_desired_distance" type="float" setter="set_target_desired_distance" getter="get_target_desired_distance" default="1.0">
The distance threshold before a target is considered to be reached. This will allow an agent to not have to hit a point on the path exactly, but in the area.
</member>
<member name="time_horizon" type="float" setter="set_time_horizon" getter="get_time_horizon" default="20.0">
class reference proofreading
2021-03-18 12:04:28 +01:00
The minimal amount of time for which this agent's velocities, that are computed with the collision avoidance algorithm, are safe with respect to other agents. The larger the number, the sooner the agent will respond to other agents, but less freedom in choosing its velocities. Must be positive.
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 09:59:06 +01:00
</member>
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 15:24:00 +01:00
</members>
<signals>
<signal name="navigation_finished">
<description>
Notifies when the final location is reached.
</description>
</signal>
<signal name="path_changed">
<description>
Notifies when the navigation path changes.
</description>
</signal>
<signal name="target_reached">
<description>
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 09:59:06 +01:00
Notifies when the player defined target, set with [method set_target_location], is reached.
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 15:24:00 +01:00
</description>
</signal>
<signal name="velocity_computed">
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 15:28:05 +02:00
<argument index="0" name="safe_velocity" type="Vector3" />
Documented the new NavigationServer and all its associated nodes (2D and 3D)
2020-02-10 15:24:00 +01:00
<description>
Notifies when the collision avoidance velocity is calculated. Emitted by [method set_velocity].
</description>
</signal>
</signals>
</class>
Reference in a new issue Copy permalink