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
-----------------



Member Functions
----------------

+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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:`float<class_float>`                        | :ref:`get_agent_height<class_NavigationMesh_get_agent_height>`  **(** **)** const                                                                                             |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                        | :ref:`get_agent_max_climb<class_NavigationMesh_get_agent_max_climb>`  **(** **)** const                                                                                       |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                        | :ref:`get_agent_max_slope<class_NavigationMesh_get_agent_max_slope>`  **(** **)** const                                                                                       |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                        | :ref:`get_agent_radius<class_NavigationMesh_get_agent_radius>`  **(** **)**                                                                                                   |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                        | :ref:`get_cell_height<class_NavigationMesh_get_cell_height>`  **(** **)** const                                                                                               |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                        | :ref:`get_cell_size<class_NavigationMesh_get_cell_size>`  **(** **)** const                                                                                                   |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                        | :ref:`get_detail_sample_distance<class_NavigationMesh_get_detail_sample_distance>`  **(** **)** const                                                                         |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                        | :ref:`get_detail_sample_max_error<class_NavigationMesh_get_detail_sample_max_error>`  **(** **)** const                                                                       |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                        | :ref:`get_edge_max_error<class_NavigationMesh_get_edge_max_error>`  **(** **)** const                                                                                         |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                        | :ref:`get_edge_max_length<class_NavigationMesh_get_edge_max_length>`  **(** **)** const                                                                                       |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                          | :ref:`get_filter_ledge_spans<class_NavigationMesh_get_filter_ledge_spans>`  **(** **)** const                                                                                 |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                          | :ref:`get_filter_low_hanging_obstacles<class_NavigationMesh_get_filter_low_hanging_obstacles>`  **(** **)** const                                                             |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                          | :ref:`get_filter_walkable_low_height_spans<class_NavigationMesh_get_filter_walkable_low_height_spans>`  **(** **)** const                                                     |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :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:`float<class_float>`                        | :ref:`get_region_merge_size<class_NavigationMesh_get_region_merge_size>`  **(** **)** const                                                                                   |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                        | :ref:`get_region_min_size<class_NavigationMesh_get_region_min_size>`  **(** **)** const                                                                                       |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                            | :ref:`get_sample_partition_type<class_NavigationMesh_get_sample_partition_type>`  **(** **)** const                                                                           |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolVector3Array<class_poolvector3array>`  | :ref:`get_vertices<class_NavigationMesh_get_vertices>`  **(** **)** const                                                                                                     |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                        | :ref:`get_verts_per_poly<class_NavigationMesh_get_verts_per_poly>`  **(** **)** const                                                                                         |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                             | :ref:`set_agent_height<class_NavigationMesh_set_agent_height>`  **(** :ref:`float<class_float>` agent_height  **)**                                                           |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                             | :ref:`set_agent_max_climb<class_NavigationMesh_set_agent_max_climb>`  **(** :ref:`float<class_float>` agent_max_climb  **)**                                                  |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                             | :ref:`set_agent_max_slope<class_NavigationMesh_set_agent_max_slope>`  **(** :ref:`float<class_float>` agent_max_slope  **)**                                                  |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                             | :ref:`set_agent_radius<class_NavigationMesh_set_agent_radius>`  **(** :ref:`float<class_float>` agent_radius  **)**                                                           |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                             | :ref:`set_cell_height<class_NavigationMesh_set_cell_height>`  **(** :ref:`float<class_float>` cell_height  **)**                                                              |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                             | :ref:`set_cell_size<class_NavigationMesh_set_cell_size>`  **(** :ref:`float<class_float>` cell_size  **)**                                                                    |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                             | :ref:`set_detail_sample_distance<class_NavigationMesh_set_detail_sample_distance>`  **(** :ref:`float<class_float>` detail_sample_dist  **)**                                 |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                             | :ref:`set_detail_sample_max_error<class_NavigationMesh_set_detail_sample_max_error>`  **(** :ref:`float<class_float>` detail_sample_max_error  **)**                          |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                             | :ref:`set_edge_max_error<class_NavigationMesh_set_edge_max_error>`  **(** :ref:`float<class_float>` edge_max_error  **)**                                                     |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                             | :ref:`set_edge_max_length<class_NavigationMesh_set_edge_max_length>`  **(** :ref:`float<class_float>` edge_max_length  **)**                                                  |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                             | :ref:`set_filter_ledge_spans<class_NavigationMesh_set_filter_ledge_spans>`  **(** :ref:`bool<class_bool>` filter_ledge_spans  **)**                                           |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                             | :ref:`set_filter_low_hanging_obstacles<class_NavigationMesh_set_filter_low_hanging_obstacles>`  **(** :ref:`bool<class_bool>` filter_low_hanging_obstacles  **)**             |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                             | :ref:`set_filter_walkable_low_height_spans<class_NavigationMesh_set_filter_walkable_low_height_spans>`  **(** :ref:`bool<class_bool>` filter_walkable_low_height_spans  **)** |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                             | :ref:`set_region_merge_size<class_NavigationMesh_set_region_merge_size>`  **(** :ref:`float<class_float>` region_merge_size  **)**                                            |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                             | :ref:`set_region_min_size<class_NavigationMesh_set_region_min_size>`  **(** :ref:`float<class_float>` region_min_size  **)**                                                  |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                             | :ref:`set_sample_partition_type<class_NavigationMesh_set_sample_partition_type>`  **(** :ref:`int<class_int>` sample_partition_type  **)**                                    |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                             | :ref:`set_vertices<class_NavigationMesh_set_vertices>`  **(** :ref:`PoolVector3Array<class_poolvector3array>` vertices  **)**                                                 |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                             | :ref:`set_verts_per_poly<class_NavigationMesh_set_verts_per_poly>`  **(** :ref:`float<class_float>` verts_per_poly  **)**                                                     |
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Member Variables
----------------

- :ref:`float<class_float>` **agent/height**
- :ref:`float<class_float>` **agent/max_climb**
- :ref:`float<class_float>` **agent/max_slope**
- :ref:`float<class_float>` **agent/radius**
- :ref:`float<class_float>` **cell/height**
- :ref:`float<class_float>` **cell/size**
- :ref:`float<class_float>` **detail/sample_distance**
- :ref:`float<class_float>` **detail/sample_max_error**
- :ref:`float<class_float>` **edge/max_error**
- :ref:`float<class_float>` **edge/max_length**
- :ref:`bool<class_bool>` **filter/filter_walkable_low_height_spans**
- :ref:`bool<class_bool>` **filter/ledge_spans**
- :ref:`bool<class_bool>` **filter/low_hanging_obstacles**
- :ref:`float<class_float>` **polygon/verts_per_poly**
- :ref:`Array<class_array>` **polygons**
- :ref:`float<class_float>` **region/merge_size**
- :ref:`float<class_float>` **region/min_size**
- :ref:`int<class_int>` **sample_partition_type/sample_partition_type**
- :ref:`PoolVector3Array<class_poolvector3array>` **vertices**

Numeric Constants
-----------------

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

Member Function Description
---------------------------

.. _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_agent_height:

- :ref:`float<class_float>`  **get_agent_height**  **(** **)** const

.. _class_NavigationMesh_get_agent_max_climb:

- :ref:`float<class_float>`  **get_agent_max_climb**  **(** **)** const

.. _class_NavigationMesh_get_agent_max_slope:

- :ref:`float<class_float>`  **get_agent_max_slope**  **(** **)** const

.. _class_NavigationMesh_get_agent_radius:

- :ref:`float<class_float>`  **get_agent_radius**  **(** **)**

.. _class_NavigationMesh_get_cell_height:

- :ref:`float<class_float>`  **get_cell_height**  **(** **)** const

.. _class_NavigationMesh_get_cell_size:

- :ref:`float<class_float>`  **get_cell_size**  **(** **)** const

.. _class_NavigationMesh_get_detail_sample_distance:

- :ref:`float<class_float>`  **get_detail_sample_distance**  **(** **)** const

.. _class_NavigationMesh_get_detail_sample_max_error:

- :ref:`float<class_float>`  **get_detail_sample_max_error**  **(** **)** const

.. _class_NavigationMesh_get_edge_max_error:

- :ref:`float<class_float>`  **get_edge_max_error**  **(** **)** const

.. _class_NavigationMesh_get_edge_max_length:

- :ref:`float<class_float>`  **get_edge_max_length**  **(** **)** const

.. _class_NavigationMesh_get_filter_ledge_spans:

- :ref:`bool<class_bool>`  **get_filter_ledge_spans**  **(** **)** const

.. _class_NavigationMesh_get_filter_low_hanging_obstacles:

- :ref:`bool<class_bool>`  **get_filter_low_hanging_obstacles**  **(** **)** const

.. _class_NavigationMesh_get_filter_walkable_low_height_spans:

- :ref:`bool<class_bool>`  **get_filter_walkable_low_height_spans**  **(** **)** const

.. _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_region_merge_size:

- :ref:`float<class_float>`  **get_region_merge_size**  **(** **)** const

.. _class_NavigationMesh_get_region_min_size:

- :ref:`float<class_float>`  **get_region_min_size**  **(** **)** const

.. _class_NavigationMesh_get_sample_partition_type:

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

.. _class_NavigationMesh_get_vertices:

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

.. _class_NavigationMesh_get_verts_per_poly:

- :ref:`float<class_float>`  **get_verts_per_poly**  **(** **)** const

.. _class_NavigationMesh_set_agent_height:

- void  **set_agent_height**  **(** :ref:`float<class_float>` agent_height  **)**

.. _class_NavigationMesh_set_agent_max_climb:

- void  **set_agent_max_climb**  **(** :ref:`float<class_float>` agent_max_climb  **)**

.. _class_NavigationMesh_set_agent_max_slope:

- void  **set_agent_max_slope**  **(** :ref:`float<class_float>` agent_max_slope  **)**

.. _class_NavigationMesh_set_agent_radius:

- void  **set_agent_radius**  **(** :ref:`float<class_float>` agent_radius  **)**

.. _class_NavigationMesh_set_cell_height:

- void  **set_cell_height**  **(** :ref:`float<class_float>` cell_height  **)**

.. _class_NavigationMesh_set_cell_size:

- void  **set_cell_size**  **(** :ref:`float<class_float>` cell_size  **)**

.. _class_NavigationMesh_set_detail_sample_distance:

- void  **set_detail_sample_distance**  **(** :ref:`float<class_float>` detail_sample_dist  **)**

.. _class_NavigationMesh_set_detail_sample_max_error:

- void  **set_detail_sample_max_error**  **(** :ref:`float<class_float>` detail_sample_max_error  **)**

.. _class_NavigationMesh_set_edge_max_error:

- void  **set_edge_max_error**  **(** :ref:`float<class_float>` edge_max_error  **)**

.. _class_NavigationMesh_set_edge_max_length:

- void  **set_edge_max_length**  **(** :ref:`float<class_float>` edge_max_length  **)**

.. _class_NavigationMesh_set_filter_ledge_spans:

- void  **set_filter_ledge_spans**  **(** :ref:`bool<class_bool>` filter_ledge_spans  **)**

.. _class_NavigationMesh_set_filter_low_hanging_obstacles:

- void  **set_filter_low_hanging_obstacles**  **(** :ref:`bool<class_bool>` filter_low_hanging_obstacles  **)**

.. _class_NavigationMesh_set_filter_walkable_low_height_spans:

- void  **set_filter_walkable_low_height_spans**  **(** :ref:`bool<class_bool>` filter_walkable_low_height_spans  **)**

.. _class_NavigationMesh_set_region_merge_size:

- void  **set_region_merge_size**  **(** :ref:`float<class_float>` region_merge_size  **)**

.. _class_NavigationMesh_set_region_min_size:

- void  **set_region_min_size**  **(** :ref:`float<class_float>` region_min_size  **)**

.. _class_NavigationMesh_set_sample_partition_type:

- void  **set_sample_partition_type**  **(** :ref:`int<class_int>` sample_partition_type  **)**

.. _class_NavigationMesh_set_vertices:

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

.. _class_NavigationMesh_set_verts_per_poly:

- void  **set_verts_per_poly**  **(** :ref:`float<class_float>` verts_per_poly  **)**