TileMapLayer

package
v0.0.0-...-0d6c339 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 16, 2025 License: MIT Imports: 31 Imported by: 0

Documentation

Overview

Node for 2D tile-based maps. A graphics.gd/classdb/TileMapLayer uses a graphics.gd/classdb/TileSet which contain a list of tiles which are used to create grid-based maps. Unlike the graphics.gd/classdb/TileMap node, which is deprecated, graphics.gd/classdb/TileMapLayer has only one layer of tiles. You can use several graphics.gd/classdb/TileMapLayer to achieve the same result as a graphics.gd/classdb/TileMap node.

For performance reasons, all TileMap updates are batched at the end of a frame. Notably, this means that scene tiles from a graphics.gd/classdb/TileSetScenesCollectionSource are initialized after their parent. This is only queued when inside the scene tree.

To force an update earlier on, call Instance.UpdateInternals.

Note: For performance and compatibility reasons, the coordinates serialized by graphics.gd/classdb/TileMapLayer are limited to 16-bit signed integers, i.e. the range for X and Y coordinates is from -32768 to 32767. When saving tile data, tiles outside this range are wrapped.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Advanced 

type Advanced = class

Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.

type Any 

type Any interface {
	gd.IsClass
	AsTileMapLayer() Instance
}

type DebugVisibilityMode 

type DebugVisibilityMode int //gd:TileMapLayer.DebugVisibilityMode

const (
	// Hide the collisions or navigation debug shapes in the editor, and use the debug settings to determine their visibility in game (i.e. [graphics.gd/classdb/SceneTree.Instance.DebugCollisionsHint] or [graphics.gd/classdb/SceneTree.Instance.DebugNavigationHint]).
	DebugVisibilityModeDefault DebugVisibilityMode = 0
	// Always hide the collisions or navigation debug shapes.
	DebugVisibilityModeForceHide DebugVisibilityMode = 2
	// Always show the collisions or navigation debug shapes.
	DebugVisibilityModeForceShow DebugVisibilityMode = 1
)

type Expanded 

type Expanded [1]gdclass.TileMapLayer

func (Expanded) GetUsedCellsById 

func (self Expanded) GetUsedCellsById(source_id int, atlas_coords Vector2i.XY, alternative_tile int) []Vector2i.XY

Returns a [Vector2i.XY] array with the positions of all cells containing a tile. Tiles may be filtered according to their source ('source_id'), their atlas coordinates ('atlas_coords'), or alternative id ('alternative_tile').

If a parameter has its value set to the default one, this parameter is not used to filter a cell. Thus, if all parameters have their respective default values, this method returns the same result as Instance.GetUsedCells.

A cell is considered empty if its source identifier equals -1, its atlas coordinate identifier is Vector2(-1, -1) and its alternative identifier is -1.

func (Expanded) SetCell 

func (self Expanded) SetCell(coords Vector2i.XY, source_id int, atlas_coords Vector2i.XY, alternative_tile int)

Sets the tile identifiers for the cell at coordinates 'coords'. Each tile of the graphics.gd/classdb/TileSet is identified using three parts:

- The source identifier 'source_id' identifies a graphics.gd/classdb/TileSetSource identifier. See graphics.gd/classdb/TileSet.Instance.SetSourceId,

- The atlas coordinate identifier 'atlas_coords' identifies a tile coordinates in the atlas (if the source is a graphics.gd/classdb/TileSetAtlasSource). For graphics.gd/classdb/TileSetScenesCollectionSource it should always be Vector2i(0, 0),

- The alternative tile identifier 'alternative_tile' identifies a tile alternative in the atlas (if the source is a graphics.gd/classdb/TileSetAtlasSource), and the scene for a graphics.gd/classdb/TileSetScenesCollectionSource.

If 'source_id' is set to -1, 'atlas_coords' to Vector2i(-1, -1), or 'alternative_tile' to -1, the cell will be erased. An erased cell gets all its identifiers automatically set to their respective invalid values, namely -1, Vector2i(-1, -1) and -1.

