mirror of
https://github.com/godotengine/godot.git
synced 2025-10-31 21:51:22 +00:00
f7f6115f76
- Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
79 lines
3 KiB
XML
79 lines
3 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="Navigation2D" inherits="Node2D" category="Core" version="3.2">
|
|
<brief_description>
|
|
2D navigation and pathfinding node.
|
|
</brief_description>
|
|
<description>
|
|
Navigation2D provides navigation and pathfinding within a 2D area, specified as a collection of [NavigationPolygon] resources. By default, these are automatically collected from child [NavigationPolygonInstance] nodes, but they can also be added on the fly with [method navpoly_add].
|
|
</description>
|
|
<tutorials>
|
|
</tutorials>
|
|
<methods>
|
|
<method name="get_closest_point">
|
|
<return type="Vector2">
|
|
</return>
|
|
<argument index="0" name="to_point" type="Vector2">
|
|
</argument>
|
|
<description>
|
|
Returns the navigation point closest to the point given. Points are in local coordinate space.
|
|
</description>
|
|
</method>
|
|
<method name="get_closest_point_owner">
|
|
<return type="Object">
|
|
</return>
|
|
<argument index="0" name="to_point" type="Vector2">
|
|
</argument>
|
|
<description>
|
|
Returns the owner of the [NavigationPolygon] which contains the navigation point closest to the point given. This is usually a [NavigationPolygonInstance]. For polygons added via [method navpoly_add], returns the owner that was given (or [code]null[/code] if the [code]owner[/code] parameter was omitted).
|
|
</description>
|
|
</method>
|
|
<method name="get_simple_path">
|
|
<return type="PoolVector2Array">
|
|
</return>
|
|
<argument index="0" name="start" type="Vector2">
|
|
</argument>
|
|
<argument index="1" name="end" type="Vector2">
|
|
</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 path is smoothed by merging path segments where possible.
|
|
</description>
|
|
</method>
|
|
<method name="navpoly_add">
|
|
<return type="int">
|
|
</return>
|
|
<argument index="0" name="mesh" type="NavigationPolygon">
|
|
</argument>
|
|
<argument index="1" name="xform" type="Transform2D">
|
|
</argument>
|
|
<argument index="2" name="owner" type="Object" default="null">
|
|
</argument>
|
|
<description>
|
|
Adds a [NavigationPolygon]. Returns an ID for use with [method navpoly_remove] or [method navpoly_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="navpoly_remove">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="id" type="int">
|
|
</argument>
|
|
<description>
|
|
Removes the [NavigationPolygon] with the given ID.
|
|
</description>
|
|
</method>
|
|
<method name="navpoly_set_transform">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="id" type="int">
|
|
</argument>
|
|
<argument index="1" name="xform" type="Transform2D">
|
|
</argument>
|
|
<description>
|
|
Sets the transform applied to the [NavigationPolygon] with the given ID.
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<constants>
|
|
</constants>
|
|
</class>
|