Class: TileLayer

Constructor

new TileLayer(positionopt, sizeopt, tileInfoopt, scaleopt, renderOrderopt)

Create a tile layer object

Parameters:

Name	Type	Attributes	Default	Description
`position`	Vector2	<optional>	(0,0)	World space position
`size`	Vector2	<optional>	tileCollisionSize	World space size
`tileInfo`	TileInfo	<optional>		Tile info for layer
`scale`	Vector2	<optional>	(1,1)	How much to scale this layer when rendered
`renderOrder`	Number	<optional>	0	Objects are sorted by renderOrder

Source: engineTileLayer.js, line 171

Example

// create tile collision and visible tile layer
initTileCollision(vec2(200,100));
const tileLayer = new TileLayer();

Extends

EngineObject

Members

additiveColor

Properties

Type	Description
Color	Additive color to apply when rendered

Overrides: EngineObject#additiveColor
Source: engineObject.js, line 61

angle

Properties

Type	Description
Number	Angle to rotate the object

Overrides: EngineObject#angle
Source: engineObject.js, line 57

angleDamping

Properties

Name	Type	Attributes	Default	Description
`angleDamping`	Number	<optional>	objectDefaultAngleDamping	How much to slow down rotation each frame (0-1)

Overrides: EngineObject#angleDamping
Source: engineObject.js, line 71

angleVelocity

Properties

Type	Description
Number	Angular velocity of the object

Overrides: EngineObject#angleVelocity
Source: engineObject.js, line 83

canvas

Properties

Type	Description
HTMLCanvasElement	The canvas used by this tile layer

Source: engineTileLayer.js, line 185

children

Properties

Type	Description
Array	List of children of this object

Overrides: EngineObject#children
Source: engineObject.js, line 87

clampSpeedLinear

Properties

Type	Description
Boolean	Limit object speed using linear or circular math

Overrides: EngineObject#clampSpeedLinear
Source: engineObject.js, line 89

collideRaycast

Properties

Type	Description
Boolean	Object collides with raycasts

Overrides: EngineObject#collideRaycast
Source: engineObject.js, line 107

collideSolidObjects

Properties

Type	Description
Boolean	Object collides with solid objects

Overrides: EngineObject#collideSolidObjects
Source: engineObject.js, line 103

collideTiles

Properties

Type	Description
Boolean	Object collides with the tile collision

Overrides: EngineObject#collideTiles
Source: engineObject.js, line 101

color

Properties

Type	Description
Color	Color to apply when rendered

Overrides: EngineObject#color
Source: engineObject.js, line 59

context

Properties

Type	Description
CanvasRenderingContext2D \| OffscreenCanvasRenderingContext2D	The 2D canvas context used by this tile layer

Source: engineTileLayer.js, line 187

damping

Properties

Name	Type	Attributes	Default	Description
`damping`	Number	<optional>	objectDefaultDamping	How much to slow down velocity each frame (0-1)

Overrides: EngineObject#damping
Source: engineObject.js, line 69

drawSize

Properties

Type	Description
Vector2	Size of object used for drawing, uses size if not set

Overrides: EngineObject#drawSize
Source: engineObject.js, line 53

elasticity

Properties

Name	Type	Attributes	Default	Description
`elasticity`	Number	<optional>	objectDefaultElasticity	How bouncy the object is when colliding (0-1)

Overrides: EngineObject#elasticity
Source: engineObject.js, line 73

friction

Properties

Name	Type	Attributes	Default	Description
`friction`	Number	<optional>	objectDefaultFriction	How much friction to apply when sliding (0-1)

Overrides: EngineObject#friction
Source: engineObject.js, line 75

gravityScale

Properties

Type	Description
Number	How much to scale gravity by for this object

Overrides: EngineObject#gravityScale
Source: engineObject.js, line 77

isOverlay

Properties

Type	Description
Boolean	If true this layer will render to overlay canvas and appear above all objects

Source: engineTileLayer.js, line 191

isSolid

Properties

Type	Description
Boolean	Object collides with and blocks other objects

Overrides: EngineObject#isSolid
Source: engineObject.js, line 105

localAngle

Properties

Type	Description
Number	Local angle if child

Overrides: EngineObject#localAngle
Source: engineObject.js, line 97

localPos

Properties

Type	Description
Vector2	Local position if child

Overrides: EngineObject#localPos
Source: engineObject.js, line 95

mass

Properties

Name	Type	Attributes	Default	Description
`mass`	Number	<optional>	objectDefaultMass	How heavy the object is, static if 0

Overrides: EngineObject#mass
Source: engineObject.js, line 67

mirror

Properties

Type	Description
Boolean	Should it flip along y axis when rendered

Overrides: EngineObject#mirror
Source: engineObject.js, line 63

parent

Properties

Type	Description
EngineObject	Parent of object if in local space

Overrides: EngineObject#parent
Source: engineObject.js, line 93

pos

Properties

Type	Description
Vector2	World space position of the object

Overrides: EngineObject#pos
Source: engineObject.js, line 49

renderOrder

Properties

Type	Description
Number	Objects are sorted by render order

Overrides: EngineObject#renderOrder
Source: engineObject.js, line 79

savedRenderSettings

Source: engineTileLayer.js, line 267

scale

Properties

Type	Description
Vector2	How much to scale this layer when rendered

Source: engineTileLayer.js, line 189

size

Properties

Type	Description
Vector2	World space width and height of the object

Overrides: EngineObject#size
Source: engineObject.js, line 51

spawnTime

Properties

Type	Description
Number	Track when object was created

Overrides: EngineObject#spawnTime
Source: engineObject.js, line 85

tileInfo

Properties