func (Expanded) SetCellsTerrainConnect 

func (self Expanded) SetCellsTerrainConnect(cells []Vector2i.XY, terrain_set int, terrain int, ignore_empty_terrains bool)

Update all the cells in the 'cells' coordinates array so that they use the given 'terrain' for the given 'terrain_set'. If an updated cell has the same terrain as one of its neighboring cells, this function tries to join the two. This function might update neighboring tiles if needed to create correct terrain transitions.

If 'ignore_empty_terrains' is true, empty terrains will be ignored when trying to find the best fitting tile for the given terrain constraints.

Note: To work correctly, this method requires the graphics.gd/classdb/TileMapLayer's TileSet to have terrains set up with all required terrain combinations. Otherwise, it may produce unexpected results.

func (Expanded) SetCellsTerrainPath 

func (self Expanded) SetCellsTerrainPath(path []Vector2i.XY, terrain_set int, terrain int, ignore_empty_terrains bool)

Update all the cells in the 'path' coordinates array so that they use the given 'terrain' for the given 'terrain_set'. The function will also connect two successive cell in the path with the same terrain. This function might update neighboring tiles if needed to create correct terrain transitions.

If 'ignore_empty_terrains' is true, empty terrains will be ignored when trying to find the best fitting tile for the given terrain constraints.

Note: To work correctly, this method requires the graphics.gd/classdb/TileMapLayer's TileSet to have terrains set up with all required terrain combinations. Otherwise, it may produce unexpected results.

type Extension 

type Extension[T gdclass.Interface] struct{ gdclass.Extension[T, Instance] }

Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this [Extension]See Interface for methods that can be overridden by T.

func (*Extension[T]) AsCanvasItem 

func (self *Extension[T]) AsCanvasItem() CanvasItem.Instance

func (*Extension[T]) AsNode 

func (self *Extension[T]) AsNode() Node.Instance

func (*Extension[T]) AsNode2D 

func (self *Extension[T]) AsNode2D() Node2D.Instance

func (*Extension[T]) AsObject 

func (self *Extension[T]) AsObject() [1]gd.Object

func (*Extension[T]) AsTileMapLayer 

func (self *Extension[T]) AsTileMapLayer() Instance

type ID 

type ID Object.ID

ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.

func (ID) Instance 

func (id ID) Instance() (Instance, bool)

type Implementation 

type Implementation = implementation

Implementation implements Interface with empty methods.

type Instance 

type Instance [1]gdclass.TileMapLayer

Instance of the class with convieniently typed arguments and results. 

var Nil Instance

Nil is a nil/null instance of the class. Equivalent to the zero value.

func New 

func New() Instance

func (Instance) AsCanvasItem 

func (self Instance) AsCanvasItem() CanvasItem.Instance

func (Instance) AsNode 

func (self Instance) AsNode() Node.Instance

func (Instance) AsNode2D 

func (self Instance) AsNode2D() Node2D.Instance

func (Instance) AsObject 

func (self Instance) AsObject() [1]gd.Object

func (Instance) AsTileMapLayer 

func (self Instance) AsTileMapLayer() Instance

func (Instance) Clear 

func (self Instance) Clear()

Clears all cells.

func (Instance) CollisionEnabled 

func (self Instance) CollisionEnabled() bool

func (Instance) CollisionVisibilityMode 

func (self Instance) CollisionVisibilityMode() DebugVisibilityMode

func (Instance) Enabled 

func (self Instance) Enabled() bool

func (Instance) EraseCell 

func (self Instance) EraseCell(coords Vector2i.XY)

Erases the cell at coordinates 'coords'.

func (Instance) FixInvalidTiles 

func (self Instance) FixInvalidTiles()

Clears cells containing tiles that do not exist in the Instance.TileSet.

