TileMap

package
v0.0.0-...-80877a9 Latest Latest
Warning

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

 Go to latest Published: Feb 8, 2025 License: MIT Imports: 26 Imported by: 0

Documentation

Overview

Package TileMap provides methods for working with TileMap object instances.

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
	AsTileMap() Instance
}

type Implementation 

type Implementation = implementation

Implementation implements Interface with empty methods.

type Instance 

type Instance [1]gdclass.TileMap

Node for 2D tile-based maps. Tilemaps use a [TileSet] which contain a list of tiles which are used to create grid-based maps. A TileMap may have several layers, layouting tiles on top of each other. For performance reasons, all TileMap updates are batched at the end of a frame. Notably, this means that scene tiles from a [TileSetScenesCollectionSource] may be initialized after their parent. This is only queued when inside the scene tree. To force an update earlier on, call [method update_internals]. 

See [Interface] for methods that can be overridden by a [Class] that extends it.

%!(EXTRA string=TileMap) 

var Nil Instance

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

func New 

func New() Instance

func (Instance) AddLayer 

func (self Instance) AddLayer(to_position int)

Adds a layer at the given position [param to_position] in the array. If [param to_position] is negative, the position is counted from the end, with [code]-1[/code] adding the layer at the end of the array.

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) AsTileMap 

func (self Instance) AsTileMap() Instance

func (Instance) Clear 

func (self Instance) Clear()

Clears all cells.

func (Instance) ClearLayer 

func (self Instance) ClearLayer(layer int)

Clears all cells on the given layer. If [param layer] is negative, the layers are accessed from the last one.

func (Instance) CollisionAnimatable 

func (self Instance) CollisionAnimatable() bool

func (Instance) CollisionVisibilityMode 

func (self Instance) CollisionVisibilityMode() gdclass.TileMapVisibilityMode

func (Instance) EraseCell 

func (self Instance) EraseCell(layer int, coords Vector2i.XY)

Erases the cell on layer [param layer] at coordinates [param coords]. If [param layer] is negative, the layers are accessed from the last one.

func (Instance) FixInvalidTiles 

func (self Instance) FixInvalidTiles()

Clears cells that do not exist in the tileset.

func (Instance) ForceUpdate 

func (self Instance) ForceUpdate()

Forces the TileMap and the layer [param layer] to update.

func (Instance) GetCellAlternativeTile 

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

Returns the tile alternative ID of the cell on layer [param layer] at [param coords]. If [param use_proxies] is [code]false[/code], ignores the [TileSet]'s tile proxies, returning the raw alternative identifier. See [method TileSet.map_tile_proxy]. If [param layer] is negative, the layers are accessed from the last one.

func (Instance) GetCellAtlasCoords 

func (self Instance) GetCellAtlasCoords(layer int, coords Vector2i.XY) Vector2i.XY

Returns the tile atlas coordinates ID of the cell on layer [param layer] at coordinates [param coords]. Returns [code]Vector2i(-1, -1)[/code] if the cell does not exist. If [param use_proxies] is [code]false[/code], ignores the [TileSet]'s tile proxies, returning the raw atlas coordinate identifier. See [method TileSet.map_tile_proxy]. If [param layer] is negative, the layers are accessed from the last one.

func (Instance) GetCellSourceId 

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

Returns the tile source ID of the cell on layer [param layer] at coordinates [param coords]. Returns [code]-1[/code] if the cell does not exist. If [param use_proxies] is [code]false[/code], ignores the [TileSet]'s tile proxies, returning the raw source identifier. See [method TileSet.map_tile_proxy]. If [param layer] is negative, the layers are accessed from the last one.

func (Instance) GetCellTileData 

func (self Instance) GetCellTileData(layer int, coords Vector2i.XY) [1]gdclass.TileData

Returns the [TileData] object associated with the given cell, or [code]null[/code] if the cell does not exist or is not a [TileSetAtlasSource]. If [param layer] is negative, the layers are accessed from the last one. [codeblock] func get_clicked_tile_power(): 

var clicked_cell = tile_map.local_to_map(tile_map.get_local_mouse_position())
var data = tile_map.get_cell_tile_data(0, clicked_cell)
if data:
    return data.get_custom_data("power")
else:
    return 0

[/codeblock] If [param use_proxies] is [code]false[/code], ignores the [TileSet]'s tile proxies. See [method TileSet.map_tile_proxy].

func (Instance) GetCoordsForBodyRid 

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

Returns the coordinates of the tile for given physics body RID. Such RID can be retrieved from [method KinematicCollision2D.get_collider_rid], when colliding with a tile.

func (Instance) GetLayerForBodyRid 

