Tilemap API documentation

Version: alpha

Functions

tilemap.get_bounds()

tilemap.get_bounds(url)

Get the bounds for a tile map. This function returns multiple values: The lower left corner index x and y coordinates (1-indexed), the tile map width and the tile map height. The resulting values take all tile map layers into account, meaning that the bounds are calculated as if all layers were collapsed into one.

PARAMETERS

RETURNS

EXAMPLES

-- get the level bounds.
local x, y, w, h = tilemap.get_bounds("/level#tilemap")

tilemap.get_tile()

tilemap.get_tile(url,layer,x,y)

Get the tile set at the specified position in the tilemap. The position is identified by the tile index starting at origin with index 1, 1. (see tilemap.set_tile()) Which tile map and layer to query is identified by the URL and the layer name parameters.

PARAMETERS

RETURNS

EXAMPLES

-- get the tile under the player.
local tileno = tilemap.get_tile("/level#tilemap", "foreground", self.player_x, self.player_y)

tilemap.get_tile_info()

tilemap.get_tile_info(url,layer,x,y)

Get the tile information at the specified position in the tilemap. The position is identified by the tile index starting at origin with index 1, 1. (see tilemap.set_tile()) Which tile map and layer to query is identified by the URL and the layer name parameters.

PARAMETERS

RETURNS

EXAMPLES

-- get the tile under the player.
local tile_info = tilemap.get_tile_info("/level#tilemap", "foreground", self.player_x, self.player_y)
pprint(tile_info)
-- {
--    index = 0,
--    h_flip = false,
--    v_flip = true,
--    rotate_90 = false
-- }

tilemap.get_tiles()

tilemap.get_tiles(url,layer)

Retrieves all the tiles for the specified layer in the tilemap. It returns a table of rows where the keys are the tile positions (see tilemap.get_bounds()). You can iterate it using tiles[row_index][column_index].

PARAMETERS

RETURNS

EXAMPLES

local left, bottom, columns_count, rows_count = tilemap.get_bounds("#tilemap")
local tiles = tilemap.get_tiles("#tilemap", "layer")
local tile, count = 0, 0
for row_index = bottom, bottom + rows_count - 1 do
    for column_index = left, left + columns_count - 1 do
        tile = tiles[row_index][column_index]
        count = count + 1
    end
end

tilemap.set_tile()

tilemap.set_tile(url,layer,x,y,tile,[transform_bitmask])

Replace a tile in a tile map with a new tile. The coordinates of the tiles are indexed so that the "first" tile just above and to the right of origin has coordinates 1,1. Tiles to the left of and below origin are indexed 0, -1, -2 and so forth.

+-------+-------+------+------+
|  0,3  |  1,3  | 2,3  | 3,3  |
+-------+-------+------+------+
|  0,2  |  1,2  | 2,2  | 3,2  |
+-------+-------+------+------+
|  0,1  |  1,1  | 2,1  | 3,1  |
+-------O-------+------+------+
|  0,0  |  1,0  | 2,0  | 3,0  |
+-------+-------+------+------+

PARAMETERS

EXAMPLES

-- Clear the tile under the player.
tilemap.set_tile("/level#tilemap", "foreground", self.player_x, self.player_y, 0)

-- Set tile with different combination of flip and rotation
tilemap.set_tile("#tilemap", "layer1", x, y, 0, tilemap.H_FLIP + tilemap.V_FLIP + tilemap.ROTATE_90)
tilemap.set_tile("#tilemap", "layer1", x, y, 0, tilemap.H_FLIP + tilemap.ROTATE_270)
tilemap.set_tile("#tilemap", "layer1", x, y, 0, tilemap.V_FLIP + tilemap.H_FLIP)
tilemap.set_tile("#tilemap", "layer1", x, y, 0, tilemap.ROTATE_180)

tilemap.set_visible()

tilemap.set_visible(url,layer,visible)

Sets the visibility of the tilemap layer

PARAMETERS

EXAMPLES

-- Disable rendering of the layer
tilemap.set_visible("/level#tilemap", "foreground", false)

Constants

tilemap.H_FLIP

flip tile horizontally

tilemap.ROTATE_180

rotate tile 180 degrees clockwise

tilemap.ROTATE_270

rotate tile 270 degrees clockwise

tilemap.ROTATE_90

rotate tile 90 degrees clockwise

tilemap.V_FLIP

flip tile vertically

Properties

material

The material used when rendering the tile map. The type of the property is hash.

EXAMPLES

go.property("my_material", resource.material("/material.material"))
function init(self)
  go.set("#tilemap", "material", self.my_material)
end

tile_source

The tile source used when rendering the tile map. The type of the property is hash.

EXAMPLES

go.property("my_tile_source", resource.tile_source("/tilesource.tilesource"))
function init(self)
  go.set("#tilemap", "tile_source", self.my_tile_source)
end