func (Instance) GetCellAlternativeTile 

func (self Instance) GetCellAlternativeTile(coords Vector2i.XY) int

Returns the tile alternative ID of the cell at coordinates 'coords'.

func (Instance) GetCellAtlasCoords 

func (self Instance) GetCellAtlasCoords(coords Vector2i.XY) Vector2i.XY

Returns the tile atlas coordinates ID of the cell at coordinates 'coords'. Returns Vector2i(-1, -1) if the cell does not exist.

func (Instance) GetCellSourceId 

func (self Instance) GetCellSourceId(coords Vector2i.XY) int

Returns the tile source ID of the cell at coordinates 'coords'. Returns -1 if the cell does not exist.

func (Instance) GetCellTileData 

func (self Instance) GetCellTileData(coords Vector2i.XY) TileData.Instance

Returns the graphics.gd/classdb/TileData object associated with the given cell, or null if the cell does not exist or is not a graphics.gd/classdb/TileSetAtlasSource.

func (Instance) GetCoordsForBodyRid 

func (self Instance) GetCoordsForBodyRid(body RID.Body2D) Vector2i.XY

Returns the coordinates of the physics quadrant (see Instance.PhysicsQuadrantSize) for given physics body [Resource.ID]. Such an [Resource.ID] can be retrieved from graphics.gd/classdb/KinematicCollision2D.Instance.GetColliderRid, when colliding with a tile.

func (Instance) GetNavigationMap 

func (self Instance) GetNavigationMap() RID.NavigationMap2D

Returns the [Resource.ID] of the graphics.gd/classdb/NavigationServer2D navigation used by this graphics.gd/classdb/TileMapLayer.

By default this returns the default graphics.gd/classdb/World2D navigation map, unless a custom map was provided using Instance.SetNavigationMap.

func (Instance) GetNeighborCell 

func (self Instance) GetNeighborCell(coords Vector2i.XY, neighbor TileSet.CellNeighbor) Vector2i.XY

Returns the neighboring cell to the one at coordinates 'coords', identified by the 'neighbor' direction. This method takes into account the different layouts a TileMap can take.

func (Instance) GetPattern 

func (self Instance) GetPattern(coords_array []Vector2i.XY) TileMapPattern.Instance

Creates and returns a new graphics.gd/classdb/TileMapPattern from the given array of cells. See also Instance.SetPattern.

func (Instance) GetSurroundingCells 

func (self Instance) GetSurroundingCells(coords Vector2i.XY) []Vector2i.XY

Returns the list of all neighboring cells to the one at 'coords'. Any neighboring cell is one that is touching edges, so for a square cell 4 cells would be returned, for a hexagon 6 cells are returned.

func (Instance) GetUsedCells 

func (self Instance) GetUsedCells() []Vector2i.XY

Returns a [Vector2i.XY] array with the positions of all cells containing a tile. A cell is considered empty if its source identifier equals -1, its atlas coordinate identifier is Vector2(-1, -1) and its alternative identifier is -1.

func (Instance) GetUsedCellsById 

func (self Instance) GetUsedCellsById() []Vector2i.XY

Returns a [Vector2i.XY] array with the positions of all cells containing a tile. Tiles may be filtered according to their source ('source_id'), their atlas coordinates ('atlas_coords'), or alternative id ('alternative_tile').

If a parameter has its value set to the default one, this parameter is not used to filter a cell. Thus, if all parameters have their respective default values, this method returns the same result as Instance.GetUsedCells.

A cell is considered empty if its source identifier equals -1, its atlas coordinate identifier is Vector2(-1, -1) and its alternative identifier is -1.

func (Instance) GetUsedRect 

func (self Instance) GetUsedRect() Rect2i.PositionSize

Returns a rectangle enclosing the used (non-empty) tiles of the map.

func (Instance) HasBodyRid 

func (self Instance) HasBodyRid(body RID.Body2D) bool

Returns whether the provided 'body' [Resource.ID] belongs to one of this graphics.gd/classdb/TileMapLayer's cells.

func (Instance) ID 

func (self Instance) ID() ID

func (Instance) IsCellFlippedH 

func (self Instance) IsCellFlippedH(coords Vector2i.XY) bool

Returns true if the cell at coordinates 'coords' is flipped horizontally. The result is valid only for atlas sources.

func (Instance) IsCellFlippedV 

func (self Instance) IsCellFlippedV(coords Vector2i.XY) bool

Returns true if the cell at coordinates 'coords' is flipped vertically. The result is valid only for atlas sources.

func (Instance) IsCellTransposed 

func (self Instance) IsCellTransposed(coords Vector2i.XY) bool

Returns true if the cell at coordinates 'coords' is transposed. The result is valid only for atlas sources.

func (Instance) LocalToMap 

func (self Instance) LocalToMap(local_position Vector2.XY) Vector2i.XY

Returns the map coordinates of the cell containing the given 'local_position'. If 'local_position' is in global coordinates, consider using graphics.gd/classdb/Node2D.Instance.ToLocal before passing it to this method. See also Instance.MapToLocal.

func (Instance) MapPattern 

func (self Instance) MapPattern(position_in_tilemap Vector2i.XY, coords_in_pattern Vector2i.XY, pattern TileMapPattern.Instance) Vector2i.XY

Returns for the given coordinates 'coords_in_pattern' in a graphics.gd/classdb/TileMapPattern the corresponding cell coordinates if the pattern was pasted at the 'position_in_tilemap' coordinates (see Instance.SetPattern). This mapping is required as in half-offset tile shapes, the mapping might not work by calculating position_in_tile_map + coords_in_pattern.

func (Instance) MapToLocal 

func (self Instance) MapToLocal(map_position Vector2i.XY) Vector2.XY

Returns the centered position of a cell in the graphics.gd/classdb/TileMapLayer's local coordinate space. To convert the returned value into global coordinates, use graphics.gd/classdb/Node2D.Instance.ToGlobal. See also Instance.LocalToMap.

Note: This may not correspond to the visual position of the tile, i.e. it ignores the graphics.gd/classdb/TileData.Instance.TextureOrigin property of individual tiles.

func (Instance) NavigationEnabled 

func (self Instance) NavigationEnabled() bool

func (Instance) NavigationVisibilityMode 

func (self Instance) NavigationVisibilityMode() DebugVisibilityMode

func (Instance) NotifyRuntimeTileDataUpdate 

func (self Instance) NotifyRuntimeTileDataUpdate()

Notifies the graphics.gd/classdb/TileMapLayer node that calls to [Interface.UseTileDataRuntimeUpdate] or [Interface.TileDataRuntimeUpdate] will lead to different results. This will thus trigger a graphics.gd/classdb/TileMapLayer update.

Warning: Updating the graphics.gd/classdb/TileMapLayer is computationally expensive and may impact performance. Try to limit the number of calls to this function to avoid unnecessary update.

Note: This does not trigger a direct update of the graphics.gd/classdb/TileMapLayer, the update will be done at the end of the frame as usual (unless you call Instance.UpdateInternals).

func (Instance) OcclusionEnabled 

func (self Instance) OcclusionEnabled() bool

func (Instance) OnChanged 

func (self Instance) OnChanged(cb func(), flags ...Signal.Flags)

func (Instance) PhysicsQuadrantSize 

func (self Instance) PhysicsQuadrantSize() int

func (Instance) RenderingQuadrantSize 

func (self Instance) RenderingQuadrantSize() int

func (Instance) SetCell 

func (self Instance) SetCell(coords Vector2i.XY)

Sets the tile identifiers for the cell at coordinates 'coords'. Each tile of the graphics.gd/classdb/TileSet is identified using three parts:

