asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
virtualx-engine/doc/classes/Navigation2D.xml

60 lines
2.1 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
Update docs to version 4.0
2020-02-01 02:03:48 +01:00
<class name="Navigation2D" inherits="Node2D" version="4.0">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<brief_description>
Add Navigation2D docs
2018-04-08 22:42:09 +02:00
2D navigation and pathfinding node.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</brief_description>
<description>
Renamed NavigationPolygonInstance to NavigationRegion2D
2020-02-28 08:05:04 +01:00
Navigation2D provides navigation and pathfinding within a 2D area, specified as a collection of [NavigationPolygon] resources. These are automatically collected from child [NavigationRegion2D] nodes.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
<tutorials>
Link to demos from within the class reference
2020-10-01 10:34:47 +02:00
<link title="2D Navigation Demo">https://godotengine.org/asset-library/asset/117</link>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</tutorials>
<methods>
doc: Sync classref with current source
2020-02-19 09:55:47 +01:00
<method name="get_closest_point" qualifiers="const">
<return type="Vector2">
</return>
<argument index="0" name="to_point" type="Vector2">
</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_owner" qualifiers="const">
<return type="RID">
</return>
<argument index="0" name="to_point" type="Vector2">
</argument>
<description>
Returns the owner region RID for the point returned by [method get_closest_point].
</description>
</method>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
<method name="get_rid" qualifiers="const">
<return type="RID">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</return>
<description>
</description>
</method>
Added utility functions to the new NavigationServer: - Vector3 get_closest_point_to_segment(const Vector3 &p_from, const Vector3 &p_to, const bool &p_use_collision = false); - Vector3 get_closest_point(const Vector3 &p_point); - Vector3 get_closest_point_normal(const Vector3 &p_point); - Object *get_closest_point_owner(const Vector3 &p_point);
2020-02-18 17:08:34 +01:00
<method name="get_simple_path" qualifiers="const">
doc: Sync classref with current source Handle removal of Pool*Array types and other recent changes.
2020-02-18 13:59:24 +01:00
<return type="PackedVector2Array">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</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>
Add Navigation2D docs
2018-04-08 22:42:09 +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 path is smoothed by merging path segments where possible.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
</methods>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
<members>
<member name="cell_size" type="float" setter="set_cell_size" getter="get_cell_size" default="10.0">
</member>
<member name="edge_connection_margin" type="float" setter="set_edge_connection_margin" getter="get_edge_connection_margin" default="100.0">
</member>
</members>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<constants>
</constants>
</class>
Reference in a new issue Copy permalink