Class Layer

Classdesc

Layer class, used for creating layers in the scene. Layers are independent of each other, and can have their own physics engines, objects, etc. Like multiple scenes within a single scene, drawn on top of each other.

Example

 const background = new Layer({
     parallax: [0.75, .75]
 });
 background.addObject(...);
 const foreground = new Layer();
 foreground.addObject(...);
 foreground.addObject(...);
 
 const scene = new Scene({
     layers: [background, foreground]
 });

Constructors

constructor

Properties

Bodies Composite Engine bounds boundsActive engine id lastPhysicsUpdate objects parallax physics

Methods

activateBounds addObject disableBounds draw removeObject setBoundaries

Constructors

constructor

Properties

Bodies

Bodies: any

Matter.js Bodies

Composite

Composite: any

Matter.js Composite

Engine

Engine: any

Matter.js Engine

bounds

bounds: number[]

Bounds of the layer

boundsActive

boundsActive: boolean

Whether or not the bounds are active

engine

engine: any

Matter.js engine instance

id

id: String

Unique ID of the layer

lastPhysicsUpdate

lastPhysicsUpdate: number

Last time the physics were updated in the layer

objects

objects: GameObject[]

Objects in the layer

parallax

parallax: Vec2

How the layer processes camrea position. [1, 1] by default. [0, 0] would mean the layer is fixed to the camera, [1, 1] would mean the layer moves with the camera, [2, 2] would mean the layer moves at twice the speed of the camera, etc.

physics

physics: boolean

Whether or not the layer has physics enabled

Methods

activateBounds

  • activateBounds(): void

  • Activates the bounds of the layer

    Returns void

addObject

  • addObject(object, scene): void

  • Adds an object to the layer

    Parameters

    • object: GameObject

      The object to add to the layer

    • scene: Scene

      A reference to the parent scene

    Returns void

disableBounds

  • disableBounds(): void

  • Disables the bounds of the layer

    Returns void

draw

  • draw(options): void

  • Draws the layer onto the provided drawing context. This is handled automatically with scene and scene managers

    Parameters

    Returns void

removeObject

  • removeObject(object): void

  • Removes an object from the layer

    Parameters

    • object: GameObject

      The object to remove from the layer

    Returns void

setBoundaries

  • setBoundaries(rightBound, bottomBound, canvas, activate?): void

  • Sets the boundaries of a scene

    Parameters

    • rightBound: number

      How far to the right objects can go

    • bottomBound: number

      How far down objects can go

    • canvas: HTMLCanvasElement

      The canvas that the layer is drawn on

    • activate: boolean = true

      Whether or not to activate the bounds. True by default. If the scene has physics enabled, the bounds will be activated no matter what.

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc