TileMap

Conformances

• protocol CustomStringConvertible

  A type with a customized textual representation.

• protocol Equatable

  A type that can be compared for value equality.

• protocol Hashable

  A type that can be hashed into a Hasher to produce an integer hash value.

• protocol Identifiable<ID>

  A class of types whose instances hold the value of an entity with stable identity.

• protocol VariantRepresentable

  Types that conform to VariantRepresentable can be stored directly in Variant with no conversion. These include all of the Variant types from Godot (for example GString, Rect, Plane), Godot objects (those that subclass SwiftGodot.Object) as well as the built-in Swift types UInt8, Int64 and Double.

• protocol VariantStorable

  Types that conform to VariantStorable can be stored in a Variant and can be extracted back out of a Variant.

Types

• enum VisibilityMode

Type members

• class var godotClassName: StringName

Instance members

• var changed: SimpleSignal

  Emitted when the TileSet of this TileMap changes.

• var collisionAnimatable: Bool

  If enabled, the TileMap will see its collisions synced to the physics tick and change its collision type from static to kinematic. This is required to create TileMap-based moving platform.

• var collisionVisibilityMode: TileMap.VisibilityMode

  Show or hide the TileMap’s collision shapes. If set to .default, this depends on the show collision debug settings.

• var navigationVisibilityMode: TileMap.VisibilityMode

  Show or hide the TileMap’s navigation meshes. If set to .default, this depends on the show navigation debug settings.

• var renderingQuadrantSize: Int32

  The TileMap’s quadrant size. A quadrant is a group of tiles to be drawn together on a single canvas item, for optimization purposes. renderingQuadrantSize defines the length of a square’s side, in the map’s coordinate system, that forms the quadrant. Thus, the default quandrant size groups together 16 * 16 = 256 tiles.

• var tileSet: TileSet?

  The assigned TileSet.

• func addLayer(toPosition: Int32)

  Adds a layer at the given position toPosition in the array. If toPosition is negative, the position is counted from the end, with -1 adding the layer at the end of the array.

• func clear()

  Clears all cells.

• func clearLayer(Int32)

  Clears all cells on the given layer.

• func eraseCell(layer: Int32, coords: Vector2i)

  Erases the cell on layer layer at coordinates coords.

• func fixInvalidTiles()

  Clears cells that do not exist in the tileset.

• func forceUpdate(layer: Int32)

  Deprecated. See notifyRuntimeTileDataUpdate(layer:) and updateInternals.

• func getCellAlternativeTile(layer: Int32, coords: Vector2i, useProxies: Bool) -> Int32

  Returns the tile alternative ID of the cell on layer layer at coords. If useProxies is false, ignores the TileSet’s tile proxies, returning the raw alternative identifier. See mapTileProxy(sourceFrom:coordsFrom:alternativeFrom:).

• func getCellAtlasCoords(layer: Int32, coords: Vector2i, useProxies: Bool) -> Vector2i

  Returns the tile atlas coordinates ID of the cell on layer layer at coordinates coords. If useProxies is false, ignores the TileSet’s tile proxies, returning the raw alternative identifier. See mapTileProxy(sourceFrom:coordsFrom:alternativeFrom:).

• func getCellSourceId(layer: Int32, coords: Vector2i, useProxies: Bool) -> Int32

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

• func getCellTileData(layer: Int32, coords: Vector2i, useProxies: Bool) -> TileData?

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

• func getCoordsForBodyRid(body: RID) -> Vector2i

  Returns the coordinates of the tile for given physics body RID. Such RID can be retrieved from getColliderRid, when colliding with a tile.

• func getLayerForBodyRid(body: RID) -> Int32

  Returns the tilemap layer of the tile for given physics body RID. Such RID can be retrieved from getColliderRid, when colliding with a tile.

• func getLayerModulate(layer: Int32) -> Color

  Returns a TileMap layer’s modulate.

• func getLayerName(layer: Int32) -> String

  Returns a TileMap layer’s name.

• func getLayerNavigationMap(layer: Int32) -> RID

  Returns the NavigationServer2D navigation map RID currently assigned to the specified TileMap layer.

• func getLayerYSortOrigin(layer: Int32) -> Int32

  Returns a TileMap layer’s Y sort origin.

• func getLayerZIndex(layer: Int32) -> Int32

  Returns a TileMap layer’s Z-index value.

• func getLayersCount() -> Int32

  Returns the number of layers in the TileMap.

• func getNavigationMap(layer: Int32) -> RID

  See getLayerNavigationMap(layer:).

• func getNeighborCell(coords: Vector2i, neighbor: TileSet.CellNeighbor) -> Vector2i

  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 getPattern(layer: Int32, coordsArray: VariantCollection<Vector2i>) -> TileMapPattern?

  Creates a new TileMapPattern from the given layer and set of cells.

• func getSurroundingCells(coords: Vector2i) -> VariantCollection<Vector2i>

  Returns the list of all neighbourings cells to the one at coords.

