Data manager

Introduction¶

Sync data from data manager to local-storage.

Author: Rex
Member of scene

Max Size

5MB per app per browser.

Live demos¶

Usage¶

Sample code

Install plugin¶

Load minify file¶

Load plugin (minify file) in preload stage

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

Extend existed data object (game.registry, or scene.data)

var data = scene.plugins.get('rexlocalstoragedataplugin').extend(game.registry, config);
// var data = scene.plugins.get('rexlocalstoragedataplugin').extend(scene.data, config);

New local storage data manager

var data = scene.plugins.get('rexlocalstoragedataplugin').add(parent, config);

Import plugin¶

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

Install plugin in configuration of game

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

Extend existed data object (game.registry, or scene.data)

var data = scene.plugins.get('rexLocalStorageData').extend(game.registry, config);
// var data = scene.plugins.get('rexLocalStorageData').extend(scene.data, config);

New local storage data manager

var data = scene.plugins.get('rexLocalStorageData').add(parent, config);

Import class¶

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

Import class

import LocalStorageData from 'phaser3-rex-plugins/plugins/localstoragedata.js';

New local storage data manager

var data = new LocalStorageData(parent, config);

Create instance¶

var data = scene.plugins.get('rexLocalStorageData').add({
    // name: '',
    // load: true,
    // default: undefined,
    // reset: false
});
// var data = scene.plugins.get('rexLocalStorageData').add(parent, config);
// var data = scene.plugins.get('rexRData').add(parent, eventEmitter, config);

name : Prefix of key in local storage.
load :
- true : Load data from local storage. Default behavior.
- false : Don't load data now.
default : Define valid keys and default values of loaded data.
- undefined : Load all keys from local storage.
reset :
- true : Reset all data to default values (default), clear keys which are not in defaultData.
parent : The object (a scene, or a game object) that this DataManager belongs to.
eventEmitter : The DataManager's event emitter.

Load¶

data.load(defaultData);
// data.load(defaultData, reset);

defaultData : Define valid keys and default values of loaded data.
- undefined : Load all keys from local storage. reset will be false in this case.
reset :
- true : Reset all data to default values (defaultData), clear keys which are not in defaultData.

Note

Data loaded from local storage already, if load is true.

Get/set/remove value¶

See built-in data manager.

Reserved keys¶

'__keys__' is used internally by this plugin.

Get default value¶

var value = data.getDefaultValue(key);