Type	Description
TileInfo	Tile info to render object (undefined is untextured)

Overrides: EngineObject#tileInfo
Source: engineObject.js, line 55

velocity

Properties

Type	Description
Vector2	Velocity of the object

Overrides: EngineObject#velocity
Source: engineObject.js, line 81

Methods

addChild(child, localPosopt, localAngleopt)

Attaches a child to this with a given local transform

Parameters:

Name	Type	Attributes	Default
`child`	EngineObject
`localPos`	Vector2	<optional>	(0,0)
`localAngle`	Number	<optional>	0

Overrides: EngineObject#addChild
Source: engineObject.js, line 387

applyAcceleration(acceleration)

Apply acceleration to this object (adjust velocity, not affected by mass)

Parameters:

Name	Type	Description
`acceleration`	Vector2

Overrides: EngineObject#applyAcceleration
Source: engineObject.js, line 373

applyForce(force)

Apply force to this object (adjust velocity, affected by mass)

Parameters:

Name	Type	Description
`force`	Vector2

Overrides: EngineObject#applyForce
Source: engineObject.js, line 377

collideWithObject(object) → {Boolean}

Called to check if a object collision should be resolved

Parameters:

Name	Type	Description
`object`	EngineObject	the object to test against

Overrides: EngineObject#collideWithObject
Source: engineObject.js, line 365

Returns:

true if the collision should be resolved

Type:: Boolean

collideWithTile(tileData, pos) → {Boolean}

Called to check if a tile collision should be resolved

Parameters:

Name	Type	Description
`tileData`	Number	the value of the tile at the position
`pos`	Vector2	tile where the collision occurred

Overrides: EngineObject#collideWithTile
Source: engineObject.js, line 359

Returns:

true if the collision should be resolved

Type:: Boolean

destroy()

Destroy this object, destroy it's children, detach it's parent, and mark it for removal

Overrides: EngineObject#destroy
Source: engineObject.js, line 327

drawCanvas2D(pos, size, angle, mirror, drawFunction)

Draw directly to the 2D canvas in world space (bypass webgl)

Parameters:

Name	Type	Description
`pos`	Vector2
`size`	Vector2
`angle`	Number
`mirror`	Boolean
`drawFunction`	function

Source: engineTileLayer.js, line 335

drawRect(pos, sizeopt, coloropt, angleopt)

Draw a rectangle directly onto the layer canvas in world space

Parameters:

Name	Type	Attributes	Default
`pos`	Vector2
`size`	Vector2	<optional>	(1,1)
`color`	Color	<optional>	(1,1,1,1)
`angle`	Number	<optional>	0

Source: engineTileLayer.js, line 382

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

Draw a tile directly onto the layer canvas in world space

Parameters:

Name	Type	Attributes	Default
`pos`	Vector2
`size`	Vector2	<optional>	(1,1)
`tileInfo`	TileInfo	<optional>
`color`	Color	<optional>	(1,1,1,1)
`angle`	Number	<optional>	0
`mirror`	Boolean	<optional>	0

Source: engineTileLayer.js, line 355

drawTileData(layerPos, clearopt)

Draw the tile at a given position in the tile grid 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: engineTileLayer.js, line 308

getAliveTime() → {Number}

How long since the object was created

Overrides: EngineObject#getAliveTime
Source: engineObject.js, line 369

Returns:

Type:: Number

getData(layerPos) → {TileLayerData}

Get data at a given position in the array

Parameters:

Name	Type	Description
`layerPos`	Vector2	Local position in array

Source: engineTileLayer.js, line 226

Returns:

Type:: TileLayerData

getMirrorSign() → {Number}

Get the direction of the mirror

Overrides: EngineObject#getMirrorSign
Source: engineObject.js, line 381

Returns:

-1 if this.mirror is true, or 1 if not mirrored

Type:: Number

localToWorld(pos)

Convert from local space to world space

Parameters:

Name	Type	Description
`pos`	Vector2	local space point

Overrides: EngineObject#localToWorld
Source: engineObject.js, line 341

localToWorldVector(vec)

Convert from local space to world space for a vector (rotation only)

Parameters:

Name	Type	Description
`vec`	Vector2	local space vector

Overrides: EngineObject#localToWorldVector
Source: engineObject.js, line 349

redraw()

Draw all the tile data to an offscreen canvas

This may be slow in some browsers but only needs to be done once

Source: engineTileLayer.js, line 251

redrawEnd()

Call to end the redraw process

Source: engineTileLayer.js, line 292

redrawStart(clearopt)

Call to start the redraw process

This can be used to manually update small parts of the level

Parameters:

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

Source: engineTileLayer.js, line 263

removeChild(child)

Removes a child from this one

Parameters:

Name	Type	Description
`child`	EngineObject

Overrides: EngineObject#removeChild
Source: engineObject.js, line 398

render()

Render the object, draws a tile by default, automatically called each frame, sorted by renderOrder

Overrides: EngineObject#render
Source: engineObject.js, line 320

renderDebugInfo()

Render debug info for this object

Overrides: EngineObject#renderDebugInfo
Source: engineObject.js, line 442

setCollision(collideSolidObjectsopt, isSolidopt, collideTilesopt, collideRaycastopt)

Set how this object collides

Parameters:

Name	Type	Attributes	Default	Description
`collideSolidObjects`	Boolean	<optional>	true	Does it collide with solid objects?
`isSolid`	Boolean	<optional>	true	Does it collide with and block other objects? (expensive in large numbers)
`collideTiles`	Boolean	<optional>	true	Does it collide with the tile collision?
`collideRaycast`	Boolean	<optional>	true	Does it collide with raycasts?