2017-09-12 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
2020-02-01 02:03:48 +01:00
<class name= "Navigation" inherits= "Spatial" version= "4.0" >
2017-09-12 22:42:36 +02:00
<brief_description >
2018-04-10 07:20:12 +02:00
Mesh-based navigation and pathfinding node.
2017-09-12 22:42:36 +02:00
</brief_description>
<description >
2020-02-12 09:59:06 +01:00
Provides navigation and pathfinding within a collection of [NavigationMesh]es. These will be automatically collected from child [NavigationMeshInstance] nodes. In addition to basic pathfinding, this class also assists with aligning navigation agents with the meshes they are navigating on.
2017-09-12 22:42:36 +02:00
</description>
<tutorials >
</tutorials>
<methods >
2020-02-12 09:59:06 +01:00
<method name= "get_rid" qualifiers= "const" >
<return type= "RID" >
2017-09-12 22:42:36 +02:00
</return>
<description >
</description>
</method>
2020-02-18 17:08:34 +01:00
<method name= "get_simple_path" qualifiers= "const" >
2020-02-18 13:59:24 +01:00
<return type= "PackedVector3Array" >
2017-09-12 22:42:36 +02:00
</return>
<argument index= "0" name= "start" type= "Vector3" >
</argument>
<argument index= "1" name= "end" type= "Vector3" >
</argument>
<argument index= "2" name= "optimize" type= "bool" default= "true" >
</argument>
<description >
2019-06-11 10:19:16 +02:00
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.
2017-09-12 22:42:36 +02:00
</description>
</method>
2020-02-18 17:08:34 +01:00
<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>
2017-09-12 22:42:36 +02:00
</methods>
<members >
2020-02-12 09:59:06 +01:00
<member name= "cell_size" type= "float" setter= "set_cell_size" getter= "get_cell_size" default= "0.3" >
</member>
<member name= "edge_connection_margin" type= "float" setter= "set_edge_connection_margin" getter= "get_edge_connection_margin" default= "5.0" >
</member>
2019-06-29 12:38:01 +02:00
<member name= "up_vector" type= "Vector3" setter= "set_up_vector" getter= "get_up_vector" default= "Vector3( 0, 1, 0 )" >
2019-06-22 01:04:47 +02:00
Defines which direction is up. By default, this is [code](0, 1, 0)[/code], which is the world's "up" direction.
2017-09-12 22:42:36 +02:00
</member>
</members>
<constants >
</constants>
</class>