func (self Instance) GetLayerForBodyRid(body RID.Body2D) int

Returns the tilemap layer of the tile for given physics body RID. Such RID can be retrieved from [method KinematicCollision2D.get_collider_rid], when colliding with a tile.

func (Instance) GetLayerModulate 

func (self Instance) GetLayerModulate(layer int) Color.RGBA

Returns a TileMap layer's modulate. If [param layer] is negative, the layers are accessed from the last one.

func (Instance) GetLayerName 

func (self Instance) GetLayerName(layer int) string

Returns a TileMap layer's name. If [param layer] is negative, the layers are accessed from the last one.

func (Instance) GetLayerNavigationMap 

func (self Instance) GetLayerNavigationMap(layer int) RID.NavigationMap2D

Returns the [RID] of the [NavigationServer2D] navigation map assigned to the specified TileMap layer [param layer]. By default the TileMap uses the default [World2D] navigation map for the first TileMap layer. For each additional TileMap layer a new navigation map is created for the additional layer. In order to make [NavigationAgent2D] switch between TileMap layer navigation maps use [method NavigationAgent2D.set_navigation_map] with the navigation map received from [method get_layer_navigation_map]. If [param layer] is negative, the layers are accessed from the last one.

func (Instance) GetLayerYSortOrigin 

func (self Instance) GetLayerYSortOrigin(layer int) int

Returns a TileMap layer's Y sort origin. If [param layer] is negative, the layers are accessed from the last one.

func (Instance) GetLayerZIndex 

func (self Instance) GetLayerZIndex(layer int) int

Returns a TileMap layer's Z-index value. If [param layer] is negative, the layers are accessed from the last one.

func (Instance) GetLayersCount 

func (self Instance) GetLayersCount() int

Returns the number of layers in the TileMap.

func (Instance) GetNavigationMap 

func (self Instance) GetNavigationMap(layer int) RID.NavigationMap2D

Returns the [RID] of the [NavigationServer2D] navigation map assigned to the specified TileMap layer [param layer].

func (Instance) GetNeighborCell 

func (self Instance) GetNeighborCell(coords Vector2i.XY, neighbor gdclass.TileSetCellNeighbor) Vector2i.XY

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

func (Instance) GetPattern 

func (self Instance) GetPattern(layer int, coords_array []Vector2i.XY) [1]gdclass.TileMapPattern

Creates a new [TileMapPattern] from the given layer and set of cells. If [param layer] is negative, the layers are accessed from the last one.

func (Instance) GetSurroundingCells 

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

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

func (Instance) GetUsedCells 

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

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 [code]Vector2(-1, -1)[/code] and its alternative identifier is -1. If [param layer] is negative, the layers are accessed from the last one.

