public class | source

ParallaxSingleton

You can directly use an instance of this class. Parallax

Constructor Summary

Private Constructor
private	constructor()

Member Summary

Public Members
public	Layer: Layer The layer class.
public	version: * The version of the module.

Private Members
private	anchorXSet: boolean Whether the anchor x position is set.
private	anchorYSet: boolean Whether the anchor y position is set.
private	cameraAnchor: x: number \| null, y: number \| null The virtual position on the map where the layers look natural together.
private	instanceWeakMap: WeakMap Weakmap to store info on instances used in this module.
private	instances: Set An set of instances that use the parallax system.
private	lastCamPos: x: number \| null, y: number \| null The last position of the camera.
private	logger: Object The logger module this module uses to log errors / logs

Method Summary

Public Methods
public	getAnchorX(): number \| null Gets the anchor x position.
public	getAnchorY(): number \| null Gets the anchor y position.
public	getCamPos(): {x: number, y: number} Gets the camera position.
public	getCameraAnchor(): {x: number\|null, y: number\|null} Gets the anchor position.
public	hasLastCamPos(): boolean Whether the last camera position is set.
public	isAnchorXSet(): boolean Whether the anchor x position is set.
public	isAnchorYSet(): boolean Whether the anchor y position is set.
public	remove(pInstance: Object) Removes an instance to the parallax system.
public	resetAnchor() Resets the anchor position.
public	resetAnchorX() Resets the anchor x position.
public	resetAnchorY() Resets the anchor y position.
public	setCameraAnchor(pCameraAnchor: {x: number, y: number}) Sets the anchor position for the parallax system.
public	setCameraAnchorX(pXAnchor: number) Sets the anchor x position for the parallax system.
public	setCameraAnchorY(pYAnchor: number) Sets the anchor y position for the parallax system.
public	setLastCamPos(pX: number, pY: number) Sets the last camera position.
public	update(pCameraX: number, pCameraY: number) Updates the parallax system.

Private Methods
private	add(pInstance: Object, pParallaxConfig: Object) Adds an instance to the parallax system.
private	createLoopInstances(pInstance: Diob, pBypassEvent: boolean): Diob[] Creates two clones of the instance to loop infinitely.
private	handleOnRelocated(pInstance: Diob \| MapObject, pChildren: MapObject[]) Handles the onRelocated event for instances.
private	init(pInstance: Object, pParallaxConfig: Object) Initializes this instance.
private	toggleInfiniteHorizontal(pInstance: Diob, pBypassEvent: boolean) Enables infinite looping for the horizontal plane.
private	toggleInfinitePlanes(pInstance: Diob) Toggle infinite looping for both the horizontal and vertical planes.
private	toggleInfiniteVertical(pInstance: Diob, pBypassEvent: boolean) Enables infinite looping for the vertical plane.
private	updateInstance(pInstance: Diob, pCameraX: number, pCameraY: number, pAnchor: {x: number\|null, y: number\|null}) Updates the instance's position based on the camera's position.

Private Constructors

private constructor() source

Public Members

public Layer: Layer source

The layer class.

public version: * source

The version of the module.

Private Members

private anchorXSet: boolean source

Whether the anchor x position is set.

private anchorYSet: boolean source

Whether the anchor y position is set.

private cameraAnchor: x: number | null, y: number | null source

The virtual position on the map where the layers look natural together.

private instanceWeakMap: WeakMap source

Weakmap to store info on instances used in this module.

private instances: Set source

An set of instances that use the parallax system.

private lastCamPos: x: number | null, y: number | null source

The last position of the camera.

private logger: Object source

The logger module this module uses to log errors / logs

Public Methods

public getAnchorX(): number | null source

Gets the anchor x position.

Return:

number | null

The anchor x position.

public getAnchorY(): number | null source

Gets the anchor y position.

Return:

number | null

The anchor x position.

public getCamPos(): {x: number, y: number} source

Gets the camera position.

Return:

{x: number, y: number}

The camera position.

public getCameraAnchor(): {x: number|null, y: number|null} source

Gets the anchor position.

Return:

{x: number|null, y: number|null}

The anchor position.

public hasLastCamPos(): boolean source

Whether the last camera position is set.

