Map

A 2D grid of sprites. Can be used to create tile-based games.

Usually represents the level or map of a game. Drawn using the map editor.

Creation

MapObj

Construct a new instance of an empty map.

map = MapObj(width, height, spriteSheet)

Parameter	Type	Default	Note
width	number	⚠️ required	in cells.
height	number	⚠️ required	in cells.
spriteSheet	SpriteSheet	⚠️ required

Return	Type	Note
map	Map

---

TileMap

A globally available instance for the standard tiles map of any game.

It contains the sprites drawn in the map editor.

TileMap:draw(); --draws the map on the screen.

caution

Do not destroy this object or render it unusable. As it's used by he map function.

Doing so would render it also unusable.

Methods

map:map

Transform the tile map by applying a function to every cell.

map:map(cellFunction, x, y, width, height)

Parameter	Type	Default	Note
cellFunction	CellFunction	⚠️ required
x	number	0	in cells.
y	number	0	in cells.
width	number	map width	in cells.
height	number	map width	in cells.

CellFunction

function cellFunction(cellX, cellY, spriteId)
    --Logic to modify the spriteId.
    return spriteId;
end

Parameter	Type	Note
cellX	number
cellY	number
spriteId	number

Return	Type	Note
spriteId	number, nil	nil to leave unmodified.

---

map:cell

Get the id of a sprite for a cell

spriteId = map:cell(cellX, cellY)

Parameter	Type	Default	Note
cellX	number	⚠️ required
cellY	number	⚠️ required

Return	Type	Note
spriteId	number

Set the id of a sprite for a cell

map = map:cell(cellX, cellY, spriteId)

Parameter	Type	Default	Note
cellX	number	⚠️ required
cellY	number	⚠️ required
spriteId	number	⚠️ required

Return	Type	Note
map	Map	the object itself. allows to do chain calls.

---

map:cut

Create a new map out of a region from this map.

resultMap = map:cut(x, y, width, height) 

Parameter	Type	Default	Note
x	number	0	in cells.
y	number	0	in cells.
width	number	map width	in cells.
height	number	map height	in cells.

Return	Type	Note
resultMap	Map

---

map:size

Get the dimensions of the map.

width, height = map:size()

Return	Type	Note
width	number	in cells.
height	number	in cells.

---

map:width

Get the width of the map.

width = map:width()

Return	Type	Note
width	number	in cells.

---

map:height

Get the height of the map.

height = map:height()

Return	Type	Note
height	number	in cells.

---

map:draw

Draw the map or a section of the map on the visible screen.

map = map:draw(destinationX, destinationY, sourceX, sourceY, sourceWidth, sourceHeight, scaleX, scaleY, spriteSheet)

Parameter	Type	Default	Note
destinationX	number	0	in pixels.
destinationY	number	0	in pixels.
sourceX	number	0	in cells.
sourceY	number	0	in cells.
sourceWidth	number	map width	in cells.
sourceHeight	number	map height	in cells.
spriteSheet	SpriteSheet	SpriteMap

Return	Type	Note
map	Map	the object itself. allows to do chain calls.

---

map:export

Export the tiles map data into a .lk12 raw string.

data = map:export()

Return	Type	Note
data	string	a .lk12 raw string.

---

map:import

Import the tiles map data into a .lk12 raw string.

map = map:import(data)

Parameter	Type	Default	Note
data	string	⚠️ required	a .lk12 raw string.

Return	Type	Note
map	Map	the object itself. allows to do chain calls.

---

map:spritebatch

Enable the use of a spritebatch for the rendering of the map. Which brings a huge performance boost.

map:spritebatch(usage)

Parameter	Type	Default	Note
usage	string	'static'	enum: 'dynamic', 'static', 'stream'.