TileMap¶
Inherits: Node2D < CanvasItem < Node < Object
Category: Core
Brief Description¶
Node for 2D tile-based maps.
Properties¶
Methods¶
| void | clear ( ) |
| void | fix_invalid_tiles ( ) |
| int | get_cell ( int x, int y ) const |
| Vector2 | get_cell_autotile_coord ( int x, int y ) const |
| int | get_cellv ( Vector2 position ) const |
| bool | get_collision_layer_bit ( int bit ) const |
| bool | get_collision_mask_bit ( int bit ) const |
| Array | get_used_cells ( ) const |
| Array | get_used_cells_by_id ( int id ) const |
| Rect2 | get_used_rect ( ) |
| bool | is_cell_transposed ( int x, int y ) const |
| bool | is_cell_x_flipped ( int x, int y ) const |
| bool | is_cell_y_flipped ( int x, int y ) const |
| Vector2 | map_to_world ( Vector2 map_position, bool ignore_half_ofs=false ) const |
| void | set_cell ( int x, int y, int tile, bool flip_x=false, bool flip_y=false, bool transpose=false, Vector2 autotile_coord=Vector2( 0, 0 ) ) |
| void | set_cellv ( Vector2 position, int tile, bool flip_x=false, bool flip_y=false, bool transpose=false ) |
| void | set_collision_layer_bit ( int bit, bool value ) |
| void | set_collision_mask_bit ( int bit, bool value ) |
| void | update_bitmask_area ( Vector2 position ) |
| void | update_bitmask_region ( Vector2 start=Vector2( 0, 0 ), Vector2 end=Vector2( 0, 0 ) ) |
| void | update_dirty_quadrants ( ) |
| Vector2 | world_to_map ( Vector2 world_position ) const |
Enumerations¶
enum Mode:
- MODE_SQUARE = 0 — Orthogonal orientation mode.
- MODE_ISOMETRIC = 1 — Isometric orientation mode.
- MODE_CUSTOM = 2 — Custom orientation mode.
enum HalfOffset:
- HALF_OFFSET_X = 0 — Half offset on the X coordinate.
- HALF_OFFSET_Y = 1 — Half offset on the Y coordinate.
- HALF_OFFSET_DISABLED = 2 — Half offset disabled.
- HALF_OFFSET_NEGATIVE_X = 3 — Half offset on the X coordinate (negative).
- HALF_OFFSET_NEGATIVE_Y = 4 — Half offset on the Y coordinate (negative).
enum TileOrigin:
- TILE_ORIGIN_TOP_LEFT = 0 — Tile origin at its top-left corner.
- TILE_ORIGIN_CENTER = 1 — Tile origin at its center.
- TILE_ORIGIN_BOTTOM_LEFT = 2 — Tile origin at its bottom-left corner.
Constants¶
- INVALID_CELL = -1 — Returned when a cell doesn’t exist.
Description¶
Node for 2D tile-based maps. Tilemaps use a TileSet which contain a list of tiles (textures plus optional collision, navigation, and/or occluder shapes) which are used to create grid-based maps.
Tutorials¶
Property Descriptions¶
- bool cell_clip_uv
| Setter | set_clip_uv(value) |
| Getter | get_clip_uv() |
- Transform2D cell_custom_transform
| Setter | set_custom_transform(value) |
| Getter | get_custom_transform() |
The custom Transform2D to be applied to the TileMap’s cells.
- HalfOffset cell_half_offset
| Setter | set_half_offset(value) |
| Getter | get_half_offset() |
Amount to offset alternating tiles. Uses HALF_OFFSET_* constants. Default value: HALF_OFFSET_DISABLED.
- int cell_quadrant_size
| Setter | set_quadrant_size(value) |
| Getter | get_quadrant_size() |
The TileMap’s quadrant size. Optimizes drawing by batching, using chunks of this size. Default value: 16.
- Vector2 cell_size
| Setter | set_cell_size(value) |
| Getter | get_cell_size() |
The TileMap’s cell size.
- TileOrigin cell_tile_origin
| Setter | set_tile_origin(value) |
| Getter | get_tile_origin() |
Position for tile origin. Uses TILE_ORIGIN_* constants. Default value: TILE_ORIGIN_TOP_LEFT.
- bool cell_y_sort
| Setter | set_y_sort_mode(value) |
| Getter | is_y_sort_mode_enabled() |
If true, the TileMap’s children will be drawn in order of their Y coordinate. Default value: false.
- float collision_bounce
| Setter | set_collision_bounce(value) |
| Getter | get_collision_bounce() |
Bounce value for static body collisions (see collision_use_kinematic). Default value: 0.
- float collision_friction
| Setter | set_collision_friction(value) |
| Getter | get_collision_friction() |
Friction value for static body collisions (see collision_use_kinematic). Default value: 1.
- int collision_layer
| Setter | set_collision_layer(value) |
| Getter | get_collision_layer() |
The collision layer(s) for all colliders in the TileMap.
- int collision_mask
| Setter | set_collision_mask(value) |
| Getter | get_collision_mask() |
The collision mask(s) for all colliders in the TileMap.
- bool collision_use_kinematic
| Setter | set_collision_use_kinematic(value) |
| Getter | get_collision_use_kinematic() |
If true, TileMap collisions will be handled as a kinematic body. If false, collisions will be handled as static body. Default value: false.
- Mode mode
| Setter | set_mode(value) |
| Getter | get_mode() |
The TileMap orientation mode. Uses MODE_* constants. Default value: MODE_SQUARE.
- int occluder_light_mask
| Setter | set_occluder_light_mask(value) |
| Getter | get_occluder_light_mask() |
The light mask assigned to all light occluders in the TileMap. The TileSet’s light occluders will cast shadows only from Light2D(s) that have the same light mask(s).
- TileSet tile_set
| Setter | set_tileset(value) |
| Getter | get_tileset() |
The assigned TileSet.
Method Descriptions¶
- void clear ( )
Clears all cells.
- void fix_invalid_tiles ( )
Clears cells that do not exist in the tileset.
Returns the tile index of the given cell. If no tile exists in the cell, returns INVALID_CELL.
Returns the tile index of the cell given by a Vector2. If no tile exists in the cell, returns INVALID_CELL.
Returns true if the given collision layer bit is set.
Returns true if the given collision mask bit is set.
- Array get_used_cells ( ) const
Returns a Vector2 array with the positions of all cells containing a tile from the tileset (i.e. a tile index different from -1).
Returns an array of all cells with the given tile id.
- Rect2 get_used_rect ( )
Returns a rectangle enclosing the used (non-empty) tiles of the map.
Returns true if the given cell is transposed, i.e. the x and y axes are swapped.
Returns true if the given cell is flipped in the x axis.
Returns true if the given cell is flipped in the y axis.
Returns the global position corresponding to the given tilemap (grid-based) coordinates.
Optionally, the tilemap’s half offset can be ignored.
- void set_cell ( int x, int y, int tile, bool flip_x=false, bool flip_y=false, bool transpose=false, Vector2 autotile_coord=Vector2( 0, 0 ) )
Sets the tile index for the cell given by a Vector2.
An index of -1 clears the cell.
Optionally, the tile can also be flipped, transposed, or given autotile coordinates.
Note that data such as navigation polygons and collision shapes are not immediately updated for performance reasons.
If you need these to be immediately updated, you can call update_dirty_quadrants.
Overriding this method also overrides it internally, allowing custom logic to be implemented when tiles are placed/removed:
func set_cell(x, y, tile, flip_x, flip_y, transpose, autotile_coord)
# Write your custom logic here.
# To call the default method:
.set_cell(x, y, tile, flip_x, flip_y, transpose, autotile_coord)
- void set_cellv ( Vector2 position, int tile, bool flip_x=false, bool flip_y=false, bool transpose=false )
Sets the tile index for the given cell.
An index of -1 clears the cell.
Optionally, the tile can also be flipped or transposed.
Note that data such as navigation polygons and collision shapes are not immediately updated for performance reasons.
If you need these to be immediately updated, you can call update_dirty_quadrants.
Sets the given collision layer bit.
Sets the given collision mask bit.
- void update_bitmask_area ( Vector2 position )
Applies autotiling rules to the cell (and its adjacent cells) referenced by its grid-based x and y coordinates.
Applies autotiling rules to the cells in the given region (specified by grid-based x and y coordinates).
Calling with invalid (or missing) parameters applies autotiling rules for the entire tilemap.
- void update_dirty_quadrants ( )
Updates the tile map’s quadrants, allowing things such as navigation and collision shapes to be immediately used if modified.
Returns the tilemap (grid-based) coordinates corresponding to the given local position.