Skip to content

Commit

Permalink
Merge pull request #82671 from Flynsarmy/the_humble_comma
Browse files Browse the repository at this point in the history
Improve `NavigationAgent3D.target_position` documentation readability
  • Loading branch information
akien-mga committed Oct 2, 2023
2 parents 6bebd9c + 5391fe6 commit 5e19247
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion doc/classes/NavigationAgent2D.xml
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@
The distance threshold before the final target point is considered to be reached. This allows agents to not have to hit the point of the final target exactly, but only to reach its general area. If this value is set too low, the NavigationAgent will be stuck in a repath loop because it will constantly overshoot or undershoot the distance to the final target point on each physics frame update.
</member>
<member name="target_position" type="Vector2" setter="set_target_position" getter="get_target_position" default="Vector2(0, 0)">
If set a new navigation path from the current agent position to the [member target_position] is requested from the NavigationServer.
If set, a new navigation path from the current agent position to the [member target_position] is requested from the NavigationServer.
</member>
<member name="time_horizon_agents" type="float" setter="set_time_horizon_agents" getter="get_time_horizon_agents" default="1.0">
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. A too high value will slow down agents movement considerably. Must be positive.
Expand Down
2 changes: 1 addition & 1 deletion doc/classes/NavigationAgent3D.xml
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@
The distance threshold before the final target point is considered to be reached. This allows agents to not have to hit the point of the final target exactly, but only to reach its general area. If this value is set too low, the NavigationAgent will be stuck in a repath loop because it will constantly overshoot or undershoot the distance to the final target point on each physics frame update.
</member>
<member name="target_position" type="Vector3" setter="set_target_position" getter="get_target_position" default="Vector3(0, 0, 0)">
If set a new navigation path from the current agent position to the [member target_position] is requested from the NavigationServer.
If set, a new navigation path from the current agent position to the [member target_position] is requested from the NavigationServer.
</member>
<member name="time_horizon_agents" type="float" setter="set_time_horizon_agents" getter="get_time_horizon_agents" default="1.0">
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. A too high value will slow down agents movement considerably. Must be positive.
Expand Down

0 comments on commit 5e19247

Please sign in to comment.