Module flower.tiled.TileLayerRenderer

Renderer class is used to draw a tile layer.

Generated through the TileLayerRendererFactory.

Extends:

Info:

  • Release: V3.0.0
  • Author: Makoto

Functions

TileLayerRenderer:init (tileLayer) Constructor.
TileLayerRenderer:createRenderers () Create the tileset renderers.
TileLayerRenderer:createRenderer (tileset) Create the tileset renderer.
TileLayerRenderer:gidToTileNo (tileset, gid) Convert to tile value to draw the layer.
TileLayerRenderer:removeRenderer (renderer) Remove the tileset renderer.
TileLayerRenderer:getRenderableTilesets () Returns the renderable tilesets.
TileLayerRenderer:setGid (x, y, gid) Sets gid of the specified position.
TileLayerRenderer:clearGid (x, y) Clear gid of the specified position.
TileLayerRenderer:getRendererByTileset (tileset) Returns the renderer for the tileset.


Functions

TileLayerRenderer:init (tileLayer)
Constructor.

Parameters:

  • tileLayer Renderable tileLayer
TileLayerRenderer:createRenderers ()
Create the tileset renderers.
TileLayerRenderer:createRenderer (tileset)
Create the tileset renderer.

Parameters:

  • tileset tileset

Returns:

    tileset renderer
TileLayerRenderer:gidToTileNo (tileset, gid)
Convert to tile value to draw the layer. Use tile flag.

Parameters:

  • tileset tileset
  • gid gid

Returns:

    tileNo
TileLayerRenderer:removeRenderer (renderer)
Remove the tileset renderer.

Parameters:

  • renderer renderer
TileLayerRenderer:getRenderableTilesets ()
Returns the renderable tilesets.

Returns:

    renderable tilesets
TileLayerRenderer:setGid (x, y, gid)
Sets gid of the specified position. If you set the position is out of range to error.

Parameters:

  • x potision of x (0 <= x && x <= mapWidth)
  • y potision of y (0 <= y && y <= mapHeight)
  • gid global id.
TileLayerRenderer:clearGid (x, y)
Clear gid of the specified position.

Parameters:

  • x potision of x (0 <= x && x <= mapWidth)
  • y potision of y (0 <= y && y <= mapHeight)
TileLayerRenderer:getRendererByTileset (tileset)
Returns the renderer for the tileset.

Parameters:

  • tileset tileset

Returns:

    renderer
generated by LDoc 1.3