diff options
| author | Haoyu Qiu <timothyqiu32@gmail.com> | 2023-03-27 19:29:19 +0800 |
|---|---|---|
| committer | Yuri Sizov <yuris@humnom.net> | 2023-03-27 18:02:28 +0200 |
| commit | 4750b77d2d52a2ba0b6fe79ddb5f27bdc051cbe1 (patch) | |
| tree | 9fca49f4f506ed4b19fe17412fc0e25686bff930 /doc/classes/NavigationAgent2D.xml | |
| parent | 2ea8dd7232f0ceb191ec961e1e3873a7e0a29791 (diff) | |
Fix typos and inconsistencies in classref
* Typo fixes.
* Navigation agent's `velocity_computed` signal is not emitted by
`set_velocity`, but at the end of that frame if `set_velocity` is
called.
* Simplify link in navigation agent's `avoidance_enabled` description.
* Unify `navigation_layers` description across `NavigationAgent{2,3}D`.
* Unify `is_normalized()` description across `Vector2`, `Vector3`, and
`Vector4`
(cherry picked from commit ff97c481d367a8c4e72b6548095ce33c98e4ef33)
Diffstat (limited to 'doc/classes/NavigationAgent2D.xml')
| -rw-r--r-- | doc/classes/NavigationAgent2D.xml | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/classes/NavigationAgent2D.xml b/doc/classes/NavigationAgent2D.xml index 06ce32597f..4433e73547 100644 --- a/doc/classes/NavigationAgent2D.xml +++ b/doc/classes/NavigationAgent2D.xml @@ -109,7 +109,7 @@ </methods> <members> <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. + If [code]true[/code] the agent is registered for an RVO avoidance callback on the [NavigationServer2D]. When [method 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> <member name="debug_enabled" type="bool" setter="set_debug_enabled" getter="get_debug_enabled" default="false"> If [code]true[/code] shows debug visuals for this agent. @@ -193,7 +193,7 @@ <signal name="velocity_computed"> <param index="0" name="safe_velocity" type="Vector2" /> <description> - Notifies when the collision avoidance velocity is calculated. Emitted by [method set_velocity]. Only emitted when [member avoidance_enabled] is true. + Notifies when the collision avoidance velocity is calculated. Emitted at the end of the physics frame in which [method set_velocity] is called. Only emitted when [member avoidance_enabled] is true. </description> </signal> <signal name="waypoint_reached"> |