class_astar.rst 7.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
  3. .. _class_AStar:
  4. AStar
  5. =====
  6. **Inherits:** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
  7. **Category:** Core
  8. Brief Description
  9. -----------------
  10. Member Functions
  11. ----------------
  12. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
  13. | 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 **)** |
  14. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
  15. | :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 |
  16. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
  17. | void | :ref:`clear<class_AStar_clear>` **(** **)** |
  18. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
  19. | void | :ref:`connect_points<class_AStar_connect_points>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id **)** |
  20. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
  21. | void | :ref:`disconnect_points<class_AStar_disconnect_points>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id **)** |
  22. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
  23. | :ref:`int<class_int>` | :ref:`get_available_point_id<class_AStar_get_available_point_id>` **(** **)** const |
  24. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
  25. | :ref:`int<class_int>` | :ref:`get_closest_point<class_AStar_get_closest_point>` **(** :ref:`Vector3<class_vector3>` to_pos **)** const |
  26. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
  27. | :ref:`Vector3<class_vector3>` | :ref:`get_closest_pos_in_segment<class_AStar_get_closest_pos_in_segment>` **(** :ref:`Vector3<class_vector3>` to_pos **)** const |
  28. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
  29. | :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 **)** |
  30. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
  31. | :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 **)** |
  32. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
  33. | :ref:`Vector3<class_vector3>` | :ref:`get_point_pos<class_AStar_get_point_pos>` **(** :ref:`int<class_int>` id **)** const |
  34. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
  35. | :ref:`float<class_float>` | :ref:`get_point_weight_scale<class_AStar_get_point_weight_scale>` **(** :ref:`int<class_int>` id **)** const |
  36. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
  37. | void | :ref:`remove_point<class_AStar_remove_point>` **(** :ref:`int<class_int>` id **)** |
  38. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
  39. Member Function Description
  40. ---------------------------
  41. .. _class_AStar_add_point:
  42. - void **add_point** **(** :ref:`int<class_int>` id, :ref:`Vector3<class_vector3>` pos, :ref:`float<class_float>` weight_scale=1 **)**
  43. .. _class_AStar_are_points_connected:
  44. - :ref:`bool<class_bool>` **are_points_connected** **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id **)** const
  45. .. _class_AStar_clear:
  46. - void **clear** **(** **)**
  47. .. _class_AStar_connect_points:
  48. - void **connect_points** **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id **)**
  49. .. _class_AStar_disconnect_points:
  50. - void **disconnect_points** **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id **)**
  51. .. _class_AStar_get_available_point_id:
  52. - :ref:`int<class_int>` **get_available_point_id** **(** **)** const
  53. .. _class_AStar_get_closest_point:
  54. - :ref:`int<class_int>` **get_closest_point** **(** :ref:`Vector3<class_vector3>` to_pos **)** const
  55. .. _class_AStar_get_closest_pos_in_segment:
  56. - :ref:`Vector3<class_vector3>` **get_closest_pos_in_segment** **(** :ref:`Vector3<class_vector3>` to_pos **)** const
  57. .. _class_AStar_get_id_path:
  58. - :ref:`IntArray<class_intarray>` **get_id_path** **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)**
  59. .. _class_AStar_get_point_path:
  60. - :ref:`Vector3Array<class_vector3array>` **get_point_path** **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)**
  61. .. _class_AStar_get_point_pos:
  62. - :ref:`Vector3<class_vector3>` **get_point_pos** **(** :ref:`int<class_int>` id **)** const
  63. .. _class_AStar_get_point_weight_scale:
  64. - :ref:`float<class_float>` **get_point_weight_scale** **(** :ref:`int<class_int>` id **)** const
  65. .. _class_AStar_remove_point:
  66. - void **remove_point** **(** :ref:`int<class_int>` id **)**