diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2020-02-12 09:59:06 +0100 |
|---|---|---|
| committer | Rémi Verschelde <rverschelde@gmail.com> | 2020-02-12 12:37:13 +0100 |
| commit | 0e3d6257377d9f73520e5ccdb7677fde23be3398 (patch) | |
| tree | 900f2168fcdaadf1fe3532186bbfef273701fd51 /doc/classes/NavigationAgent2D.xml | |
| parent | 0c7fc80cc19fe9cd609b145245b1bb70f6a41e2e (diff) | |
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.
Diffstat (limited to 'doc/classes/NavigationAgent2D.xml')
| -rw-r--r-- | doc/classes/NavigationAgent2D.xml | 32 |
1 files changed, 17 insertions, 15 deletions
diff --git a/doc/classes/NavigationAgent2D.xml b/doc/classes/NavigationAgent2D.xml index dd3a8aa011..6f356e7e4c 100644 --- a/doc/classes/NavigationAgent2D.xml +++ b/doc/classes/NavigationAgent2D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="NavigationAgent2D" inherits="Node" category="Core" version="3.2"> +<class name="NavigationAgent2D" inherits="Node" version="4.0"> <brief_description> 2D Agent used in navigation for collision avoidance. </brief_description> @@ -108,27 +108,27 @@ </method> </methods> <members> - <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="radius" type="float" setter="set_radius" getter="get_radius" default="10.0"> - The radius of the agent. - </member> - <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> <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="time_horizon" type="float" setter="set_time_horizon" getter="get_time_horizon" default="20.0"> - The minimal amount of time for which this agent's velocities, that are computed with the collision avoidance algorithim, 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. - </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> + <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> <member name="path_max_distance" type="float" setter="set_path_max_distance" getter="get_path_max_distance" default="3.0"> 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 exceded, it recalculates the ideal path. </member> + <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"> + The minimal amount of time for which this agent's velocities, that are computed with the collision avoidance algorithim, 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. + </member> </members> <signals> <signal name="navigation_finished"> @@ -143,15 +143,17 @@ </signal> <signal name="target_reached"> <description> - Notifies when the player defined target, set with [method set_target_location], is reached. + Notifies when the player defined target, set with [method set_target_location], is reached. </description> </signal> <signal name="velocity_computed"> - <argument index="0" name="safe_velocity" type="Vector2"> + <argument index="0" name="safe_velocity" type="Vector3"> </argument> <description> Notifies when the collision avoidance velocity is calculated. Emitted by [method set_velocity]. </description> </signal> </signals> + <constants> + </constants> </class> |