diff options
| author | smix8 <52464204+smix8@users.noreply.github.com> | 2022-05-20 22:55:27 +0200 |
|---|---|---|
| committer | smix8 <52464204+smix8@users.noreply.github.com> | 2022-05-20 23:47:10 +0200 |
| commit | 7f3688603cb3662e425cb7a1dce15459162c1dc6 (patch) | |
| tree | bd34cb811dc40c01c8cfc78403e10664315f5cf2 /doc | |
| parent | 410893ad0fb6f0d7d774b6529581d886defd6cf0 (diff) | |
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.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/NavigationAgent2D.xml | 4 | ||||
| -rw-r--r-- | doc/classes/NavigationAgent3D.xml | 4 |
2 files changed, 8 insertions, 0 deletions
diff --git a/doc/classes/NavigationAgent2D.xml b/doc/classes/NavigationAgent2D.xml index baab91569a..942579f564 100644 --- a/doc/classes/NavigationAgent2D.xml +++ b/doc/classes/NavigationAgent2D.xml @@ -42,6 +42,7 @@ <method name="get_rid" qualifiers="const"> <return type="RID" /> <description> + Returns the [RID] of this agent on the [NavigationServer2D]. </description> </method> <method name="get_target_location" qualifiers="const"> @@ -84,6 +85,9 @@ </method> </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. + </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> diff --git a/doc/classes/NavigationAgent3D.xml b/doc/classes/NavigationAgent3D.xml index 04b148c70d..445fac55fe 100644 --- a/doc/classes/NavigationAgent3D.xml +++ b/doc/classes/NavigationAgent3D.xml @@ -42,6 +42,7 @@ <method name="get_rid" qualifiers="const"> <return type="RID" /> <description> + Returns the [RID] of this agent on the [NavigationServer3D]. </description> </method> <method name="get_target_location" qualifiers="const"> @@ -87,6 +88,9 @@ <member name="agent_height_offset" type="float" setter="set_agent_height_offset" getter="get_agent_height_offset" default="0.0"> The agent height offset to match the navigation mesh height. </member> + <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 [NavigationServer3D]. When [method NavigationAgent3D.set_velocity] is used and the processing is completed a [code]safe_velocity[/code] Vector3 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="ignore_y" type="bool" setter="set_ignore_y" getter="get_ignore_y" default="true"> Ignores collisions on the Y axis. Must be true to move on a horizontal plane. </member> |