- The source identifier 'source_id' identifies a graphics.gd/classdb/TileSetSource identifier. See graphics.gd/classdb/TileSet.Instance.SetSourceId,

- The atlas coordinate identifier 'atlas_coords' identifies a tile coordinates in the atlas (if the source is a graphics.gd/classdb/TileSetAtlasSource). For graphics.gd/classdb/TileSetScenesCollectionSource it should always be Vector2i(0, 0),

- The alternative tile identifier 'alternative_tile' identifies a tile alternative in the atlas (if the source is a graphics.gd/classdb/TileSetAtlasSource), and the scene for a graphics.gd/classdb/TileSetScenesCollectionSource.

If 'source_id' is set to -1, 'atlas_coords' to Vector2i(-1, -1), or 'alternative_tile' to -1, the cell will be erased. An erased cell gets all its identifiers automatically set to their respective invalid values, namely -1, Vector2i(-1, -1) and -1.

func (Instance) SetCellsTerrainConnect 

func (self Instance) SetCellsTerrainConnect(cells []Vector2i.XY, terrain_set int, terrain int)

Update all the cells in the 'cells' coordinates array so that they use the given 'terrain' for the given 'terrain_set'. If an updated cell has the same terrain as one of its neighboring cells, this function tries to join the two. This function might update neighboring tiles if needed to create correct terrain transitions.

If 'ignore_empty_terrains' is true, empty terrains will be ignored when trying to find the best fitting tile for the given terrain constraints.

Note: To work correctly, this method requires the graphics.gd/classdb/TileMapLayer's TileSet to have terrains set up with all required terrain combinations. Otherwise, it may produce unexpected results.

func (Instance) SetCellsTerrainPath 

func (self Instance) SetCellsTerrainPath(path []Vector2i.XY, terrain_set int, terrain int)

Update all the cells in the 'path' coordinates array so that they use the given 'terrain' for the given 'terrain_set'. The function will also connect two successive cell in the path with the same terrain. This function might update neighboring tiles if needed to create correct terrain transitions.

If 'ignore_empty_terrains' is true, empty terrains will be ignored when trying to find the best fitting tile for the given terrain constraints.

Note: To work correctly, this method requires the graphics.gd/classdb/TileMapLayer's TileSet to have terrains set up with all required terrain combinations. Otherwise, it may produce unexpected results.

func (Instance) SetCollisionEnabled 

func (self Instance) SetCollisionEnabled(value bool)

func (Instance) SetCollisionVisibilityMode 

func (self Instance) SetCollisionVisibilityMode(value DebugVisibilityMode)

func (Instance) SetEnabled 

func (self Instance) SetEnabled(value bool)

func (Instance) SetNavigationEnabled 

func (self Instance) SetNavigationEnabled(value bool)

func (Instance) SetNavigationMap 

func (self Instance) SetNavigationMap(map_ RID.NavigationMap2D)

Sets a custom 'map' as a graphics.gd/classdb/NavigationServer2D navigation map. If not set, uses the default graphics.gd/classdb/World2D navigation map instead.

func (Instance) SetNavigationVisibilityMode 

func (self Instance) SetNavigationVisibilityMode(value DebugVisibilityMode)

func (*Instance) SetObject 

func (self *Instance) SetObject(obj [1]gd.Object) bool

func (Instance) SetOcclusionEnabled 

func (self Instance) SetOcclusionEnabled(value bool)

func (Instance) SetPattern 

func (self Instance) SetPattern(position Vector2i.XY, pattern TileMapPattern.Instance)

Pastes the graphics.gd/classdb/TileMapPattern at the given 'position' in the tile map. See also Instance.GetPattern.

func (Instance) SetPhysicsQuadrantSize 

func (self Instance) SetPhysicsQuadrantSize(value int)

func (Instance) SetRenderingQuadrantSize 

func (self Instance) SetRenderingQuadrantSize(value int)

func (Instance) SetTileMapData 

