Home Explore Help
Sign In
Godot
/
godot-docs
mirror of https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: 75b51ec2f4
Branches Tags
godot-docs
/
classes
/
class_polygonpathfinder.rst

class_polygonpathfinder.rst 6.5 KB
History Raw

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091 
  1. :github_url: hide
    2. 

  2. 

  3. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
    4. 

  4. .. DO NOT EDIT THIS FILE, but the PolygonPathFinder.xml source instead.
    5. 

  5. .. The source is found in doc/classes or modules/<name>/doc_classes.
    6. 

  6. 

  7. .. _class_PolygonPathFinder:
    8. 

  8. 

  9. PolygonPathFinder
    10. 

  10. =================
    11. 

  11. 

  12. **Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
    13. 

  13. 

  14. 

  15. 

  16. Methods
    17. 

  17. -------
    18. 

  18. 

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

  20. | :ref:`PackedVector2Array<class_PackedVector2Array>` | :ref:`find_path<class_PolygonPathFinder_method_find_path>` **(** :ref:`Vector2<class_Vector2>` from, :ref:`Vector2<class_Vector2>` to **)**                                            |
    21. 

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

  22. | :ref:`Rect2<class_Rect2>`                           | :ref:`get_bounds<class_PolygonPathFinder_method_get_bounds>` **(** **)** |const|                                                                                                       |
    23. 

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

  24. | :ref:`Vector2<class_Vector2>`                       | :ref:`get_closest_point<class_PolygonPathFinder_method_get_closest_point>` **(** :ref:`Vector2<class_Vector2>` point **)** |const|                                                     |
    25. 

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

  26. | :ref:`PackedVector2Array<class_PackedVector2Array>` | :ref:`get_intersections<class_PolygonPathFinder_method_get_intersections>` **(** :ref:`Vector2<class_Vector2>` from, :ref:`Vector2<class_Vector2>` to **)** |const|                    |
    27. 

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

  28. | :ref:`float<class_float>`                           | :ref:`get_point_penalty<class_PolygonPathFinder_method_get_point_penalty>` **(** :ref:`int<class_int>` idx **)** |const|                                                               |
    29. 

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

  30. | :ref:`bool<class_bool>`                             | :ref:`is_point_inside<class_PolygonPathFinder_method_is_point_inside>` **(** :ref:`Vector2<class_Vector2>` point **)** |const|                                                         |
    31. 

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

  32. | void                                                | :ref:`set_point_penalty<class_PolygonPathFinder_method_set_point_penalty>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` penalty **)**                                    |
    33. 

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

  34. | void                                                | :ref:`setup<class_PolygonPathFinder_method_setup>` **(** :ref:`PackedVector2Array<class_PackedVector2Array>` points, :ref:`PackedInt32Array<class_PackedInt32Array>` connections **)** |
    35. 

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

  36. 

  37. Method Descriptions
    38. 

  38. -------------------
    39. 

  39. 

  40. .. _class_PolygonPathFinder_method_find_path:
    41. 

  41. 

  42. - :ref:`PackedVector2Array<class_PackedVector2Array>` **find_path** **(** :ref:`Vector2<class_Vector2>` from, :ref:`Vector2<class_Vector2>` to **)**
    43. 

  43. 

  44. ----
    45. 

  45. 

  46. .. _class_PolygonPathFinder_method_get_bounds:
    47. 

  47. 

  48. - :ref:`Rect2<class_Rect2>` **get_bounds** **(** **)** |const|
    49. 

  49. 

  50. ----
    51. 

  51. 

  52. .. _class_PolygonPathFinder_method_get_closest_point:
    53. 

  53. 

  54. - :ref:`Vector2<class_Vector2>` **get_closest_point** **(** :ref:`Vector2<class_Vector2>` point **)** |const|
    55. 

  55. 

  56. ----
    57. 

  57. 

  58. .. _class_PolygonPathFinder_method_get_intersections:
    59. 

  59. 

  60. - :ref:`PackedVector2Array<class_PackedVector2Array>` **get_intersections** **(** :ref:`Vector2<class_Vector2>` from, :ref:`Vector2<class_Vector2>` to **)** |const|
    61. 

  61. 

  62. ----
    63. 

  63. 

  64. .. _class_PolygonPathFinder_method_get_point_penalty:
    65. 

  65. 

  66. - :ref:`float<class_float>` **get_point_penalty** **(** :ref:`int<class_int>` idx **)** |const|
    67. 

  67. 

  68. ----
    69. 

  69. 

  70. .. _class_PolygonPathFinder_method_is_point_inside:
    71. 

  71. 

  72. - :ref:`bool<class_bool>` **is_point_inside** **(** :ref:`Vector2<class_Vector2>` point **)** |const|
    73. 

  73. 

  74. ----
    75. 

  75. 

  76. .. _class_PolygonPathFinder_method_set_point_penalty:
    77. 

  77. 

  78. - void **set_point_penalty** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` penalty **)**
    79. 

  79. 

  80. ----
    81. 

  81. 

  82. .. _class_PolygonPathFinder_method_setup:
    83. 

  83. 

  84. - void **setup** **(** :ref:`PackedVector2Array<class_PackedVector2Array>` points, :ref:`PackedInt32Array<class_PackedInt32Array>` connections **)**
    85. 

  85. 

  86. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
    87. 

  87. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
    88. 

  88. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
    89. 

  89. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
    90. 

  90. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
    91. 

  91. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
    92.