Home Explore Help
Sign In
godotengine
/
godot-docs
mirror of https://github.com/godotengine/godot-docs
Watch 1
Star 1
Fork 0
Files
Branch: 2.1
Branches Tags
godot-docs
/
classes
/
class_astar.rst

class_astar.rst 9.4 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125 
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
    2. 

  2. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
    3. 

  3. 

  4. .. _class_AStar:
    5. 

  5. 

  6. AStar
    7. 

  7. =====
    8. 

  8. 

  9. **Inherits:** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
    10. 

  10. 

  11. **Category:** Core
    12. 

  12. 

  13. Brief Description
    14. 

  14. -----------------
    15. 

  15. 

  16. 

  17. 

  18. Member Functions
    19. 

  19. ----------------
    20. 

  20. 

  21. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    22. 

  22. | void                                     | :ref:`_compute_cost<class_AStar__compute_cost>`  **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id  **)** virtual                                  |
    23. 

  23. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    24. 

  24. | void                                     | :ref:`_estimate_cost<class_AStar__estimate_cost>`  **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id  **)** virtual                                |
    25. 

  25. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    26. 

  26. | 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  **)**       |
    27. 

  27. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    28. 

  28. | :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                           |
    29. 

  29. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    30. 

  30. | void                                     | :ref:`clear<class_AStar_clear>`  **(** **)**                                                                                                                      |
    31. 

  31. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    32. 

  32. | 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  **)** |
    33. 

  33. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    34. 

  34. | void                                     | :ref:`disconnect_points<class_AStar_disconnect_points>`  **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id  **)**                                       |
    35. 

  35. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    36. 

  36. | :ref:`int<class_int>`                    | :ref:`get_available_point_id<class_AStar_get_available_point_id>`  **(** **)** const                                                                              |
    37. 

  37. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    38. 

  38. | :ref:`int<class_int>`                    | :ref:`get_closest_point<class_AStar_get_closest_point>`  **(** :ref:`Vector3<class_vector3>` to_pos  **)** const                                                  |
    39. 

  39. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    40. 

  40. | :ref:`Vector3<class_vector3>`            | :ref:`get_closest_pos_in_segment<class_AStar_get_closest_pos_in_segment>`  **(** :ref:`Vector3<class_vector3>` to_pos  **)** const                                |
    41. 

  41. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    42. 

  42. | :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  **)**                                              |
    43. 

  43. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    44. 

  44. | :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  **)**                                        |
    45. 

  45. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    46. 

  46. | :ref:`Vector3<class_vector3>`            | :ref:`get_point_pos<class_AStar_get_point_pos>`  **(** :ref:`int<class_int>` id  **)** const                                                                      |
    47. 

  47. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    48. 

  48. | :ref:`float<class_float>`                | :ref:`get_point_weight_scale<class_AStar_get_point_weight_scale>`  **(** :ref:`int<class_int>` id  **)** const                                                    |
    49. 

  49. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    50. 

  50. | :ref:`bool<class_bool>`                  | :ref:`has_point<class_AStar_has_point>`  **(** :ref:`int<class_int>` id  **)** const                                                                              |
    51. 

  51. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    52. 

  52. | void                                     | :ref:`remove_point<class_AStar_remove_point>`  **(** :ref:`int<class_int>` id  **)**                                                                              |
    53. 

  53. +------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    54. 

  54. 

  55. Member Function Description
    56. 

  56. ---------------------------
    57. 

  57. 

  58. .. _class_AStar__compute_cost:
    59. 

  59. 

  60. - void  **_compute_cost**  **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id  **)** virtual
    61. 

  61. 

  62. .. _class_AStar__estimate_cost:
    63. 

  63. 

  64. - void  **_estimate_cost**  **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id  **)** virtual
    65. 

  65. 

  66. .. _class_AStar_add_point:
    67. 

  67. 

  68. - void  **add_point**  **(** :ref:`int<class_int>` id, :ref:`Vector3<class_vector3>` pos, :ref:`float<class_float>` weight_scale=1  **)**
    69. 

  69. 

  70. Add a new point at the given position. The ``weight_scale`` has to be 1 or larger.
    71. 

  71. 

  72. .. _class_AStar_are_points_connected:
    73. 

  73. 

  74. - :ref:`bool<class_bool>`  **are_points_connected**  **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id  **)** const
    75. 

  75. 

  76. .. _class_AStar_clear:
    77. 

  77. 

  78. - void  **clear**  **(** **)**
    79. 

  79. 

  80. .. _class_AStar_connect_points:
    81. 

  81. 

  82. - void  **connect_points**  **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id, :ref:`bool<class_bool>` bidirectional=true  **)**
    83. 

  83. 

  84. .. _class_AStar_disconnect_points:
    85. 

  85. 

  86. - void  **disconnect_points**  **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id  **)**
    87. 

  87. 

  88. .. _class_AStar_get_available_point_id:
    89. 

  89. 

  90. - :ref:`int<class_int>`  **get_available_point_id**  **(** **)** const
    91. 

  91. 

  92. .. _class_AStar_get_closest_point:
    93. 

  93. 

  94. - :ref:`int<class_int>`  **get_closest_point**  **(** :ref:`Vector3<class_vector3>` to_pos  **)** const
    95. 

  95. 

  96. .. _class_AStar_get_closest_pos_in_segment:
    97. 

  97. 

  98. - :ref:`Vector3<class_vector3>`  **get_closest_pos_in_segment**  **(** :ref:`Vector3<class_vector3>` to_pos  **)** const
    99. 

  99. 

  100. .. _class_AStar_get_id_path:
    101. 

  101. 

  102. - :ref:`IntArray<class_intarray>`  **get_id_path**  **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id  **)**
    103. 

  103. 

  104. .. _class_AStar_get_point_path:
    105. 

  105. 

  106. - :ref:`Vector3Array<class_vector3array>`  **get_point_path**  **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id  **)**
    107. 

  107. 

  108. .. _class_AStar_get_point_pos:
    109. 

  109. 

  110. - :ref:`Vector3<class_vector3>`  **get_point_pos**  **(** :ref:`int<class_int>` id  **)** const
    111. 

  111. 

  112. .. _class_AStar_get_point_weight_scale:
    113. 

  113. 

  114. - :ref:`float<class_float>`  **get_point_weight_scale**  **(** :ref:`int<class_int>` id  **)** const
    115. 

  115. 

  116. .. _class_AStar_has_point:
    117. 

  117. 

  118. - :ref:`bool<class_bool>`  **has_point**  **(** :ref:`int<class_int>` id  **)** const
    119. 

  119. 

  120. .. _class_AStar_remove_point:
    121. 

  121. 

  122. - void  **remove_point**  **(** :ref:`int<class_int>` id  **)**
    123. 

  123. 

  124. 

  125.