• func getUsedCells(layer: Int32) -> VariantCollection<Vector2i>

  Returns a Vector2i array with the positions of all cells containing a tile in the given layer. A cell is considered empty if its source identifier equals -1, its atlas coordinates identifiers is Vector2(-1, -1) and its alternative identifier is -1.

• func getUsedCellsById(layer: Int32, sourceId: Int32, atlasCoords: Vector2i, alternativeTile: Int32) -> VariantCollection<Vector2i>

  Returns a Vector2i array with the positions of all cells containing a tile in the given layer. Tiles may be filtered according to their source (sourceId), their atlas coordinates (atlasCoords) or alternative id (alternativeTile).

• func getUsedRect() -> Rect2i

  Returns a rectangle enclosing the used (non-empty) tiles of the map, including all layers.

• func isLayerEnabled(layer: Int32) -> Bool

  Returns if a layer is enabled.

• func isLayerNavigationEnabled(layer: Int32) -> Bool

  Returns if a layer’s built-in navigation regions generation is enabled.

• func isLayerYSortEnabled(layer: Int32) -> Bool

  Returns if a layer Y-sorts its tiles.

• func localToMap(localPosition: Vector2) -> Vector2i

  Returns the map coordinates of the cell containing the given localPosition. If localPosition is in global coordinates, consider using toLocal(globalPoint:) before passing it to this method. See also mapToLocal(mapPosition:).

• func mapPattern(positionInTilemap: Vector2i, coordsInPattern: Vector2i, pattern: TileMapPattern?) -> Vector2i

  Returns for the given coordinate coordsInPattern in a TileMapPattern the corresponding cell coordinates if the pattern was pasted at the positionInTilemap coordinates (see setPattern(layer:position:pattern:)). 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 mapToLocal(mapPosition: Vector2i) -> Vector2

  Returns the centered position of a cell in the TileMap’s local coordinate space. To convert the returned value into global coordinates, use toGlobal(localPoint:). See also localToMap(localPosition:).

• func moveLayer(Int32, toPosition: Int32)

  Moves the layer at index layer to the given position toPosition in the array.

• func notifyRuntimeTileDataUpdate(layer: Int32)

  Notifies the TileMap node that calls to _useTileDataRuntimeUpdate(layer:coords:) or _tileDataRuntimeUpdate(layer:coords:tileData:) will lead to different results. This will thus trigger a TileMap update.

• func removeLayer(Int32)

  Removes the layer at index layer.

• func setCell(layer: Int32, coords: Vector2i, sourceId: Int32, atlasCoords: Vector2i, alternativeTile: Int32)

  Sets the tile identifiers for the cell on layer layer at coordinates coords. Each tile of the TileSet is identified using three parts:

• func setCellsTerrainConnect(layer: Int32, cells: VariantCollection<Vector2i>, terrainSet: Int32, terrain: Int32, ignoreEmptyTerrains: Bool)

  Update all the cells in the cells coordinates array so that they use the given terrain for the given terrainSet. 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.

• func setCellsTerrainPath(layer: Int32, path: VariantCollection<Vector2i>, terrainSet: Int32, terrain: Int32, ignoreEmptyTerrains: Bool)

  Update all the cells in the path coordinates array so that they use the given terrain for the given terrainSet. 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.

• func setLayerEnabled(layer: Int32, enabled: Bool)

  Enables or disables the layer layer. A disabled layer is not processed at all (no rendering, no physics, etc…).

• func setLayerModulate(layer: Int32, modulate: Color)

  Sets a layer’s color. It will be multiplied by tile’s color and TileMap’s modulate.

• func setLayerName(layer: Int32, name: String)

  Sets a layer’s name. This is mostly useful in the editor.

• func setLayerNavigationEnabled(layer: Int32, enabled: Bool)

  Enables or disables a layer’s built-in navigation regions generation. Disable this if you need to bake navigation regions from a TileMap using a NavigationRegion2D node.

• func setLayerNavigationMap(layer: Int32, map: RID)

  Assigns a NavigationServer2D navigation map RID to the specified TileMap layer.

• func setLayerYSortEnabled(layer: Int32, ySortEnabled: Bool)

  Enables or disables a layer’s Y-sorting. If a layer is Y-sorted, the layer will behave as a CanvasItem node where each of its tile gets Y-sorted.

• func setLayerYSortOrigin(layer: Int32, ySortOrigin: Int32)

  Sets a layer’s Y-sort origin value. This Y-sort origin value is added to each tile’s Y-sort origin value.

• func setLayerZIndex(layer: Int32, zIndex: Int32)

  Sets a layers Z-index value. This Z-index is added to each tile’s Z-index value.

• func setNavigationMap(layer: Int32, map: RID)

  See setLayerNavigationMap(layer:map:).

• func setPattern(layer: Int32, position: Vector2i, pattern: TileMapPattern?)

  Paste the given TileMapPattern at the given position and layer in the tile map.

• func updateInternals()

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