Skip to content

Commit

Permalink
Document that NavigationAgent height offset is mostly a placebo
Browse files Browse the repository at this point in the history
Document that NavigationAgent height offset is mostly a placebo.
  • Loading branch information
smix8 committed Jun 1, 2022
1 parent d8b0a8c commit b1d9853
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion doc/classes/NavigationAgent3D.xml
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@
</methods>
<members>
<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.
The NavigationAgent height offset is subtracted from the y-axis value of any vector path position for this NavigationAgent. The NavigationAgent height offset does not change or influence the navigation mesh or pathfinding query result. Additional navigation maps that use regions with navigation meshes that the developer baked with appropriate agent radius or height values are required to support different-sized agents.
</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.
Expand Down

0 comments on commit b1d9853

Please sign in to comment.