diff options
| author | smix8 <52464204+smix8@users.noreply.github.com> | 2022-12-11 18:02:35 +0100 |
|---|---|---|
| committer | smix8 <52464204+smix8@users.noreply.github.com> | 2022-12-17 22:06:22 +0100 |
| commit | 34e7628f5f1b419bfed1acd915209347e615bedf (patch) | |
| tree | 35f1f13357c7c8b1676bd5e3df33a2279dce0754 /doc/classes/NavigationAgent3D.xml | |
| parent | 10bc1d8710e8d6a3f58f2c4f5cc09604ef3ec51f (diff) | |
| download | redot-engine-34e7628f5f1b419bfed1acd915209347e615bedf.tar.gz | |
Fix Navigation API abbreviations inconsistency
Schema for navigation to name user facing API with "navigation" without abbreviation and e.g. NavigationServer internals with abbr "nav".
Diffstat (limited to 'doc/classes/NavigationAgent3D.xml')
| -rw-r--r-- | doc/classes/NavigationAgent3D.xml | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/doc/classes/NavigationAgent3D.xml b/doc/classes/NavigationAgent3D.xml index 44c17647f7..038a758758 100644 --- a/doc/classes/NavigationAgent3D.xml +++ b/doc/classes/NavigationAgent3D.xml @@ -16,24 +16,24 @@ Returns the distance to the target location, using the agent's global position. The user must set [member target_location] in order for this to be accurate. </description> </method> - <method name="get_final_location"> - <return type="Vector3" /> - <description> - Returns the reachable final location in global coordinates. This can change if the navigation path is altered in any way. Because of this, it would be best to check this each frame. - </description> - </method> - <method name="get_nav_path" qualifiers="const"> + <method name="get_current_navigation_path" qualifiers="const"> <return type="PackedVector3Array" /> <description> Returns this agent's current path from start to finish in global coordinates. The path only updates when the target location is changed or the agent requires a repath. The path array is not intended to be used in direct path movement as the agent has its own internal path logic that would get corrupted by changing the path array manually. Use the intended [method get_next_location] once every physics frame to receive the next path point for the agents movement as this function also updates the internal path logic. </description> </method> - <method name="get_nav_path_index" qualifiers="const"> + <method name="get_current_navigation_path_index" qualifiers="const"> <return type="int" /> <description> Returns which index the agent is currently on in the navigation path's [PackedVector3Array]. </description> </method> + <method name="get_final_location"> + <return type="Vector3" /> + <description> + Returns the reachable final location in global coordinates. This can change if the navigation path is altered in any way. Because of this, it would be best to check this each frame. + </description> + </method> <method name="get_navigation_layer_value" qualifiers="const"> <return type="bool" /> <param index="0" name="layer_number" type="int" /> |