mirror of
https://github.com/godotengine/godot.git
synced 2025-10-31 05:31:01 +00:00
83 lines
3.2 KiB
XML
83 lines
3.2 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="Navigation3D" inherits="Node3D" version="4.0">
|
|
<brief_description>
|
|
Mesh-based navigation and pathfinding node.
|
|
</brief_description>
|
|
<description>
|
|
Provides navigation and pathfinding within a collection of [NavigationMesh]es. These will be automatically collected from child [NavigationRegion3D] 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" 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_closest_point_normal" qualifiers="const">
|
|
<return type="Vector3">
|
|
</return>
|
|
<argument index="0" name="to_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="to_point" type="Vector3">
|
|
</argument>
|
|
<description>
|
|
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="start" type="Vector3">
|
|
</argument>
|
|
<argument index="1" name="end" 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_rid" qualifiers="const">
|
|
<return type="RID">
|
|
</return>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="get_simple_path" qualifiers="const">
|
|
<return type="PackedVector3Array">
|
|
</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>
|
|
</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>
|
|
</members>
|
|
<constants>
|
|
</constants>
|
|
</class>
|