Options
All
  • Public
  • Public/Protected
  • All
Menu

An abstract pattern for primary layers of the game canvas to implement.

abstract
interface

Hierarchy

Index

Constructors

  • Returns CanvasLayer

Properties

options: { name: string } = ...

Options for this layer instance.

Type declaration

  • name: string
interactiveChildren: boolean = false
renderable: boolean

Accessors

  • get name(): string
  • The canonical name of the CanvasLayer

    Returns string

  • get layerOptions(): { name: string }
  • Customize behaviors of this CanvasLayer by modifying some behaviors at a class level.

    Returns { name: string }

    • name: string
  • Return a reference to the active instance of this canvas layer

    Returns CanvasLayer

Methods

  • Draw the canvas layer, rendering its internal components and returning a Promise. The Promise resolves to the drawn layer once its contents are successfully rendered.

    Parameters

    • options: any = {}

    Returns Promise<CanvasLayer>

  • Deconstruct data used in the current layer in preparation to re-draw the canvas

    Parameters

    • options: any = {}

    Returns Promise<CanvasLayer>

  • _draw(options: any): Promise<void>
  • The inner _draw method which must be defined by each CanvasLayer subclass.

    abstract

    Parameters

    • options: any

    Returns Promise<void>

  • _tearDown(options: any): Promise<void>
  • The inner _tearDown method which may be customized by each CanvasLayer subclass.

    Parameters

    • options: any

    Returns Promise<void>