Node for 3D tile-based maps.
GridMap lets you place meshes on a grid interactively. It works both from the editor and from scripts, which can help you create in-game level editors.
GridMaps use a MeshLibrary which contains a list of tiles. Each tile is a mesh with materials plus optional collision and navigation shapes.
A GridMap contains a collection of cells. Each grid cell refers to a tile in the MeshLibrary. All cells in the map have the same dimensions.
Internally, a GridMap is split into a sparse collection of octants for efficient rendering and physics processing. Every octant has the same dimensions and can contain several cells.
Note: GridMap doesn't extend VisualInstance3D and therefore can't be hidden or cull masked based on VisualInstance3D.layers. If you make a light not affect the first layer, the whole GridMap won't be lit by the light in question.
The scale of the cell items.
This does not affect the size of the grid cells themselves, only the items in them. This can be used to make cell items overlap their neighbors.
The dimensions of the grid's cells.
This does not affect the size of the meshes. See cell_scale.
The physics layers this GridMap is in.
GridMaps act as static bodies, meaning they aren't affected by gravity or other forces. They only affect other physics bodies that collide with them.
The physics layers this GridMap detects collisions in. See Collision layers and masks in the documentation for more information.
The priority used to solve colliding when occurring penetration. The higher the priority is, the lower the penetration into the object will be. This can for example be used to prevent the player from breaking through the boundaries of a level.
Show or hide the GridMap's collision shapes. If set to DEBUG_VISIBILITY_MODE_DEFAULT, this depends on the show collision debug settings.
Overrides the default friction and bounce physics properties for the whole GridMap.
Returns an array of ArrayMeshes and Transform3D references of all bake meshes that exist within the current GridMap. Even indices contain ArrayMeshes, while odd indices contain Transform3Ds that are always equal to Transform3D.IDENTITY.
This method relies on the output of make_baked_meshes(), which will be called with gen_lightmap_uv set to true and lightmap_uv_texel_size set to 0.1 if it hasn't been called yet.
Returns one of 24 possible rotations that lie along the vectors (x,y,z) with each component being either -1, 0, or 1. For further details, refer to the Godot source code.
The MeshLibrary item index located at the given grid coordinates. If the cell is empty, INVALID_CELL_ITEM will be returned.
Returns whether or not the specified layer of the collision_layer is enabled, given a layer_number between 1 and 32.
Returns whether or not the specified layer of the collision_mask is enabled, given a layer_number between 1 and 32.
Returns an array of Transform3D and Mesh references corresponding to the non-empty cells in the grid. The transforms are specified in local space. Even indices contain Transform3Ds, while odd indices contain Meshes related to the Transform3D in the index preceding it.
Returns the Vector3i octant coordinates of the octant that the cell at cell_coords belongs to.
Returns an array of Vector3i octant coordinates that are inside the given bounds, including octants that have no cells in use.
This function considers a discretization of rotations into 24 points on unit sphere, lying along the vectors (x,y,z) with each component being either -1, 0, or 1, and returns the index (in the range from 0 to 23) of the point best representing the orientation of the object. For further details, refer to the Godot source code.
Returns an array of Vector3 with the non-empty cell coordinates in the grid map.
Returns an array of Vector3is with the cell coordinates of non-empty cells inside the octant at octant_coords.
Returns an array of Vector3is with the cell coordinates of cells inside the octant at octant_coords that use the specified cell item.
Returns an array of Vector3is with the octant coordinates of the non-empty octants in the grid map.
Returns an array of Vector3is with the octant coordinates of the octants that use the specified item in the grid map.
Returns an array of Vector3is with the octant coordinates of non-empty octants that are inside the local bounds.
Returns the map coordinates of the cell containing the given local_position. If local_position is in global coordinates, consider using Node3D.to_local() before passing it to this method. See also map_to_local().
Generates a baked mesh that represents all meshes in the assigned MeshLibrary for use with LightmapGI. If gen_lightmap_uv is true, UV2 data will be generated for each mesh currently used in the GridMap. Otherwise, only meshes that already have UV2 data present will be able to use baked lightmaps. When generating UV2, lightmap_uv_texel_size controls the texel density for lightmaps, with lower values resulting in more detailed lightmaps. lightmap_uv_texel_size is ignored if gen_lightmap_uv is false. See also get_bake_meshes(), which relies on the output of this method.
Note: Calling this method will not actually bake lightmaps, as lightmap baking is performed using the LightmapGI node.
Returns the position of a grid cell in the GridMap's local coordinate space. To convert the returned value into global coordinates, use Node3D.to_global(). See also local_to_map().
Sets the mesh index for the cell referenced by its grid coordinates.
A negative item index such as INVALID_CELL_ITEM will clear the cell.
Optionally, the item's orientation can be passed. For valid orientation values, see get_orthogonal_index_from_basis().
Based on value, enables or disables the specified layer in the collision_layer, given a layer_number between 1 and 32.
Based on value, enables or disables the specified layer in the collision_mask, given a layer_number between 1 and 32.
DEBUG_VISIBILITY_MODE_DEFAULT = 0Hide the collisions debug shapes in the editor, and use the debug settings to determine their visibility in game (i.e. SceneTree.debug_collisions_hint or SceneTree.debug_navigation_hint).
DEBUG_VISIBILITY_MODE_FORCE_SHOW = 1Always show the collisions debug shapes.
DEBUG_VISIBILITY_MODE_FORCE_HIDE = 2Always hide the collisions debug shapes.
Invalid cell item that can be used in set_cell_item() to clear cells (or represent an empty cell in get_cell_item()).