Layer manager

Introduction¶

A dictionary to store Layer game objects.

Author: Rex
Container of game objects

Usage¶

Install plugin¶

Load minify file¶

Load plugin (minify file) in preload stage

scene.load.plugin('rexlayermanagerplugin', 'https://raw.githubusercontent.com/rexrainbow/phaser3-rex-notes/master/dist/rexlayermanagerplugin.min.js', true);

Add layer manager

var layerManager = scene.plugins.get('rexlayermanagerplugin').add(scene, config);

Import plugin¶

Install rex plugins from npm
```
npm i phaser3-rex-plugins
```

Install plugin in configuration of game

import LayerManagerPlugin from 'phaser3-rex-plugins/plugins/layermanager-plugin.js';
var config = {
    // ...
    plugins: {
        global: [{
            key: 'rexLayerManager',
            plugin: LayerManagerPlugin,
            start: true
        },
        // ...
        ]
    }
    // ...
};
var game = new Phaser.Game(config);

Add layer manager

var layerManager = scene.plugins.get('rexLayerManager').add(scene, config);

Import class¶

Install rex plugins from npm
```
npm i phaser3-rex-plugins
```

Import class

import LayerManager from 'phaser3-rex-plugins/plugins/layermanager.js';

Add move-to behavior

var layerManager = new LayerManager(scene, config);

Create instance¶

var layerManager = scene.plugins.get('rexLayerManager').add(scene, {
    // layers: ['layer0', 'layer1', ...]
    // depth: undefined,
    // rootLayer: undefined,
});

or

var layerManager = scene.plugins.get('rexLayerManager').add(scene, 
    ['layer0', 'layer1', ...]
);

layers : Add layers by name string array.
depth : Set depth to each layer game object.
- undefined : Keep default depth value (0)
rootLayer : Add all layer game objects created by this layer-manager into this root layer.

Destroy¶

layerManager.destroy()

Also destroy all layers in this layer manager.

Add layer¶

layerManager.add(name);
// layerManager.add(name, depth);

Add game object to layer¶

layerManager.addToLayer(name, gameObject);

name : Name of layer
gameObject : Any kind of game object, include containerLite and related game objects.

Note

Print a warn message if specific layer is not existed.

Get layer¶

Get layer by name

var layer = layerManager.getLayer(name);

Get all layers in this layer manager

var layers = layerManager.getLayers();
// var out = layerManager.getLayers(out);

Has layer¶

var hasLayer = layerManager.has(name);
// var hasLayer = layerManager.exists(name);

Clear layer¶

Destroy all children at layer
```
layerManager.clearLayer(name);
```
Move all children from layer to scene's display list
```
layerManager.clearLayer(name, false);
```

Change depth¶

Bring a layer (layerName) to top of displayList
```
layerManager.bringLayerToTop(layerName);
```
Send a layer (layerName) to bottom of displayList
```
layerManager.sendLayerToBack(layerName);
```
Move a layer (layerName) above another layer (baseLayerName)
```
layerManager.moveLayerAbove(layerName, baseLayerName)
```
Move a layer (layerName) below another layer (baseLayerName)
```
layerManager.moveLayerBelow(layerName, baseLayerName)
```