class_navigationmesh.rst 5.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the NavigationMesh.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_NavigationMesh:
  5. NavigationMesh
  6. ==============
  7. **Inherits:** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Member Functions
  12. ----------------
  13. +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
  14. | void | :ref:`add_polygon<class_NavigationMesh_add_polygon>` **(** :ref:`PoolIntArray<class_poolintarray>` polygon **)** |
  15. +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
  16. | void | :ref:`clear_polygons<class_NavigationMesh_clear_polygons>` **(** **)** |
  17. +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
  18. | void | :ref:`create_from_mesh<class_NavigationMesh_create_from_mesh>` **(** :ref:`Mesh<class_mesh>` mesh **)** |
  19. +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
  20. | :ref:`PoolIntArray<class_poolintarray>` | :ref:`get_polygon<class_NavigationMesh_get_polygon>` **(** :ref:`int<class_int>` idx **)** |
  21. +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
  22. | :ref:`int<class_int>` | :ref:`get_polygon_count<class_NavigationMesh_get_polygon_count>` **(** **)** const |
  23. +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
  24. | :ref:`PoolVector3Array<class_poolvector3array>` | :ref:`get_vertices<class_NavigationMesh_get_vertices>` **(** **)** const |
  25. +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
  26. | void | :ref:`set_vertices<class_NavigationMesh_set_vertices>` **(** :ref:`PoolVector3Array<class_poolvector3array>` vertices **)** |
  27. +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
  28. Member Variables
  29. ----------------
  30. .. _class_NavigationMesh_agent/height:
  31. - :ref:`float<class_float>` **agent/height**
  32. .. _class_NavigationMesh_agent/max_climb:
  33. - :ref:`float<class_float>` **agent/max_climb**
  34. .. _class_NavigationMesh_agent/max_slope:
  35. - :ref:`float<class_float>` **agent/max_slope**
  36. .. _class_NavigationMesh_agent/radius:
  37. - :ref:`float<class_float>` **agent/radius**
  38. .. _class_NavigationMesh_cell/height:
  39. - :ref:`float<class_float>` **cell/height**
  40. .. _class_NavigationMesh_cell/size:
  41. - :ref:`float<class_float>` **cell/size**
  42. .. _class_NavigationMesh_detail/sample_distance:
  43. - :ref:`float<class_float>` **detail/sample_distance**
  44. .. _class_NavigationMesh_detail/sample_max_error:
  45. - :ref:`float<class_float>` **detail/sample_max_error**
  46. .. _class_NavigationMesh_edge/max_error:
  47. - :ref:`float<class_float>` **edge/max_error**
  48. .. _class_NavigationMesh_edge/max_length:
  49. - :ref:`float<class_float>` **edge/max_length**
  50. .. _class_NavigationMesh_filter/filter_walkable_low_height_spans:
  51. - :ref:`bool<class_bool>` **filter/filter_walkable_low_height_spans**
  52. .. _class_NavigationMesh_filter/ledge_spans:
  53. - :ref:`bool<class_bool>` **filter/ledge_spans**
  54. .. _class_NavigationMesh_filter/low_hanging_obstacles:
  55. - :ref:`bool<class_bool>` **filter/low_hanging_obstacles**
  56. .. _class_NavigationMesh_polygon/verts_per_poly:
  57. - :ref:`float<class_float>` **polygon/verts_per_poly**
  58. .. _class_NavigationMesh_region/merge_size:
  59. - :ref:`float<class_float>` **region/merge_size**
  60. .. _class_NavigationMesh_region/min_size:
  61. - :ref:`float<class_float>` **region/min_size**
  62. .. _class_NavigationMesh_sample_partition_type/sample_partition_type:
  63. - :ref:`int<class_int>` **sample_partition_type/sample_partition_type**
  64. Numeric Constants
  65. -----------------
  66. - **SAMPLE_PARTITION_WATERSHED** = **0**
  67. - **SAMPLE_PARTITION_MONOTONE** = **1**
  68. - **SAMPLE_PARTITION_LAYERS** = **2**
  69. Member Function Description
  70. ---------------------------
  71. .. _class_NavigationMesh_add_polygon:
  72. - void **add_polygon** **(** :ref:`PoolIntArray<class_poolintarray>` polygon **)**
  73. .. _class_NavigationMesh_clear_polygons:
  74. - void **clear_polygons** **(** **)**
  75. .. _class_NavigationMesh_create_from_mesh:
  76. - void **create_from_mesh** **(** :ref:`Mesh<class_mesh>` mesh **)**
  77. .. _class_NavigationMesh_get_polygon:
  78. - :ref:`PoolIntArray<class_poolintarray>` **get_polygon** **(** :ref:`int<class_int>` idx **)**
  79. .. _class_NavigationMesh_get_polygon_count:
  80. - :ref:`int<class_int>` **get_polygon_count** **(** **)** const
  81. .. _class_NavigationMesh_get_vertices:
  82. - :ref:`PoolVector3Array<class_poolvector3array>` **get_vertices** **(** **)** const
  83. .. _class_NavigationMesh_set_vertices:
  84. - void **set_vertices** **(** :ref:`PoolVector3Array<class_poolvector3array>` vertices **)**