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: ace47f729c
Branches Tags
godot-docs
/
classes
/
class_navigationpolygon.rst

class_navigationpolygon.rst 8.9 KB
History Raw

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

  2. .. DO NOT EDIT THIS FILE, but the NavigationPolygon.xml source instead.
    3. 

  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
    4. 

  4. 

  5. .. _class_NavigationPolygon:
    6. 

  6. 

  7. NavigationPolygon
    8. 

  8. =================
    9. 

  9. 

  10. **Inherits:** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
    11. 

  11. 

  12. **Category:** Core
    13. 

  13. 

  14. Brief Description
    15. 

  15. -----------------
    16. 

  16. 

  17. 

  18. 

  19. Member Functions
    20. 

  20. ----------------
    21. 

  21. 

  22. +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    23. 

  23. | void                                             | :ref:`add_outline<class_NavigationPolygon_add_outline>`  **(** :ref:`PoolVector2Array<class_poolvector2array>` outline  **)**                                                |
    24. 

  24. +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    25. 

  25. | void                                             | :ref:`add_outline_at_index<class_NavigationPolygon_add_outline_at_index>`  **(** :ref:`PoolVector2Array<class_poolvector2array>` outline, :ref:`int<class_int>` index  **)** |
    26. 

  26. +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    27. 

  27. | void                                             | :ref:`add_polygon<class_NavigationPolygon_add_polygon>`  **(** :ref:`PoolIntArray<class_poolintarray>` polygon  **)**                                                        |
    28. 

  28. +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    29. 

  29. | void                                             | :ref:`clear_outlines<class_NavigationPolygon_clear_outlines>`  **(** **)**                                                                                                   |
    30. 

  30. +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    31. 

  31. | void                                             | :ref:`clear_polygons<class_NavigationPolygon_clear_polygons>`  **(** **)**                                                                                                   |
    32. 

  32. +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    33. 

  33. | :ref:`PoolVector2Array<class_poolvector2array>`  | :ref:`get_outline<class_NavigationPolygon_get_outline>`  **(** :ref:`int<class_int>` idx  **)** const                                                                        |
    34. 

  34. +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    35. 

  35. | :ref:`int<class_int>`                            | :ref:`get_outline_count<class_NavigationPolygon_get_outline_count>`  **(** **)** const                                                                                       |
    36. 

  36. +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    37. 

  37. | :ref:`PoolIntArray<class_poolintarray>`          | :ref:`get_polygon<class_NavigationPolygon_get_polygon>`  **(** :ref:`int<class_int>` idx  **)**                                                                              |
    38. 

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

  39. | :ref:`int<class_int>`                            | :ref:`get_polygon_count<class_NavigationPolygon_get_polygon_count>`  **(** **)** const                                                                                       |
    40. 

  40. +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    41. 

  41. | :ref:`PoolVector2Array<class_poolvector2array>`  | :ref:`get_vertices<class_NavigationPolygon_get_vertices>`  **(** **)** const                                                                                                 |
    42. 

  42. +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    43. 

  43. | void                                             | :ref:`make_polygons_from_outlines<class_NavigationPolygon_make_polygons_from_outlines>`  **(** **)**                                                                         |
    44. 

  44. +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    45. 

  45. | void                                             | :ref:`remove_outline<class_NavigationPolygon_remove_outline>`  **(** :ref:`int<class_int>` idx  **)**                                                                        |
    46. 

  46. +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    47. 

  47. | void                                             | :ref:`set_outline<class_NavigationPolygon_set_outline>`  **(** :ref:`int<class_int>` idx, :ref:`PoolVector2Array<class_poolvector2array>` outline  **)**                     |
    48. 

  48. +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    49. 

  49. | void                                             | :ref:`set_vertices<class_NavigationPolygon_set_vertices>`  **(** :ref:`PoolVector2Array<class_poolvector2array>` vertices  **)**                                             |
    50. 

  50. +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    51. 

  51. 

  52. Member Variables
    53. 

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

  54. 

  55. - :ref:`Array<class_array>` **outlines**
    56. 

  56. - :ref:`Array<class_array>` **polygons**
    57. 

  57. - :ref:`PoolVector2Array<class_poolvector2array>` **vertices**
    58. 

  58. 

  59. Member Function Description
    60. 

  60. ---------------------------
    61. 

  61. 

  62. .. _class_NavigationPolygon_add_outline:
    63. 

  63. 

  64. - void  **add_outline**  **(** :ref:`PoolVector2Array<class_poolvector2array>` outline  **)**
    65. 

  65. 

  66. .. _class_NavigationPolygon_add_outline_at_index:
    67. 

  67. 

  68. - void  **add_outline_at_index**  **(** :ref:`PoolVector2Array<class_poolvector2array>` outline, :ref:`int<class_int>` index  **)**
    69. 

  69. 

  70. .. _class_NavigationPolygon_add_polygon:
    71. 

  71. 

  72. - void  **add_polygon**  **(** :ref:`PoolIntArray<class_poolintarray>` polygon  **)**
    73. 

  73. 

  74. .. _class_NavigationPolygon_clear_outlines:
    75. 

  75. 

  76. - void  **clear_outlines**  **(** **)**
    77. 

  77. 

  78. .. _class_NavigationPolygon_clear_polygons:
    79. 

  79. 

  80. - void  **clear_polygons**  **(** **)**
    81. 

  81. 

  82. .. _class_NavigationPolygon_get_outline:
    83. 

  83. 

  84. - :ref:`PoolVector2Array<class_poolvector2array>`  **get_outline**  **(** :ref:`int<class_int>` idx  **)** const
    85. 

  85. 

  86. .. _class_NavigationPolygon_get_outline_count:
    87. 

  87. 

  88. - :ref:`int<class_int>`  **get_outline_count**  **(** **)** const
    89. 

  89. 

  90. .. _class_NavigationPolygon_get_polygon:
    91. 

  91. 

  92. - :ref:`PoolIntArray<class_poolintarray>`  **get_polygon**  **(** :ref:`int<class_int>` idx  **)**
    93. 

  93. 

  94. .. _class_NavigationPolygon_get_polygon_count:
    95. 

  95. 

  96. - :ref:`int<class_int>`  **get_polygon_count**  **(** **)** const
    97. 

  97. 

  98. .. _class_NavigationPolygon_get_vertices:
    99. 

  99. 

  100. - :ref:`PoolVector2Array<class_poolvector2array>`  **get_vertices**  **(** **)** const
    101. 

  101. 

  102. .. _class_NavigationPolygon_make_polygons_from_outlines:
    103. 

  103. 

  104. - void  **make_polygons_from_outlines**  **(** **)**
    105. 

  105. 

  106. .. _class_NavigationPolygon_remove_outline:
    107. 

  107. 

  108. - void  **remove_outline**  **(** :ref:`int<class_int>` idx  **)**
    109. 

  109. 

  110. .. _class_NavigationPolygon_set_outline:
    111. 

  111. 

  112. - void  **set_outline**  **(** :ref:`int<class_int>` idx, :ref:`PoolVector2Array<class_poolvector2array>` outline  **)**
    113. 

  113. 

  114. .. _class_NavigationPolygon_set_vertices:
    115. 

  115. 

  116. - void  **set_vertices**  **(** :ref:`PoolVector2Array<class_poolvector2array>` vertices  **)**
    117. 

  117. 

  118.