.. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/docs/gdscript/modules/gridmap/doc_classes/GridMap.xml. .. _class_GridMap: GridMap ======= **Inherits:** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` .. container:: contribute There is currently no description for this class. Please help us by :ref:`contributing one `! .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-----------------------------------------------+----------------------------------------------------------------------+----------------------+ | :ref:`bool` | :ref:`bake_navigation` | ``false`` | +-----------------------------------------------+----------------------------------------------------------------------+----------------------+ | :ref:`bool` | :ref:`cell_center_x` | ``true`` | +-----------------------------------------------+----------------------------------------------------------------------+----------------------+ | :ref:`bool` | :ref:`cell_center_y` | ``true`` | +-----------------------------------------------+----------------------------------------------------------------------+----------------------+ | :ref:`bool` | :ref:`cell_center_z` | ``true`` | +-----------------------------------------------+----------------------------------------------------------------------+----------------------+ | :ref:`int` | :ref:`cell_octant_size` | ``8`` | +-----------------------------------------------+----------------------------------------------------------------------+----------------------+ | :ref:`float` | :ref:`cell_scale` | ``1.0`` | +-----------------------------------------------+----------------------------------------------------------------------+----------------------+ | :ref:`Vector3` | :ref:`cell_size` | ``Vector3(2, 2, 2)`` | +-----------------------------------------------+----------------------------------------------------------------------+----------------------+ | :ref:`int` | :ref:`collision_layer` | ``1`` | +-----------------------------------------------+----------------------------------------------------------------------+----------------------+ | :ref:`int` | :ref:`collision_mask` | ``1`` | +-----------------------------------------------+----------------------------------------------------------------------+----------------------+ | :ref:`float` | :ref:`collision_priority` | ``1.0`` | +-----------------------------------------------+----------------------------------------------------------------------+----------------------+ | :ref:`MeshLibrary` | :ref:`mesh_library` | | +-----------------------------------------------+----------------------------------------------------------------------+----------------------+ | :ref:`PhysicsMaterial` | :ref:`physics_material` | | +-----------------------------------------------+----------------------------------------------------------------------+----------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** | +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_baked_meshes` **(** **)** | +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_bake_mesh_instance` **(** :ref:`int` idx **)** | +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`get_bake_meshes` **(** **)** | +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Basis` | :ref:`get_basis_with_orthogonal_index` **(** :ref:`int` index **)** |const| | +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_cell_item` **(** :ref:`Vector3i` position **)** |const| | +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Basis` | :ref:`get_cell_item_basis` **(** :ref:`Vector3i` position **)** |const| | +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_cell_item_orientation` **(** :ref:`Vector3i` position **)** |const| | +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_collision_layer_value` **(** :ref:`int` layer_number **)** |const| | +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_collision_mask_value` **(** :ref:`int` layer_number **)** |const| | +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`get_meshes` **(** **)** |const| | +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_navigation_map` **(** **)** |const| | +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_orthogonal_index_from_basis` **(** :ref:`Basis` basis **)** |const| | +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3i[]` | :ref:`get_used_cells` **(** **)** |const| | +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3i[]` | :ref:`get_used_cells_by_item` **(** :ref:`int` item **)** |const| | +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3i` | :ref:`local_to_map` **(** :ref:`Vector3` local_position **)** |const| | +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`make_baked_meshes` **(** :ref:`bool` gen_lightmap_uv=false, :ref:`float` lightmap_uv_texel_size=0.1 **)** | +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`map_to_local` **(** :ref:`Vector3i` map_position **)** |const| | +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`resource_changed` **(** :ref:`Resource` resource **)** | +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_cell_item` **(** :ref:`Vector3i` position, :ref:`int` item, :ref:`int` orientation=0 **)** | +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_collision_layer_value` **(** :ref:`int` layer_number, :ref:`bool` value **)** | +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_collision_mask_value` **(** :ref:`int` layer_number, :ref:`bool` value **)** | +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_navigation_map` **(** :ref:`RID` navigation_map **)** | +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Signals ------- .. _class_GridMap_signal_cell_size_changed: .. rst-class:: classref-signal **cell_size_changed** **(** :ref:`Vector3` cell_size **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GridMap_signal_changed: .. rst-class:: classref-signal **changed** **(** **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Constants --------- .. _class_GridMap_constant_INVALID_CELL_ITEM: .. rst-class:: classref-constant **INVALID_CELL_ITEM** = ``-1`` .. container:: contribute There is currently no description for this constant. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_GridMap_property_bake_navigation: .. rst-class:: classref-property :ref:`bool` **bake_navigation** = ``false`` .. rst-class:: classref-property-setget - void **set_bake_navigation** **(** :ref:`bool` value **)** - :ref:`bool` **is_baking_navigation** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GridMap_property_cell_center_x: .. rst-class:: classref-property :ref:`bool` **cell_center_x** = ``true`` .. rst-class:: classref-property-setget - void **set_center_x** **(** :ref:`bool` value **)** - :ref:`bool` **get_center_x** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GridMap_property_cell_center_y: .. rst-class:: classref-property :ref:`bool` **cell_center_y** = ``true`` .. rst-class:: classref-property-setget - void **set_center_y** **(** :ref:`bool` value **)** - :ref:`bool` **get_center_y** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GridMap_property_cell_center_z: .. rst-class:: classref-property :ref:`bool` **cell_center_z** = ``true`` .. rst-class:: classref-property-setget - void **set_center_z** **(** :ref:`bool` value **)** - :ref:`bool` **get_center_z** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GridMap_property_cell_octant_size: .. rst-class:: classref-property :ref:`int` **cell_octant_size** = ``8`` .. rst-class:: classref-property-setget - void **set_octant_size** **(** :ref:`int` value **)** - :ref:`int` **get_octant_size** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GridMap_property_cell_scale: .. rst-class:: classref-property :ref:`float` **cell_scale** = ``1.0`` .. rst-class:: classref-property-setget - void **set_cell_scale** **(** :ref:`float` value **)** - :ref:`float` **get_cell_scale** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GridMap_property_cell_size: .. rst-class:: classref-property :ref:`Vector3` **cell_size** = ``Vector3(2, 2, 2)`` .. rst-class:: classref-property-setget - void **set_cell_size** **(** :ref:`Vector3` value **)** - :ref:`Vector3` **get_cell_size** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GridMap_property_collision_layer: .. rst-class:: classref-property :ref:`int` **collision_layer** = ``1`` .. rst-class:: classref-property-setget - void **set_collision_layer** **(** :ref:`int` value **)** - :ref:`int` **get_collision_layer** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GridMap_property_collision_mask: .. rst-class:: classref-property :ref:`int` **collision_mask** = ``1`` .. rst-class:: classref-property-setget - void **set_collision_mask** **(** :ref:`int` value **)** - :ref:`int` **get_collision_mask** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GridMap_property_collision_priority: .. rst-class:: classref-property :ref:`float` **collision_priority** = ``1.0`` .. rst-class:: classref-property-setget - void **set_collision_priority** **(** :ref:`float` value **)** - :ref:`float` **get_collision_priority** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GridMap_property_mesh_library: .. rst-class:: classref-property :ref:`MeshLibrary` **mesh_library** .. rst-class:: classref-property-setget - void **set_mesh_library** **(** :ref:`MeshLibrary` value **)** - :ref:`MeshLibrary` **get_mesh_library** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GridMap_property_physics_material: .. rst-class:: classref-property :ref:`PhysicsMaterial` **physics_material** .. rst-class:: classref-property-setget - void **set_physics_material** **(** :ref:`PhysicsMaterial` value **)** - :ref:`PhysicsMaterial` **get_physics_material** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_GridMap_method_clear: .. rst-class:: classref-method void **clear** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GridMap_method_clear_baked_meshes: .. rst-class:: classref-method void **clear_baked_meshes** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GridMap_method_get_bake_mesh_instance: .. rst-class:: classref-method :ref:`RID` **get_bake_mesh_instance** **(** :ref:`int` idx **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GridMap_method_get_bake_meshes: .. rst-class:: classref-method :ref:`Array` **get_bake_meshes** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GridMap_method_get_basis_with_orthogonal_index: .. rst-class:: classref-method :ref:`Basis` **get_basis_with_orthogonal_index** **(** :ref:`int` index **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GridMap_method_get_cell_item: .. rst-class:: classref-method :ref:`int` **get_cell_item** **(** :ref:`Vector3i` position **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GridMap_method_get_cell_item_basis: .. rst-class:: classref-method :ref:`Basis` **get_cell_item_basis** **(** :ref:`Vector3i` position **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GridMap_method_get_cell_item_orientation: .. rst-class:: classref-method :ref:`int` **get_cell_item_orientation** **(** :ref:`Vector3i` position **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GridMap_method_get_collision_layer_value: .. rst-class:: classref-method :ref:`bool` **get_collision_layer_value** **(** :ref:`int` layer_number **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GridMap_method_get_collision_mask_value: .. rst-class:: classref-method :ref:`bool` **get_collision_mask_value** **(** :ref:`int` layer_number **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GridMap_method_get_meshes: .. rst-class:: classref-method :ref:`Array` **get_meshes** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GridMap_method_get_navigation_map: .. rst-class:: classref-method :ref:`RID` **get_navigation_map** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GridMap_method_get_orthogonal_index_from_basis: .. rst-class:: classref-method :ref:`int` **get_orthogonal_index_from_basis** **(** :ref:`Basis` basis **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GridMap_method_get_used_cells: .. rst-class:: classref-method :ref:`Vector3i[]` **get_used_cells** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GridMap_method_get_used_cells_by_item: .. rst-class:: classref-method :ref:`Vector3i[]` **get_used_cells_by_item** **(** :ref:`int` item **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GridMap_method_local_to_map: .. rst-class:: classref-method :ref:`Vector3i` **local_to_map** **(** :ref:`Vector3` local_position **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GridMap_method_make_baked_meshes: .. rst-class:: classref-method void **make_baked_meshes** **(** :ref:`bool` gen_lightmap_uv=false, :ref:`float` lightmap_uv_texel_size=0.1 **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GridMap_method_map_to_local: .. rst-class:: classref-method :ref:`Vector3` **map_to_local** **(** :ref:`Vector3i` map_position **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GridMap_method_resource_changed: .. rst-class:: classref-method void **resource_changed** **(** :ref:`Resource` resource **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GridMap_method_set_cell_item: .. rst-class:: classref-method void **set_cell_item** **(** :ref:`Vector3i` position, :ref:`int` item, :ref:`int` orientation=0 **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GridMap_method_set_collision_layer_value: .. rst-class:: classref-method void **set_collision_layer_value** **(** :ref:`int` layer_number, :ref:`bool` value **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GridMap_method_set_collision_mask_value: .. rst-class:: classref-method void **set_collision_mask_value** **(** :ref:`int` layer_number, :ref:`bool` value **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GridMap_method_set_navigation_map: .. rst-class:: classref-method void **set_navigation_map** **(** :ref:`RID` navigation_map **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`