func (Instance) GetUsedCellsById 

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

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 ([param source_id]), their atlas coordinates ([param atlas_coords]) or alternative id ([param 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 value, this method returns the same result as [method get_used_cells]. A cell is considered empty if its source identifier equals -1, its atlas coordinates identifiers is [code]Vector2(-1, -1)[/code] and its alternative identifier is -1. If [param layer] is negative, the layers are accessed from the last one.

func (Instance) GetUsedRect 

func (self Instance) GetUsedRect() Rect2i.PositionSize

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

func (Instance) IsLayerEnabled 

func (self Instance) IsLayerEnabled(layer int) bool

Returns if a layer is enabled. If [param layer] is negative, the layers are accessed from the last one.

func (Instance) IsLayerNavigationEnabled 

func (self Instance) IsLayerNavigationEnabled(layer int) bool

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

func (Instance) IsLayerYSortEnabled 

func (self Instance) IsLayerYSortEnabled(layer int) bool

Returns if a layer Y-sorts its tiles. If [param layer] is negative, the layers are accessed from the last one.

func (Instance) LocalToMap 

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

Returns the map coordinates of the cell containing the given [param local_position]. If [param local_position] is in global coordinates, consider using [method Node2D.to_local] before passing it to this method. See also [method map_to_local].

func (Instance) MapPattern 

func (self Instance) MapPattern(position_in_tilemap Vector2i.XY, coords_in_pattern Vector2i.XY, pattern [1]gdclass.TileMapPattern) Vector2i.XY

Returns for the given coordinate [param coords_in_pattern] in a [TileMapPattern] the corresponding cell coordinates if the pattern was pasted at the [param position_in_tilemap] coordinates (see [method set_pattern]). This mapping is required as in half-offset tile shapes, the mapping might not work by calculating [code]position_in_tile_map + coords_in_pattern[/code].

func (Instance) MapToLocal 

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

Returns the centered position of a cell in the TileMap's local coordinate space. To convert the returned value into global coordinates, use [method Node2D.to_global]. See also [method local_to_map]. [b]Note:[/b] This may not correspond to the visual position of the tile, i.e. it ignores the [member TileData.texture_origin] property of individual tiles.

func (Instance) MoveLayer 

func (self Instance) MoveLayer(layer int, to_position int)

Moves the layer at index [param layer] to the given position [param to_position] in the array.

func (Instance) NavigationVisibilityMode 

func (self Instance) NavigationVisibilityMode() gdclass.TileMapVisibilityMode

func (Instance) NotifyRuntimeTileDataUpdate 

func (self Instance) NotifyRuntimeTileDataUpdate()

Notifies the TileMap node that calls to [method _use_tile_data_runtime_update] or [method _tile_data_runtime_update] will lead to different results. This will thus trigger a TileMap update. If [param layer] is provided, only notifies changes for the given layer. Providing the [param layer] argument (when applicable) is usually preferred for performance reasons. [b]Warning:[/b] Updating the TileMap is computationally expensive and may impact performance. Try to limit the number of calls to this function to avoid unnecessary update. [b]Note:[/b] This does not trigger a direct update of the TileMap, the update will be done at the end of the frame as usual (unless you call [method update_internals]).

func (Instance) OnChanged 

func (self Instance) OnChanged(cb func())

func (Instance) RemoveLayer 

func (self Instance) RemoveLayer(layer int)

Removes the layer at index [param layer].

func (Instance) RenderingQuadrantSize 

func (self Instance) RenderingQuadrantSize() int

func (Instance) SetCell 

func (self Instance) SetCell(layer int, coords Vector2i.XY)

Sets the tile identifiers for the cell on layer [param layer] at coordinates [param coords]. Each tile of the [TileSet] is identified using three parts: - The source identifier [param source_id] identifies a [TileSetSource] identifier. See [method TileSet.set_source_id], - The atlas coordinates identifier [param atlas_coords] identifies a tile coordinates in the atlas (if the source is a [TileSetAtlasSource]). For [TileSetScenesCollectionSource] it should always be [code]Vector2i(0, 0)[/code]), - The alternative tile identifier [param alternative_tile] identifies a tile alternative in the atlas (if the source is a [TileSetAtlasSource]), and the scene for a [TileSetScenesCollectionSource]. If [param source_id] is set to [code]-1[/code], [param atlas_coords] to [code]Vector2i(-1, -1)[/code] or [param alternative_tile] to [code]-1[/code], the cell will be erased. An erased cell gets [b]all[/b] its identifiers automatically set to their respective invalid values, namely [code]-1[/code], [code]Vector2i(-1, -1)[/code] and [code]-1[/code]. If [param layer] is negative, the layers are accessed from the last one.

func (Instance) SetCellsTerrainConnect 

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

Update all the cells in the [param cells] coordinates array so that they use the given [param terrain] for the given [param 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 [param ignore_empty_terrains] is true, empty terrains will be ignored when trying to find the best fitting tile for the given terrain constraints. If [param layer] is negative, the layers are accessed from the last one. [b]Note:[/b] To work correctly, this method requires the TileMap'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(layer int, path []Vector2i.XY, terrain_set int, terrain int)

Update all the cells in the [param path] coordinates array so that they use the given [param terrain] for the given [param 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 [param ignore_empty_terrains] is true, empty terrains will be ignored when trying to find the best fitting tile for the given terrain constraints. If [param layer] is negative, the layers are accessed from the last one. [b]Note:[/b] To work correctly, this method requires the TileMap's TileSet to have terrains set up with all required terrain combinations. Otherwise, it may produce unexpected results.

func (Instance) SetCollisionAnimatable 

func (self Instance) SetCollisionAnimatable(value bool)

func (Instance) SetCollisionVisibilityMode 

func (self Instance) SetCollisionVisibilityMode(value gdclass.TileMapVisibilityMode)

func (Instance) SetLayerEnabled 

func (self Instance) SetLayerEnabled(layer int, enabled bool)

Enables or disables the layer [param layer]. A disabled layer is not processed at all (no rendering, no physics, etc.). If [param layer] is negative, the layers are accessed from the last one.

func (Instance) SetLayerModulate 

func (self Instance) SetLayerModulate(layer int, modulate Color.RGBA)

Sets a layer's color. It will be multiplied by tile's color and TileMap's modulate. If [param layer] is negative, the layers are accessed from the last one.

func (Instance) SetLayerName 

func (self Instance) SetLayerName(layer int, name string)

Sets a layer's name. This is mostly useful in the editor. If [param layer] is negative, the layers are accessed from the last one.

func (Instance) SetLayerNavigationEnabled 

func (self Instance) SetLayerNavigationEnabled(layer int, 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 (Instance) SetLayerNavigationMap 

func (self Instance) SetLayerNavigationMap(layer int, mapping RID.NavigationMap2D)

Assigns [param map] as a [NavigationServer2D] navigation map for the specified TileMap layer [param layer]. By default the TileMap uses the default [World2D] navigation map for the first TileMap layer. For each additional TileMap layer a new navigation map is created for the additional layer. In order to make [NavigationAgent2D] switch between TileMap layer navigation maps use [method NavigationAgent2D.set_navigation_map] with the navigation map received from [method get_layer_navigation_map]. If [param layer] is negative, the layers are accessed from the last one.

func (Instance) SetLayerYSortEnabled 

func (self Instance) SetLayerYSortEnabled(layer int, y_sort_enabled 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. Y-sorted layers should usually be on different Z-index values than not Y-sorted layers, otherwise, each of those layer will be Y-sorted as whole with the Y-sorted one. This is usually an undesired behavior. If [param layer] is negative, the layers are accessed from the last one.

func (Instance) SetLayerYSortOrigin 

func (self Instance) SetLayerYSortOrigin(layer int, y_sort_origin int)

Sets a layer's Y-sort origin value. This Y-sort origin value is added to each tile's Y-sort origin value. This allows, for example, to fake a different height level on each layer. This can be useful for top-down view games. If [param layer] is negative, the layers are accessed from the last one.

func (Instance) SetLayerZIndex 

func (self Instance) SetLayerZIndex(layer int, z_index int)

Sets a layers Z-index value. This Z-index is added to each tile's Z-index value. If [param layer] is negative, the layers are accessed from the last one.

func (Instance) SetNavigationMap 

func (self Instance) SetNavigationMap(layer int, mapping RID.NavigationMap2D)

Assigns [param map] as a [NavigationServer2D] navigation map for the specified TileMap layer [param layer].

func (Instance) SetNavigationVisibilityMode 

func (self Instance) SetNavigationVisibilityMode(value gdclass.TileMapVisibilityMode)

func (Instance) SetPattern 

func (self Instance) SetPattern(layer int, position Vector2i.XY, pattern [1]gdclass.TileMapPattern)

Paste the given [TileMapPattern] at the given [param position] and [param layer] in the tile map. If [param layer] is negative, the layers are accessed from the last one.

func (Instance) SetRenderingQuadrantSize 

func (self Instance) SetRenderingQuadrantSize(value int)

func (Instance) SetTileSet 

func (self Instance) SetTileSet(value [1]gdclass.TileSet)

func (Instance) TileSet 

func (self Instance) TileSet() [1]gdclass.TileSet

func (*Instance) UnsafePointer 

func (self *Instance) UnsafePointer() unsafe.Pointer

func (Instance) UpdateInternals 

func (self Instance) 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. However, for performance reasons, those updates are batched and delayed to the end of the frame. Calling this function will force the TileMap to update right away instead. [b]Warning:[/b] Updating the TileMap is computationally expensive and may impact performance. Try to limit the number of updates and how many tiles they impact.

func (Instance) Virtual 

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

type Interface 

type Interface interface {
	//Should return [code]true[/code] if the tile at coordinates [param coords] on layer [param layer] requires a runtime update.
	//[b]Warning:[/b] Make sure this function only return [code]true[/code] when needed. Any tile processed at runtime without a need for it will imply a significant performance penalty.
	//[b]Note:[/b] If the result of this function should changed, use [method notify_runtime_tile_data_update] to notify the TileMap it needs an update.
	UseTileDataRuntimeUpdate(layer int, coords Vector2i.XY) bool
	//Called with a TileData object about to be used internally by the TileMap, allowing its modification at runtime.
	//This method is only called if [method _use_tile_data_runtime_update] is implemented and returns [code]true[/code] for the given tile [param coords] and [param layer].
	//[b]Warning:[/b] The [param 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.
	//[b]Note:[/b] If the properties of [param tile_data] object should change over time, use [method notify_runtime_tile_data_update] to notify the TileMap it needs an update.
	TileDataRuntimeUpdate(layer int, coords Vector2i.XY, tile_data [1]gdclass.TileData)
}

type VisibilityMode 

type VisibilityMode = gdclass.TileMapVisibilityMode //gd:TileMap.VisibilityMode

const (
	/*Use the debug settings to determine visibility.*/
	VisibilityModeDefault VisibilityMode = 0
	/*Always hide.*/
	VisibilityModeForceHide VisibilityMode = 2
	/*Always show.*/
	VisibilityModeForceShow VisibilityMode = 1
)

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.