diff options
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/Navigation.xml | 42 | ||||
| -rw-r--r-- | doc/classes/Navigation2D.xml | 20 | ||||
| -rw-r--r-- | doc/classes/Navigation2DServer.xml | 22 | ||||
| -rw-r--r-- | doc/classes/NavigationServer.xml | 48 |
4 files changed, 130 insertions, 2 deletions
diff --git a/doc/classes/Navigation.xml b/doc/classes/Navigation.xml index d7da753c61..8057aca127 100644 --- a/doc/classes/Navigation.xml +++ b/doc/classes/Navigation.xml @@ -15,7 +15,7 @@ <description> </description> </method> - <method name="get_simple_path"> + <method name="get_simple_path" qualifiers="const"> <return type="PackedVector3Array"> </return> <argument index="0" name="start" type="Vector3"> @@ -28,6 +28,46 @@ 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> + <method name="get_closest_point_to_segment" qualifiers="const"> + <return type="Vector3"> + </return> + <argument index="0" name="from" type="Vector3"> + </argument> + <argument index="1" name="to" type="Vector3"> + </argument> + <argument index="2" name="use_collision" type="bool" default="false"> + </argument> + <description> + Returns the closest point between the navigation surface and the segment. + </description> + </method> + <method name="get_closest_point" qualifiers="const"> + <return type="Vector3"> + </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"> + </return> + <argument index="0" name="point" 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> + <description> + Returns the owner region RID for the point returned by [method get_closest_point]. + </description> + </method> </methods> <members> <member name="cell_size" type="float" setter="set_cell_size" getter="get_cell_size" default="0.3"> diff --git a/doc/classes/Navigation2D.xml b/doc/classes/Navigation2D.xml index 9ef4a51ff0..20c666106a 100644 --- a/doc/classes/Navigation2D.xml +++ b/doc/classes/Navigation2D.xml @@ -15,7 +15,7 @@ <description> </description> </method> - <method name="get_simple_path"> + <method name="get_simple_path" qualifiers="const"> <return type="PackedVector2Array"> </return> <argument index="0" name="start" type="Vector2"> @@ -28,6 +28,24 @@ Returns the path between two given points. Points are in local coordinate space. If [code]optimize[/code] is [code]true[/code] (the default), the path is smoothed by merging path segments where possible. </description> </method> + <method name="get_closest_point" qualifiers="const"> + <return type="Vector2"> + </return> + <argument index="0" name="point" type="Vector2"> + </argument> + <description> + Returns the point closest to the provided [code]point[/code] on the navigation mesh surface. + </description> + </method> + <method name="get_closest_point_owner" qualifiers="const"> + <return type="RID"> + </return> + <argument index="0" name="point" type="Vector2"> + </argument> + <description> + Returns the owner region RID for the point returned by [method get_closest_point]. + </description> + </method> </methods> <members> <member name="cell_size" type="float" setter="set_cell_size" getter="get_cell_size" default="10.0"> diff --git a/doc/classes/Navigation2DServer.xml b/doc/classes/Navigation2DServer.xml index 67619d708d..22b5d2574e 100644 --- a/doc/classes/Navigation2DServer.xml +++ b/doc/classes/Navigation2DServer.xml @@ -188,6 +188,28 @@ Returns the navigation path to reach the destination from the origin, while avoiding static obstacles. </description> </method> + <method name="map_get_closest_point" qualifiers="const"> + <return type="Vector2"> + </return> + <argument index="0" name="map" type="RID"> + </argument> + <argument index="1" name="point" type="Vector2"> + </argument> + <description> + Returns the point closest to the provided [code]point[/code] on the navigation mesh surface. + </description> + </method> + <method name="map_get_closest_point_owner" qualifiers="const"> + <return type="RID"> + </return> + <argument index="0" name="map" type="RID"> + </argument> + <argument index="1" name="point" type="Vector2"> + </argument> + <description> + Returns the owner region RID for the point returned by [method map_get_closest_point]. + </description> + </method> <method name="map_is_active" qualifiers="const"> <return type="bool"> </return> diff --git a/doc/classes/NavigationServer.xml b/doc/classes/NavigationServer.xml index ad7c56f361..61ea6f47b6 100644 --- a/doc/classes/NavigationServer.xml +++ b/doc/classes/NavigationServer.xml @@ -188,6 +188,54 @@ Returns the navigation path to reach the destination from the origin. </description> </method> + <method name="map_get_closest_point_to_segment" qualifiers="const"> + <return type="Vector3"> + </return> + <argument index="0" name="map" type="RID"> + </argument> + <argument index="1" name="from" type="Vector3"> + </argument> + <argument index="2" name="to" type="Vector3"> + </argument> + <argument index="3" name="use_collision" type="bool" default="false"> + </argument> + <description> + Returns the closest point between the navigation surface and the segment. + </description> + </method> + <method name="map_get_closest_point" qualifiers="const"> + <return type="Vector3"> + </return> + <argument index="0" name="map" type="RID"> + </argument> + <argument index="1" 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="map_get_closest_point_normal" qualifiers="const"> + <return type="Vector3"> + </return> + <argument index="0" name="map" type="RID"> + </argument> + <argument index="1" name="point" type="Vector3"> + </argument> + <description> + Returns the normal for the point returned by [method map_get_closest_point]. + </description> + </method> + <method name="map_get_closest_point_owner" qualifiers="const"> + <return type="RID"> + </return> + <argument index="0" name="map" type="RID"> + </argument> + <argument index="1" name="point" type="Vector3"> + </argument> + <description> + Returns the owner region RID for the point returned by [method map_get_closest_point]. + </description> + </method> <method name="map_get_up" qualifiers="const"> <return type="Vector3"> </return> |