Difference between revisions of "TileMap"

From GiderosMobile
m (Text replacement - "<source" to "<syntaxhighlight")
Line 11: Line 11:
  
 
=== Example ===
 
=== Example ===
<source lang="lua">
+
<syntaxhighlight lang="lua">
 
-- set the tilemap texture
 
-- set the tilemap texture
 
local texture = Texture.new("gfx/finalts16.png")
 
local texture = Texture.new("gfx/finalts16.png")

Revision as of 15:31, 13 July 2023

Supported platforms: Platform android.pngPlatform ios.pngPlatform mac.pngPlatform pc.pngPlatform html5.pngPlatform winrt.pngPlatform win32.png
Available since: Gideros 2011.6
Inherits from: Sprite

Description

The TileMap class is used to work with tile maps easily and efficiently.

Check Desert and Sewers examples provided with Gideros for usage of TileMap with export from editor.

Example

<syntaxhighlight lang="lua"> -- set the tilemap texture local texture = Texture.new("gfx/finalts16.png") -- number of columns and rows in the tileset local tilesetcols, tilesetrows = 11, 5 -- calculate the tiles width and height local tilew, tileh = texture:getWidth() / tilesetcols, texture:getHeight() / tilesetrows -- create the tilemap local tm = TileMap.new( 2*16, 2*8, -- map size in tiles texture, -- tileset texture tilew, tileh, -- tile size in pixel 0, 0, -- spacing 0, 0, -- margin tilew, tileh -- display width and height ) -- build the map for i=1,4 do for j=1,4 do tm:setTile(i, j, i, j) end end -- some other tiles in the map tm:setTile(6,3,5,1) -- col position, row position, tile col index in tilemap, tile row index in tilemap tm:setTile(7,3,5,1) -- col position, row position, tile col index in tilemap, tile row index in tilemap tm:setTile(6,4,5,2) -- col position, row position, tile col index in tilemap, tile row index in tilemap tm:setTile(7,4,5,3) -- col position, row position, tile col index in tilemap, tile row index in tilemap -- position the map and add to stage tm:setPosition(0, 0) stage:addChild(tm) </source>

Methods

TileMap.new creates a new TileMap instance
TileMap:clearTile sets an empty tile at given indices
TileMap:getTile returns the index of the tile
TileMap:setRepeat indicates if the tilemap should repeat itself
TileMap:setTexture changes the tile texture/atlas used by the tilemap
TileMap:setTile sets the index of the tile
TileMap:shift shifts the tile map

Events

Constants

TileMap.FLIP_DIAGONAL 1
TileMap.FLIP_HORIZONTAL 4
TileMap.FLIP_VERTICAL 2