mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
125 lines
9.4 KiB
ReStructuredText
125 lines
9.4 KiB
ReStructuredText
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
|
|
|
|
.. _class_AStar:
|
|
|
|
AStar
|
|
=====
|
|
|
|
**Inherits:** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
|
|
|
**Category:** Core
|
|
|
|
Brief Description
|
|
-----------------
|
|
|
|
|
|
|
|
Member Functions
|
|
----------------
|
|
|
|
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`_compute_cost<class_AStar__compute_cost>` **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** virtual |
|
|
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`_estimate_cost<class_AStar__estimate_cost>` **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** virtual |
|
|
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`add_point<class_AStar_add_point>` **(** :ref:`int<class_int>` id, :ref:`Vector3<class_vector3>` pos, :ref:`float<class_float>` weight_scale=1 **)** |
|
|
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`are_points_connected<class_AStar_are_points_connected>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id **)** const |
|
|
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`clear<class_AStar_clear>` **(** **)** |
|
|
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`connect_points<class_AStar_connect_points>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id, :ref:`bool<class_bool>` bidirectional=true **)** |
|
|
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`disconnect_points<class_AStar_disconnect_points>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id **)** |
|
|
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`get_available_point_id<class_AStar_get_available_point_id>` **(** **)** const |
|
|
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`get_closest_point<class_AStar_get_closest_point>` **(** :ref:`Vector3<class_vector3>` to_pos **)** const |
|
|
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Vector3<class_vector3>` | :ref:`get_closest_pos_in_segment<class_AStar_get_closest_pos_in_segment>` **(** :ref:`Vector3<class_vector3>` to_pos **)** const |
|
|
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`IntArray<class_intarray>` | :ref:`get_id_path<class_AStar_get_id_path>` **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** |
|
|
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Vector3Array<class_vector3array>` | :ref:`get_point_path<class_AStar_get_point_path>` **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** |
|
|
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Vector3<class_vector3>` | :ref:`get_point_pos<class_AStar_get_point_pos>` **(** :ref:`int<class_int>` id **)** const |
|
|
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`float<class_float>` | :ref:`get_point_weight_scale<class_AStar_get_point_weight_scale>` **(** :ref:`int<class_int>` id **)** const |
|
|
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`has_point<class_AStar_has_point>` **(** :ref:`int<class_int>` id **)** const |
|
|
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`remove_point<class_AStar_remove_point>` **(** :ref:`int<class_int>` id **)** |
|
|
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
Member Function Description
|
|
---------------------------
|
|
|
|
.. _class_AStar__compute_cost:
|
|
|
|
- void **_compute_cost** **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** virtual
|
|
|
|
.. _class_AStar__estimate_cost:
|
|
|
|
- void **_estimate_cost** **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** virtual
|
|
|
|
.. _class_AStar_add_point:
|
|
|
|
- void **add_point** **(** :ref:`int<class_int>` id, :ref:`Vector3<class_vector3>` pos, :ref:`float<class_float>` weight_scale=1 **)**
|
|
|
|
Add a new point at the given position. The ``weight_scale`` has to be 1 or larger.
|
|
|
|
.. _class_AStar_are_points_connected:
|
|
|
|
- :ref:`bool<class_bool>` **are_points_connected** **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id **)** const
|
|
|
|
.. _class_AStar_clear:
|
|
|
|
- void **clear** **(** **)**
|
|
|
|
.. _class_AStar_connect_points:
|
|
|
|
- void **connect_points** **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id, :ref:`bool<class_bool>` bidirectional=true **)**
|
|
|
|
.. _class_AStar_disconnect_points:
|
|
|
|
- void **disconnect_points** **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id **)**
|
|
|
|
.. _class_AStar_get_available_point_id:
|
|
|
|
- :ref:`int<class_int>` **get_available_point_id** **(** **)** const
|
|
|
|
.. _class_AStar_get_closest_point:
|
|
|
|
- :ref:`int<class_int>` **get_closest_point** **(** :ref:`Vector3<class_vector3>` to_pos **)** const
|
|
|
|
.. _class_AStar_get_closest_pos_in_segment:
|
|
|
|
- :ref:`Vector3<class_vector3>` **get_closest_pos_in_segment** **(** :ref:`Vector3<class_vector3>` to_pos **)** const
|
|
|
|
.. _class_AStar_get_id_path:
|
|
|
|
- :ref:`IntArray<class_intarray>` **get_id_path** **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)**
|
|
|
|
.. _class_AStar_get_point_path:
|
|
|
|
- :ref:`Vector3Array<class_vector3array>` **get_point_path** **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)**
|
|
|
|
.. _class_AStar_get_point_pos:
|
|
|
|
- :ref:`Vector3<class_vector3>` **get_point_pos** **(** :ref:`int<class_int>` id **)** const
|
|
|
|
.. _class_AStar_get_point_weight_scale:
|
|
|
|
- :ref:`float<class_float>` **get_point_weight_scale** **(** :ref:`int<class_int>` id **)** const
|
|
|
|
.. _class_AStar_has_point:
|
|
|
|
- :ref:`bool<class_bool>` **has_point** **(** :ref:`int<class_int>` id **)** const
|
|
|
|
.. _class_AStar_remove_point:
|
|
|
|
- void **remove_point** **(** :ref:`int<class_int>` id **)**
|
|
|
|
|