Return:

boolean

Whether the last camera position is set.

public isAnchorXSet(): boolean source

Whether the anchor x position is set.

Return:

boolean

Whether the anchor x position is set.

public isAnchorYSet(): boolean source

Whether the anchor y position is set.

Return:

boolean

Whether the anchor y position is set.

public remove(pInstance: Object) source

Removes an instance to the parallax system.

Params:

Name	Type	Attribute	Description
pInstance	Object		The instance to remove to the parallax system.

public resetAnchor() source

Resets the anchor position.

public resetAnchorX() source

Resets the anchor x position.

public resetAnchorY() source

Resets the anchor y position.

public setCameraAnchor(pCameraAnchor: {x: number, y: number}) source

Sets the anchor position for the parallax system.

Params:

Name	Type	Attribute	Description
pCameraAnchor	{x: number, y: number}		The virtual position on the map where the layers look natural together.

public setCameraAnchorX(pXAnchor: number) source

Sets the anchor x position for the parallax system.

Params:

Name	Type	Attribute	Description
pXAnchor	number		The x position to set the anchor to.

public setCameraAnchorY(pYAnchor: number) source

Sets the anchor y position for the parallax system.

Params:

Name	Type	Attribute	Description
pYAnchor	number		The y position to set the anchor to.

public setLastCamPos(pX: number, pY: number) source

Sets the last camera position.

Params:

Name	Type	Attribute	Description
pX	number		The last x position of the camera.
pY	number		The last y position of the camera.

public update(pCameraX: number, pCameraY: number) source

Updates the parallax system.

Params:

Name	Type	Attribute	Description
pCameraX	number		The x position of the camera.
pCameraY	number		The y position of the camera.

Private Methods

private add(pInstance: Object, pParallaxConfig: Object) source

Adds an instance to the parallax system. Call this first and then add your instance to the map.

Params:

Name	Type	Attribute	Description
pInstance	Object		The instance to add to the parallax system.
pParallaxConfig	Object		The parallax info that tells this module how to control this instance.

private createLoopInstances(pInstance: Diob, pBypassEvent: boolean): Diob[] source

Creates two clones of the instance to loop infinitely.

Params:

Name	Type	Attribute	Description
pInstance	Diob		The instance to base the clones off of.
pBypassEvent	boolean		Whether to bypass the onRelocated event.

Return:

Diob[]

An array of the two clones.

private handleOnRelocated(pInstance: Diob | MapObject, pChildren: MapObject[]) source

Handles the onRelocated event for instances. Moves their children in relativity to their position.

Params:

Name	Type	Attribute	Description
pInstance	Diob \| MapObject		The instance to handle the event for.
pChildren	MapObject[]		An array of children belonging to the instance.

private init(pInstance: Object, pParallaxConfig: Object) source

Initializes this instance.

Params:

Name	Type	Attribute	Description
pInstance	Object		The instance to initialize.
pParallaxConfig	Object		The parallax info that tells this module how to control this instance.

private toggleInfiniteHorizontal(pInstance: Diob, pBypassEvent: boolean) source

Enables infinite looping for the horizontal plane.

Params:

Name	Type	Attribute	Description
pInstance	Diob		The instance to loop.
pBypassEvent	boolean		Whether to bypass the onRelocated event.

private toggleInfinitePlanes(pInstance: Diob) source

Toggle infinite looping for both the horizontal and vertical planes.

Params:

Name	Type	Attribute	Description
pInstance	Diob		The instance to loop.

private toggleInfiniteVertical(pInstance: Diob, pBypassEvent: boolean) source

Enables infinite looping for the vertical plane.

Params:

Name	Type	Attribute	Description
pInstance	Diob		The instance to loop.
pBypassEvent	boolean		Whether to bypass the onRelocated event.

private updateInstance(pInstance: Diob, pCameraX: number, pCameraY: number, pAnchor: {x: number|null, y: number|null}) source

Updates the instance's position based on the camera's position.

Params:

Name	Type	Attribute	Description
pInstance	Diob		The instance to update.
pCameraX	number		The x position of the camera.
pCameraY	number		The y position of the camera.
pAnchor	{x: number\|null, y: number\|null}	optional	The camera anchor position to use.