Class: TileLayer

Constructor

new TileLayer(pos, size, tileInfoopt, renderOrderopt, useWebGLopt)

Create a tile layer object

Parameters:

Name	Type	Attributes	Default	Description
`pos`	Vector2			World space position
`size`	Vector2			World space size
`tileInfo`	TileInfo	<optional>		Default tile info for layer (used for size and texture), tile() by default, none when no image is loaded
`renderOrder`	number	<optional>	0	Objects are sorted by renderOrder
`useWebGL`	boolean	<optional>	true	Should this layer use WebGL for rendering

Source: src/engineTileLayer.js, line 491

Example

const tileLayer = new TileLayer(vec2(), vec2(200,100));

Extends

CanvasLayer

Members

data

Properties

Type	Description
Array.<TileLayerData>	Array of tile data for the layer

Source: src/engineTileLayer.js, line 512

debugShow

Properties

Type	Description
boolean	Show this layer's bounds and values when the debug overlay's Debug Tiles is on, turn it off for layers that only add noise

Source: src/engineTileLayer.js, line 520

isUsingWebGL

Properties

Type	Description
boolean	Is this layer using a webgl texture?

Source: src/engineTileLayer.js, line 514

savedRenderSettings

Source: src/engineTileLayer.js, line 634

tileInfo :TileInfo|undefined

Type:

TileInfo | undefined

Properties

Type	Description
TileInfo \| undefined	Default tile info for layer

Source: src/engineTileLayer.js, line 510

Methods

clearData(layerPos, redrawopt)

Clear data at a given position in the array

Parameters:

Name	Type	Attributes	Default	Description
`layerPos`	Vector2			Local position in array
`redraw`	boolean	<optional>	false	Force the tile to redraw if true

Source: src/engineTileLayer.js, line 571

clearLayerRect(pos, size)

Clear a rectangle in layer space

Parameters:

Name	Type	Description
`pos`	Vector2	position in pixel coordinates
`size`	Vector2

Source: src/engineTileLayer.js, line 800

drawLayerRect(pos, size, coloropt, angleopt)

Draw a rectangle in layer space

Parameters:

Name	Type	Attributes	Default	Description
`pos`	Vector2
`size`	Vector2
`color`	Color	<optional>	WHITE	Color to modulate with
`angle`	number	<optional>	0	Angle to rotate by

Source: src/engineTileLayer.js, line 748

drawLayerTile(pos, sizeopt, tileInfoopt, coloropt, angleopt, mirroropt, additiveColoropt)

Draw textured tile in layer space

Parameters:

Name	Type	Attributes	Default	Description
`pos`	Vector2			Position in pixel coordinates
`size`	Vector2	<optional>	vec2(1)	Size of the tile
`tileInfo`	TileInfo	<optional>		Tile info to use, untextured if undefined
`color`	Color	<optional>	WHITE	Color to modulate with
`angle`	number	<optional>	0	Angle to rotate by
`mirror`	boolean	<optional>		Is image flipped along the Y axis?
`additiveColor`	Color	<optional>		Additive color to be applied if any

Source: src/engineTileLayer.js, line 735

drawRect(pos, sizeopt, coloropt, angleopt)

Draw a rectangle onto the layer canvas in world space

Parameters:

Name	Type	Attributes	Default
`pos`	Vector2
`size`	Vector2	<optional>	vec2(1)
`color`	Color	<optional>	WHITE
`angle`	number	<optional>

Source: src/engineTileLayer.js, line 793

drawTile(pos, sizeopt, tileInfoopt, coloropt, angleopt, mirroropt)

Draw a tile onto the layer canvas in world space

Parameters:

Name	Type	Attributes	Default
`pos`	Vector2
`size`	Vector2	<optional>	vec2(1)
`tileInfo`	TileInfo	<optional>
`color`	Color	<optional>	WHITE
`angle`	number	<optional>	0
`mirror`	boolean	<optional>	false

Source: src/engineTileLayer.js, line 758

drawTileData(layerPos, clearopt)

Draw the tile at a given position in the tile layer This can be used to clear out tiles when they are destroyed Tiles can also be redrawn if inside a redrawStart/End block

Parameters:

Name	Type	Attributes	Default	Description
`layerPos`	Vector2
`clear`	boolean	<optional>	true	should the old tile be cleared out

Source: src/engineTileLayer.js, line 692

getData(layerPos) → {TileLayerData|undefined}

Get data at a given position in the array

Parameters:

Name	Type	Description
`layerPos`	Vector2	Local position in array

Source: src/engineTileLayer.js, line 577

Returns:

Type:: TileLayerData | undefined

onRedraw()

Called after this layer is redrawn, does nothing by default

Source: src/engineTileLayer.js, line 600

redraw()

Draw all the tile data to an offscreen canvas

This may be slow if not using webgl but only needs to be done once

Source: src/engineTileLayer.js, line 604

redrawEnd()

Call to end the redraw process

Source: src/engineTileLayer.js, line 671

redrawStart(clearopt)

Call to start the redraw process

This can be used to manually update parts of the level

Parameters:

Name	Type	Attributes	Default	Description
`clear`	boolean	<optional>	false	Should it clear the canvas before drawing

Source: src/engineTileLayer.js, line 626

redrawTileData(layerPos, clearopt)

Draw the tile at a given position in the tile layer This can be used to clear tiles when they are destroyed For better performance use drawTileData inside a redrawStart/End block

Parameters:

Name	Type	Attributes	Default	Description
`layerPos`	Vector2
`clear`	boolean	<optional>	true	should the old tile be cleared

Source: src/engineTileLayer.js, line 717

setData(layerPos, data, redrawopt)

Set data at a given position in the array

Parameters:

Name	Type	Attributes	Default	Description
`layerPos`	Vector2			Local position in array
`data`	TileLayerData			Data to set
`redraw`	boolean	<optional>	false	Force the tile to redraw if true

Source: src/engineTileLayer.js, line 554