diff options
Diffstat (limited to 'doc/classes/Navigation.xml')
| -rw-r--r-- | doc/classes/Navigation.xml | 69 |
1 files changed, 23 insertions, 46 deletions
diff --git a/doc/classes/Navigation.xml b/doc/classes/Navigation.xml index 58b7d1255e..0000ca6bd5 100644 --- a/doc/classes/Navigation.xml +++ b/doc/classes/Navigation.xml @@ -1,42 +1,42 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Navigation" inherits="Spatial" category="Core" version="3.2"> +<class name="Navigation" inherits="Spatial" version="4.0"> <brief_description> Mesh-based navigation and pathfinding node. </brief_description> <description> - Provides navigation and pathfinding within a collection of [NavigationMesh]es. By default, these will be automatically collected from child [NavigationMeshInstance] nodes, but they can also be added on the fly with [method navmesh_add]. In addition to basic pathfinding, this class also assists with aligning navigation agents with the meshes they are navigating on. + 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. </description> <tutorials> </tutorials> <methods> - <method name="get_closest_point"> + <method name="get_closest_point" qualifiers="const"> <return type="Vector3"> </return> <argument index="0" name="to_point" type="Vector3"> </argument> <description> - Returns the navigation point closest to the point given. Points are in local coordinate space. + Returns the point closest to the provided [code]to_point[/code] on the navigation mesh surface. </description> </method> - <method name="get_closest_point_normal"> + <method name="get_closest_point_normal" qualifiers="const"> <return type="Vector3"> </return> <argument index="0" name="to_point" type="Vector3"> </argument> <description> - Returns the surface normal at the navigation point closest to the point given. Useful for rotating a navigation agent according to the navigation mesh it moves on. + Returns the normal for the point returned by [method get_closest_point]. </description> </method> - <method name="get_closest_point_owner"> - <return type="Object"> + <method name="get_closest_point_owner" qualifiers="const"> + <return type="RID"> </return> <argument index="0" name="to_point" type="Vector3"> </argument> <description> - Returns the owner of the [NavigationMesh] which contains the navigation point closest to the point given. This is usually a [NavigationMeshInstance]. For meshes added via [method navmesh_add], returns the owner that was given (or [code]null[/code] if the [code]owner[/code] parameter was omitted). + Returns the owner region RID for the point returned by [method get_closest_point]. </description> </method> - <method name="get_closest_point_to_segment"> + <method name="get_closest_point_to_segment" qualifiers="const"> <return type="Vector3"> </return> <argument index="0" name="start" type="Vector3"> @@ -46,57 +46,34 @@ <argument index="2" name="use_collision" type="bool" default="false"> </argument> <description> - Returns the navigation point closest to the given line segment. When enabling [code]use_collision[/code], only considers intersection points between segment and navigation meshes. If multiple intersection points are found, the one closest to the segment start point is returned. + Returns the closest point between the navigation surface and the segment. </description> </method> - <method name="get_simple_path"> - <return type="PoolVector3Array"> + <method name="get_rid" qualifiers="const"> + <return type="RID"> </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> - 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="navmesh_add"> - <return type="int"> - </return> - <argument index="0" name="mesh" type="NavigationMesh"> - </argument> - <argument index="1" name="xform" type="Transform"> - </argument> - <argument index="2" name="owner" type="Object" default="null"> - </argument> <description> - Adds a [NavigationMesh]. Returns an ID for use with [method navmesh_remove] or [method navmesh_set_transform]. If given, a [Transform2D] is applied to the polygon. The optional [code]owner[/code] is used as return value for [method get_closest_point_owner]. </description> </method> - <method name="navmesh_remove"> - <return type="void"> + <method name="get_simple_path" qualifiers="const"> + <return type="PackedVector3Array"> </return> - <argument index="0" name="id" type="int"> + <argument index="0" name="start" type="Vector3"> </argument> - <description> - Removes the [NavigationMesh] with the given ID. - </description> - </method> - <method name="navmesh_set_transform"> - <return type="void"> - </return> - <argument index="0" name="id" type="int"> + <argument index="1" name="end" type="Vector3"> </argument> - <argument index="1" name="xform" type="Transform"> + <argument index="2" name="optimize" type="bool" default="true"> </argument> <description> - Sets the transform applied to the [NavigationMesh] with the given ID. + 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> <members> + <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> <member name="up_vector" type="Vector3" setter="set_up_vector" getter="get_up_vector" default="Vector3( 0, 1, 0 )"> Defines which direction is up. By default, this is [code](0, 1, 0)[/code], which is the world's "up" direction. </member> |