func (self Instance) SetTileMapData(value []byte)

func (Instance) SetTileSet 

func (self Instance) SetTileSet(value TileSet.Instance)

func (Instance) SetUseKinematicBodies 

func (self Instance) SetUseKinematicBodies(value bool)

func (Instance) SetXDrawOrderReversed 

func (self Instance) SetXDrawOrderReversed(value bool)

func (Instance) SetYSortOrigin 

func (self Instance) SetYSortOrigin(value int)

func (Instance) TileMapData 

func (self Instance) TileMapData() []byte

func (Instance) TileSet 

func (self Instance) TileSet() TileSet.Instance

func (Instance) UpdateInternals 

func (self Instance) UpdateInternals()

Triggers a direct update of the graphics.gd/classdb/TileMapLayer. Usually, calling this function is not needed, as graphics.gd/classdb/TileMapLayer node updates automatically when one of its properties or cells is modified.

However, for performance reasons, those updates are batched and delayed to the end of the frame. Calling this function will force the graphics.gd/classdb/TileMapLayer to update right away instead.

Warning: Updating the graphics.gd/classdb/TileMapLayer is computationally expensive and may impact performance. Try to limit the number of updates and how many tiles they impact.

func (Instance) UseKinematicBodies 

func (self Instance) UseKinematicBodies() bool

func (Instance) Virtual 

func (self Instance) Virtual(name string) reflect.Value

func (Instance) XDrawOrderReversed 

func (self Instance) XDrawOrderReversed() bool

func (Instance) YSortOrigin 

func (self Instance) YSortOrigin() int

type Interface 

type Interface interface {
	// Should return true if the tile at coordinates 'coords' requires a runtime update.
	//
	// Warning: Make sure this function only returns true when needed. Any tile processed at runtime without a need for it will imply a significant performance penalty.
	//
	// Note: If the result of this function should change, use [Instance.NotifyRuntimeTileDataUpdate] to notify the [graphics.gd/classdb/TileMapLayer] it needs an update.
	UseTileDataRuntimeUpdate(coords Vector2i.XY) bool
	// Called with a [graphics.gd/classdb/TileData] object about to be used internally by the [graphics.gd/classdb/TileMapLayer], allowing its modification at runtime.
	//
	// This method is only called if [Interface.UseTileDataRuntimeUpdate] is implemented and returns true for the given tile 'coords'.
	//
	// Warning: The 'tile_data' object's sub-resources are the same as the one in the TileSet. Modifying them might impact the whole TileSet. Instead, make sure to duplicate those resources.
	//
	// Note: If the properties of 'tile_data' object should change over time, use [Instance.NotifyRuntimeTileDataUpdate] to notify the [graphics.gd/classdb/TileMapLayer] it needs an update.
	TileDataRuntimeUpdate(coords Vector2i.XY, tile_data TileData.Instance)
	// Called when this [graphics.gd/classdb/TileMapLayer]'s cells need an internal update. This update may be caused from individual cells being modified or by a change in the [Instance.TileSet] (causing all cells to be queued for an update). The first call to this function is always for initializing all the [graphics.gd/classdb/TileMapLayer]'s cells. 'coords' contains the coordinates of all modified cells, roughly in the order they were modified. 'forced_cleanup' is true when the [graphics.gd/classdb/TileMapLayer]'s internals should be fully cleaned up. This is the case when:
	//
	// - The layer is disabled;
	//
	// - The layer is not visible;
	//
	// - [Instance.TileSet] is set to null;
	//
	// - The node is removed from the tree;
	//
	// - The node is freed.
	//
	// Note that any internal update happening while one of these conditions is verified is considered to be a "cleanup". See also [Instance.UpdateInternals].
	//
	// Warning: Implementing this method may degrade the [graphics.gd/classdb/TileMapLayer]'s performance.
	UpdateCells(coords []Vector2i.XY, forced_cleanup bool)
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.