Interface: CanvasLayersInterface

Defined in: src/canvas/interfaces/CanvasLayersInterface.ts:4

Properties

gameLayer

> readonly gameLayer: Container

Defined in: src/canvas/interfaces/CanvasLayersInterface.ts:8

The PIXI Container that contains all the canvas elements.

Methods

add()

> add(label, layer): Layer | undefined

Defined in: src/canvas/interfaces/CanvasLayersInterface.ts:20

Add a layer to the canvas.

Parameters

label

string

The label of the layer.

layer

Container

The layer to be added.

Returns

Layer | undefined

The layer.

Example

const uiLayer = new Container();
canvas.layers.add("ui", uiLayer);

get()

> get(label): Layer | null

Defined in: src/canvas/interfaces/CanvasLayersInterface.ts:30

Get a layer from the canvas.

Parameters

label

string

The label of the layer.

Returns

Layer | null

The layer.

Example

const uiLayer = canvas.layers.get("ui");

remove()

> remove(label): void

Defined in: src/canvas/interfaces/CanvasLayersInterface.ts:39

Remove a layer from the canvas.

Parameters

label

string

The label of the layer to be removed.

Returns

void

Example

canvas.layers.remove("ui");