godot-docs/classes/class_navigationmesh.rst

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the NavigationMesh.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_NavigationMesh:

NavigationMesh
==============

**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
**Category:** Core

Brief Description
-----------------



Methods
-------

+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void                                             | :ref:`add_polygon<class_NavigationMesh_add_polygon>` **(** :ref:`PoolIntArray<class_PoolIntArray>` polygon **)**            |
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void                                             | :ref:`clear_polygons<class_NavigationMesh_clear_polygons>` **(** **)**                                                      |
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void                                             | :ref:`create_from_mesh<class_NavigationMesh_create_from_mesh>` **(** :ref:`Mesh<class_Mesh>` mesh **)**                     |
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolIntArray<class_PoolIntArray>`          | :ref:`get_polygon<class_NavigationMesh_get_polygon>` **(** :ref:`int<class_int>` idx **)**                                  |
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                            | :ref:`get_polygon_count<class_NavigationMesh_get_polygon_count>` **(** **)** const                                          |
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolVector3Array<class_PoolVector3Array>`  | :ref:`get_vertices<class_NavigationMesh_get_vertices>` **(** **)** const                                                    |
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void                                             | :ref:`set_vertices<class_NavigationMesh_set_vertices>` **(** :ref:`PoolVector3Array<class_PoolVector3Array>` vertices **)** |
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+

Constants
---------

- **SAMPLE_PARTITION_WATERSHED** = **0**
- **SAMPLE_PARTITION_MONOTONE** = **1**
- **SAMPLE_PARTITION_LAYERS** = **2**

Property Descriptions
---------------------

  .. _class_NavigationMesh_agent/height:

- :ref:`float<class_float>` **agent/height**

  .. _class_NavigationMesh_agent/max_climb:

- :ref:`float<class_float>` **agent/max_climb**

  .. _class_NavigationMesh_agent/max_slope:

- :ref:`float<class_float>` **agent/max_slope**

  .. _class_NavigationMesh_agent/radius:

- :ref:`float<class_float>` **agent/radius**

  .. _class_NavigationMesh_cell/height:

- :ref:`float<class_float>` **cell/height**

  .. _class_NavigationMesh_cell/size:

- :ref:`float<class_float>` **cell/size**

  .. _class_NavigationMesh_detail/sample_distance:

- :ref:`float<class_float>` **detail/sample_distance**

  .. _class_NavigationMesh_detail/sample_max_error:

- :ref:`float<class_float>` **detail/sample_max_error**

  .. _class_NavigationMesh_edge/max_error:

- :ref:`float<class_float>` **edge/max_error**

  .. _class_NavigationMesh_edge/max_length:

- :ref:`float<class_float>` **edge/max_length**

  .. _class_NavigationMesh_filter/filter_walkable_low_height_spans:

- :ref:`bool<class_bool>` **filter/filter_walkable_low_height_spans**

  .. _class_NavigationMesh_filter/ledge_spans:

- :ref:`bool<class_bool>` **filter/ledge_spans**

  .. _class_NavigationMesh_filter/low_hanging_obstacles:

- :ref:`bool<class_bool>` **filter/low_hanging_obstacles**

  .. _class_NavigationMesh_polygon/verts_per_poly:

- :ref:`float<class_float>` **polygon/verts_per_poly**

  .. _class_NavigationMesh_region/merge_size:

- :ref:`float<class_float>` **region/merge_size**

  .. _class_NavigationMesh_region/min_size:

- :ref:`float<class_float>` **region/min_size**

  .. _class_NavigationMesh_sample_partition_type/sample_partition_type:

- :ref:`int<class_int>` **sample_partition_type/sample_partition_type**


Method Descriptions
-------------------

.. _class_NavigationMesh_add_polygon:

- void **add_polygon** **(** :ref:`PoolIntArray<class_PoolIntArray>` polygon **)**

.. _class_NavigationMesh_clear_polygons:

- void **clear_polygons** **(** **)**

.. _class_NavigationMesh_create_from_mesh:

- void **create_from_mesh** **(** :ref:`Mesh<class_Mesh>` mesh **)**

.. _class_NavigationMesh_get_polygon:

- :ref:`PoolIntArray<class_PoolIntArray>` **get_polygon** **(** :ref:`int<class_int>` idx **)**

.. _class_NavigationMesh_get_polygon_count:

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

.. _class_NavigationMesh_get_vertices:

- :ref:`PoolVector3Array<class_PoolVector3Array>` **get_vertices** **(** **)** const

.. _class_NavigationMesh_set_vertices:

- void **set_vertices** **(** :ref:`PoolVector3Array<class_PoolVector3Array>` vertices **)**