Tilemap API documentation

Version: alpha

FUNCTION
tilemap.set_tile()	set a tile in a tile map
tilemap.get_tile()	get a tile from a tile map
tilemap.get_bounds()	get the bounds of a tile map
tilemap.set_visible()	set the visibility of a layer

CONSTANT
tilemap.H_FLIP	flip tile horizontally
tilemap.V_FLIP	flip tile vertically
tilemap.ROTATE_90	rotate tile 90 degrees clockwise
tilemap.ROTATE_180	rotate tile 180 degrees clockwise
tilemap.ROTATE_270	rotate tile 270 degrees clockwise

PROPERTIES
tile_source	hash tile source
material	hash tile map material

Functions

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  |
+-------+-------+------+------+

The coordinates must be within the bounds of the tile map as it were created. That is, it is not possible to extend the size of a tile map by setting tiles outside the edges. To clear a tile, set the tile to number 0. Which tile map and layer to manipulate is identified by the URL and the layer name parameters. Transform bitmask is arithmetic sum of one or both FLIP constants (tilemap.H_FLIP, tilemap.V_FLIP) and/or one of ROTATION constants (tilemap.ROTATE_90, tilemap.ROTATE_180, tilemap.ROTATE_270). Flip always applies before rotation (clockwise).

PARAMETERS

`url`	`string, hash, url`	the tile map
`layer`	`string, hash`	name of the layer for the tile
`x`	`number`	x-coordinate of the tile
`y`	`number`	y-coordinate of the tile
`tile`	`number`	index of new tile to set. 0 resets the cell
`[transform-bitmask]`	`number`	optional flip and/or rotation should be applied to the tile

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.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

`url`	`string, hash, url`	the tile map
`layer`	`string, hash`	name of the layer for the tile
`x`	`number`	x-coordinate of the tile
`y`	`number`	y-coordinate of the tile

RETURNS

tile number index of the tile

EXAMPLES

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

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

url string, hash, url the tile map

RETURNS

`x`	number	x coordinate of the bottom left corner
`y`	number	y coordinate of the bottom left corner
`w`	number	number of columns (width) in the tile map
`h`	number	number of rows (height) in the tile map

EXAMPLES

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

tilemap.set_visible()

tilemap.set_visible(url,layer,visible)

Sets the visibility of the tilemap layer

PARAMETERS

`url`	`string, hash, url`	the tile map
`layer`	`string, hash`	name of the layer for the tile
`visible`	`boolean`	should the layer be visible

EXAMPLES

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

Properties

tile_source

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

EXAMPLES

How to set tile source using a script property (see resource.tile_source)

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

material

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

EXAMPLES

How to set material using a script property (see resource.material)

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

Tilemap API documentation

Functions

Constants

Properties