GridMap¶

Node for 3D tile-based maps.

Description¶

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 aMeshLibrary 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 theMeshLibrary. 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 extendVisualInstance and therefore can't be hidden or cull masked based onVisualInstance.layers. If you make a light not affect the first layer, the whole GridMap won't be lit by the light in question.

Tutorials¶

Properties¶

bool	cell_center_x	`true`
bool	cell_center_y	`true`
bool	cell_center_z	`true`
int	cell_octant_size	`8`
float	cell_scale	`1.0`
Vector3	cell_size	`Vector3(2,2,2)`
int	collision_layer	`1`
int	collision_mask	`1`
MeshLibrary	mesh_library
bool	use_in_baked_light	`false`

Methods¶

void	clear()
void	clear_baked_meshes()
RID	get_bake_mesh_instance(int idx)
Array	get_bake_meshes()
int	get_cell_item(int x,int y,int z)const
int	get_cell_item_orientation(int x,int y,int z)const
bool	get_collision_layer_bit(int bit)const
bool	get_collision_mask_bit(int bit)const
Array	get_meshes()
Array	get_used_cells()const
void	make_baked_meshes(bool gen_lightmap_uv=false,float lightmap_uv_texel_size=0.1)
Vector3	map_to_world(int x,int y,int z)const
void	resource_changed(Resource resource)
void	set_cell_item(int x,int y,int z,int item,int orientation=0)
void	set_clip(bool enabled,bool clipabove=true,int floor=0, Vector3.Axis axis=0)
void	set_collision_layer_bit(int bit,bool value)
void	set_collision_mask_bit(int bit,bool value)
Vector3	world_to_map(Vector3 pos)const

Signals¶

cell_size_changed(Vector3 cell_size)

Emitted whencell_size changes.

Constants¶

INVALID_CELL_ITEM =-1 --- Invalid cell item that can be used inset_cell_item to clear cells (or represent an empty cell inget_cell_item).

Property Descriptions¶

boolcell_center_x

Default	`true`
Setter	set_center_x(value)
Getter	get_center_x()

Iftrue, grid items are centered on the X axis.

boolcell_center_y

Default	`true`
Setter	set_center_y(value)
Getter	get_center_y()

Iftrue, grid items are centered on the Y axis.

boolcell_center_z

Default	`true`
Setter	set_center_z(value)
Getter	get_center_z()

Iftrue, grid items are centered on the Z axis.

intcell_octant_size

Default	`8`
Setter	set_octant_size(value)
Getter	get_octant_size()

The size of each octant measured in number of cells. This applies to all three axis.

floatcell_scale

Default	`1.0`
Setter	set_cell_scale(value)
Getter	get_cell_scale()

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.

Vector3cell_size

Default	`Vector3(2,2,2)`
Setter	set_cell_size(value)
Getter	get_cell_size()

The dimensions of the grid's cells.

This does not affect the size of the meshes. Seecell_scale.

intcollision_layer

Default	`1`
Setter	set_collision_layer(value)
Getter	get_collision_layer()

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.

intcollision_mask

Default	`1`
Setter	set_collision_mask(value)
Getter	get_collision_mask()

The physics layers this GridMap detects collisions in. SeeCollision layers and masks in the documentation for more information.

MeshLibrarymesh_library

Setter	set_mesh_library(value)
Getter	get_mesh_library()

The assignedMeshLibrary.

booluse_in_baked_light

Default	`false`
Setter	set_use_in_baked_light(value)
Getter	get_use_in_baked_light()

Controls whether this GridMap will be baked in aBakedLightmap or not.

Method Descriptions¶

voidclear()

Clear all cells.

voidclear_baked_meshes()

RIDget_bake_mesh_instance(int idx)

Arrayget_bake_meshes()

Returns an array ofArrayMeshes andTransform references of all bake meshes that exist within the current GridMap.

intget_cell_item(int x,int y,int z)const

The MeshLibrary item index located at the grid-based X, Y and Z coordinates. If the cell is empty,INVALID_CELL_ITEM will be returned.

intget_cell_item_orientation(int x,int y,int z)const

The orientation of the cell at the grid-based X, Y and Z coordinates. -1 is returned if the cell is empty.

boolget_collision_layer_bit(int bit)const

Returns an individual bit on the collision_layer.

boolget_collision_mask_bit(int bit)const

Returns an individual bit on the collision_mask.

Arrayget_meshes()

Returns an array ofTransform andMesh references corresponding to the non-empty cells in the grid. The transforms are specified in world space.

Arrayget_used_cells()const

Returns an array of Vector3 with the non-empty cell coordinates in the grid map.

voidmake_baked_meshes(bool gen_lightmap_uv=false,float lightmap_uv_texel_size=0.1)

Vector3map_to_world(int x,int y,int z)const

Returns the position of a grid cell in the GridMap's local coordinate space.

voidresource_changed(Resource resource)

voidset_cell_item(int x,int y,int z,int item,int orientation=0)

Sets the mesh index for the cell referenced by its grid-based X, Y and Z coordinates.

A negative item index such asINVALID_CELL_ITEM will clear the cell.

Optionally, the item's orientation can be passed. For valid orientation values, seeBasis.get_orthogonal_index.

voidset_clip(bool enabled,bool clipabove=true,int floor=0, Vector3.Axis axis=0)

voidset_collision_layer_bit(int bit,bool value)

Sets an individual bit on thecollision_layer.

voidset_collision_mask_bit(int bit,bool value)

Sets an individual bit on thecollision_mask.

Vector3world_to_map(Vector3 pos)const

Returns the coordinates of the grid cell containing the given point.

pos should be in the GridMap's local coordinate space.

Movatterモバイル変換