diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2020-02-19 09:55:47 +0100 |
|---|---|---|
| committer | Rémi Verschelde <rverschelde@gmail.com> | 2020-02-19 09:55:47 +0100 |
| commit | 28bb2806f1afac8d256291a6b86352e11f074697 (patch) | |
| tree | e411f18f89e58b461057e80679bd2b5c67de7665 /doc/classes/Navigation.xml | |
| parent | c72b05e851bdc0f23301a762c7ecd8ee8f17734d (diff) | |
doc: Sync classref with current source
Diffstat (limited to 'doc/classes/Navigation.xml')
| -rw-r--r-- | doc/classes/Navigation.xml | 56 |
1 files changed, 28 insertions, 28 deletions
diff --git a/doc/classes/Navigation.xml b/doc/classes/Navigation.xml index 8057aca127..0000ca6bd5 100644 --- a/doc/classes/Navigation.xml +++ b/doc/classes/Navigation.xml @@ -9,31 +9,39 @@ <tutorials> </tutorials> <methods> - <method name="get_rid" qualifiers="const"> - <return type="RID"> + <method name="get_closest_point" qualifiers="const"> + <return type="Vector3"> </return> + <argument index="0" name="to_point" type="Vector3"> + </argument> <description> + Returns the point closest to the provided [code]to_point[/code] on the navigation mesh surface. </description> </method> - <method name="get_simple_path" qualifiers="const"> - <return type="PackedVector3Array"> + <method name="get_closest_point_normal" qualifiers="const"> + <return type="Vector3"> </return> - <argument index="0" name="start" type="Vector3"> - </argument> - <argument index="1" name="end" type="Vector3"> + <argument index="0" name="to_point" type="Vector3"> </argument> - <argument index="2" name="optimize" type="bool" default="true"> + <description> + Returns the normal for the point returned by [method get_closest_point]. + </description> + </method> + <method name="get_closest_point_owner" qualifiers="const"> + <return type="RID"> + </return> + <argument index="0" name="to_point" type="Vector3"> </argument> <description> - Returns the path between two given points. Points are in local coordinate space. If [code]optimize[/code] is [code]true[/code] (the default), the agent properties associated with each [NavigationMesh] (radius, height, etc.) are considered in the path calculation, otherwise they are ignored. + Returns the owner region RID for the point returned by [method get_closest_point]. </description> </method> <method name="get_closest_point_to_segment" qualifiers="const"> <return type="Vector3"> </return> - <argument index="0" name="from" type="Vector3"> + <argument index="0" name="start" type="Vector3"> </argument> - <argument index="1" name="to" type="Vector3"> + <argument index="1" name="end" type="Vector3"> </argument> <argument index="2" name="use_collision" type="bool" default="false"> </argument> @@ -41,31 +49,23 @@ Returns the closest point between the navigation surface and the segment. </description> </method> - <method name="get_closest_point" qualifiers="const"> - <return type="Vector3"> + <method name="get_rid" qualifiers="const"> + <return type="RID"> </return> - <argument index="0" name="point" type="Vector3"> - </argument> <description> - Returns the point closest to the provided [code]point[/code] on the navigation mesh surface. </description> </method> - <method name="get_closest_point_normal" qualifiers="const"> - <return type="Vector3"> + <method name="get_simple_path" qualifiers="const"> + <return type="PackedVector3Array"> </return> - <argument index="0" name="point" type="Vector3"> + <argument index="0" name="start" type="Vector3"> </argument> - <description> - Returns the normal for the point returned by [method get_closest_point]. - </description> - </method> - <method name="get_closest_point_owner" qualifiers="const"> - <return type="RID"> - </return> - <argument index="0" name="point" type="Vector3"> + <argument index="1" name="end" type="Vector3"> + </argument> + <argument index="2" name="optimize" type="bool" default="true"> </argument> <description> - Returns the owner region RID for the point returned by [method get_closest_point]. + Returns the path between two given points. Points are in local coordinate space. If [code]optimize[/code] is [code]true[/code] (the default), the agent properties associated with each [NavigationMesh] (radius, height, etc.) are considered in the path calculation, otherwise they are ignored. </description> </method> </methods> |