godot-docs/classes/class_gridmap.rst

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

.. _class_GridMap:

GridMap
=======

**Inherits:** :ref:`Spatial<class_spatial>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`

**Category:** Core

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



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

+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                   | :ref:`clear<class_GridMap_clear>`  **(** **)**                                                                                                                                                             |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                  | :ref:`get_cell_item<class_GridMap_get_cell_item>`  **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`int<class_int>` z  **)** const                                                            |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                  | :ref:`get_cell_item_orientation<class_GridMap_get_cell_item_orientation>`  **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`int<class_int>` z  **)** const                                    |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>`          | :ref:`get_cell_size<class_GridMap_get_cell_size>`  **(** **)** const                                                                                                                                       |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                | :ref:`get_center_x<class_GridMap_get_center_x>`  **(** **)** const                                                                                                                                         |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                | :ref:`get_center_y<class_GridMap_get_center_y>`  **(** **)** const                                                                                                                                         |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                | :ref:`get_center_z<class_GridMap_get_center_z>`  **(** **)** const                                                                                                                                         |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>`              | :ref:`get_meshes<class_GridMap_get_meshes>`  **(** **)**                                                                                                                                                   |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                  | :ref:`get_octant_size<class_GridMap_get_octant_size>`  **(** **)** const                                                                                                                                   |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`MeshLibrary<class_meshlibrary>`  | :ref:`get_theme<class_GridMap_get_theme>`  **(** **)** const                                                                                                                                               |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>`              | :ref:`get_used_cells<class_GridMap_get_used_cells>`  **(** **)** const                                                                                                                                     |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                   | :ref:`resource_changed<class_GridMap_resource_changed>`  **(** :ref:`Resource<class_resource>` resource  **)**                                                                                             |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                   | :ref:`set_cell_item<class_GridMap_set_cell_item>`  **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`int<class_int>` z, :ref:`int<class_int>` item, :ref:`int<class_int>` orientation=0  **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                   | :ref:`set_cell_size<class_GridMap_set_cell_size>`  **(** :ref:`Vector3<class_vector3>` size  **)**                                                                                                         |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                   | :ref:`set_center_x<class_GridMap_set_center_x>`  **(** :ref:`bool<class_bool>` enable  **)**                                                                                                               |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                   | :ref:`set_center_y<class_GridMap_set_center_y>`  **(** :ref:`bool<class_bool>` enable  **)**                                                                                                               |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                   | :ref:`set_center_z<class_GridMap_set_center_z>`  **(** :ref:`bool<class_bool>` enable  **)**                                                                                                               |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                   | :ref:`set_clip<class_GridMap_set_clip>`  **(** :ref:`bool<class_bool>` enabled, :ref:`bool<class_bool>` clipabove=true, :ref:`int<class_int>` floor=0, :ref:`int<class_int>` axis=0  **)**                 |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                   | :ref:`set_octant_size<class_GridMap_set_octant_size>`  **(** :ref:`int<class_int>` size  **)**                                                                                                             |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                   | :ref:`set_theme<class_GridMap_set_theme>`  **(** :ref:`MeshLibrary<class_meshlibrary>` theme  **)**                                                                                                        |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

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

- **INVALID_CELL_ITEM** = **-1**

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

.. _class_GridMap_clear:

- void  **clear**  **(** **)**

.. _class_GridMap_get_cell_item:

- :ref:`int<class_int>`  **get_cell_item**  **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`int<class_int>` z  **)** const

.. _class_GridMap_get_cell_item_orientation:

- :ref:`int<class_int>`  **get_cell_item_orientation**  **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`int<class_int>` z  **)** const

.. _class_GridMap_get_cell_size:

- :ref:`Vector3<class_vector3>`  **get_cell_size**  **(** **)** const

.. _class_GridMap_get_center_x:

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

.. _class_GridMap_get_center_y:

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

.. _class_GridMap_get_center_z:

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

.. _class_GridMap_get_meshes:

- :ref:`Array<class_array>`  **get_meshes**  **(** **)**

.. _class_GridMap_get_octant_size:

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

.. _class_GridMap_get_theme:

- :ref:`MeshLibrary<class_meshlibrary>`  **get_theme**  **(** **)** const

.. _class_GridMap_get_used_cells:

- :ref:`Array<class_array>`  **get_used_cells**  **(** **)** const

.. _class_GridMap_resource_changed:

- void  **resource_changed**  **(** :ref:`Resource<class_resource>` resource  **)**

.. _class_GridMap_set_cell_item:

- void  **set_cell_item**  **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`int<class_int>` z, :ref:`int<class_int>` item, :ref:`int<class_int>` orientation=0  **)**

.. _class_GridMap_set_cell_size:

- void  **set_cell_size**  **(** :ref:`Vector3<class_vector3>` size  **)**

.. _class_GridMap_set_center_x:

- void  **set_center_x**  **(** :ref:`bool<class_bool>` enable  **)**

.. _class_GridMap_set_center_y:

- void  **set_center_y**  **(** :ref:`bool<class_bool>` enable  **)**

.. _class_GridMap_set_center_z:

- void  **set_center_z**  **(** :ref:`bool<class_bool>` enable  **)**

.. _class_GridMap_set_clip:

- void  **set_clip**  **(** :ref:`bool<class_bool>` enabled, :ref:`bool<class_bool>` clipabove=true, :ref:`int<class_int>` floor=0, :ref:`int<class_int>` axis=0  **)**

.. _class_GridMap_set_octant_size:

- void  **set_octant_size**  **(** :ref:`int<class_int>` size  **)**

.. _class_GridMap_set_theme:

- void  **set_theme**  **(** :ref:`MeshLibrary<class_meshlibrary>` theme  **)**