Struct GridMap
Node for 3D tile-based maps.
struct GridMap
;
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.
Properties
| Name | Type | Description |
|---|---|---|
cellCenterX[get, set]
|
bool | If true, grid items are centered on the X axis.
|
cellCenterY[get, set]
|
bool | If true, grid items are centered on the Y axis.
|
cellCenterZ[get, set]
|
bool | If true, grid items are centered on the Z axis.
|
cellOctantSize[get, set]
|
long | The size of each octant measured in number of cells. This applies to all three axis. |
cellScale[get, set]
|
double | 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. |
cellSize[get, set]
|
Vector3 | The dimensions of the grid's cells.
This does not affect the size of the meshes. See cellScale.
|
collisionLayer[get, set]
|
long | 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. |
collisionMask[get, set]
|
long | The physics layers this GridMap detects collisions in. |
meshLibrary[get, set]
|
MeshLibrary | The assigned MeshLibrary.
|
Methods
| Name | Description |
|---|---|
_updateOctantsCallback
|
|
clear
|
Clear all cells. |
clearBakedMeshes
|
|
getBakeMeshes
|
|
getBakeMeshInstance
|
|
getCellItem
|
The MeshLibrary item index located at the grid-based X, Y and Z coordinates. If the cell is empty, constant INVALID_CELL_ITEM will be returned.
|
getCellItemOrientation
|
The orientation of the cell at the grid-based X, Y and Z coordinates. -1 is returned if the cell is empty. |
getCellScale
|
|
getCellSize
|
|
getCenterX
|
|
getCenterY
|
|
getCenterZ
|
|
getCollisionLayer
|
|
getCollisionLayerBit
|
Returns an individual bit on the collisionLayer.
|
getCollisionMask
|
|
getCollisionMaskBit
|
Returns an individual bit on the collisionMask.
|
getMeshes
|
Returns an array of Transform and Mesh references corresponding to the non-empty cells in the grid. The transforms are specified in world space.
|
getMeshLibrary
|
|
getOctantSize
|
|
getUsedCells
|
Returns an array of Vector3 with the non-empty cell coordinates in the grid map.
|
makeBakedMeshes
|
|
mapToWorld
|
Returns the position of a grid cell in the GridMap's local coordinate space. |
resourceChanged
|
|
setCellItem
|
Sets the mesh index for the cell referenced by its grid-based X, Y and Z coordinates.
A negative item index such as constant INVALID_CELL_ITEM will clear the cell.
Optionally, the item's orientation can be passed. For valid orientation values, see Basis.
|
setCellScale
|
|
setCellSize
|
|
setCenterX
|
|
setCenterY
|
|
setCenterZ
|
|
setClip
|
|
setCollisionLayer
|
|
setCollisionLayerBit
|
Sets an individual bit on the collisionLayer.
|
setCollisionMask
|
|
setCollisionMaskBit
|
Sets an individual bit on the collisionMask.
|
setMeshLibrary
|
|
setOctantSize
|
|
worldToMap
|
Returns the coordinates of the grid cell containing the given point.
pos should be in the GridMap's local coordinate space.
|
Enums
| Name | Description |
|---|---|
Constants
|