import {Layer} from 'parallax/src/layer.mjs'

public class | source

Layer

Constructor Summary

Public Constructor
public	constructor()

Private Members
private	config(horizontalSpeed: number, verticalSpeed: number, plane: number, backgrounds: Diob[] \| MapObject[], instances: Set): Object The configuration object of this layer.

Public Methods
public	add(pInstance: Diob, pConfig: Object) Adds the instance to the parallax layer.
public	remove(pInstance: Diob) Removes the instance from the parallax layer.
public	updateConfigSpeed(pConfig: Object, pUpdateLayerConfigOnly: boolean) Updates the configuration speed of the layer.
public	updateHorizontalSpeed(pHorizontalSpeed: number, pUpdateLayerConfigOnly: boolean) Updates the horizontal speed of this layer.
public	updateVerticalSpeed(pVerticalSpeed: number, pUpdateLayerConfigOnly: boolean) Updates the vertical speed of the layer.

The configuration object of this layer.

Adds the instance to the parallax layer. When using this API the instance should already be on the map.

Name	Type	Attribute	Description
pInstance	Diob		The instance to add to the layer.
pConfig	Object		The personal config of this instance. Akin to the parallax info passed via the `Parallax.add` API.

Removes the instance from the parallax layer.

Name	Type	Attribute	Description
pInstance	Diob		The instance to remove from the layer.

Updates the configuration speed of the layer.

Name	Type	Attribute	Description
pConfig	Object		The speed configuration of the parallax layer.
pUpdateLayerConfigOnly	boolean		If only to update the layer config and not the instance config.

Updates the horizontal speed of this layer.

Name	Type	Attribute	Description
pHorizontalSpeed	number		The new horizontal speed.
pUpdateLayerConfigOnly	boolean		If only to update the layer config and not the instance config.

Updates the vertical speed of the layer.

Name	Type	Attribute	Description
pVerticalSpeed	number		The new vertical speed.
pUpdateLayerConfigOnly	boolean		If only to update the layer config and not the instance config.