phaser/src/data/DataManagerPlugin.js

131 lines
3.4 KiB
JavaScript
Raw Normal View History

2018-02-12 16:01:20 +00:00
/**
* @author Richard Davey <rich@photonstorm.com>
* @copyright 2018 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
var Class = require('../utils/Class');
var DataManager = require('./DataManager');
var PluginManager = require('../boot/PluginManager');
2018-02-12 22:16:18 +00:00
/**
* @classdesc
* The Data Component features a means to store pieces of data specific to a Game Object, System or Plugin.
* You can then search, query it, and retrieve the data. The parent must either extend EventEmitter,
* or have a property called `events` that is an instance of it.
*
* @class DataManagerPlugin
* @extends Phaser.Data.DataManager
* @memberOf Phaser.Data
* @constructor
* @since 3.0.0
*
* @param {Phaser.Scene} scene - [description]
*/
var DataManagerPlugin = new Class({
Extends: DataManager,
initialize:
function DataManagerPlugin (scene)
{
DataManager.call(this, scene, scene.sys.events);
2018-02-12 22:16:18 +00:00
/**
* [description]
*
* @name Phaser.Data.DataManagerPlugin#scene
* @type {Phaser.Scene}
* @since 3.0.0
*/
this.scene = scene;
2018-02-12 22:16:18 +00:00
/**
* [description]
*
* @name Phaser.Data.DataManagerPlugin#systems
* @type {Phaser.Scenes.Systems}
* @since 3.0.0
*/
this.systems = scene.sys;
scene.sys.events.once('boot', this.boot, this);
scene.sys.events.on('start', this.start, this);
},
/**
* This method is called automatically, only once, when the Scene is first created.
* Do not invoke it directly.
*
* @method Phaser.Data.DataManagerPlugin#boot
* @private
* @since 3.5.1
*/
boot: function ()
{
this.events = this.systems.events;
},
2018-02-12 22:16:18 +00:00
/**
* This method is called automatically by the Scene when it is starting up.
* It is responsible for creating local systems, properties and listening for Scene events.
* Do not invoke it directly.
2018-02-12 22:16:18 +00:00
*
* @method Phaser.Data.DataManagerPlugin#start
* @private
* @since 3.5.0
2018-02-12 22:16:18 +00:00
*/
start: function ()
{
if (this.events)
{
this.events.off('destroy', this.destroy, this);
}
this.events = this.systems.events;
var eventEmitter = this.systems.events;
eventEmitter.once('shutdown', this.shutdown, this);
eventEmitter.once('destroy', this.destroy, this);
},
2018-02-12 22:16:18 +00:00
/**
* The Scene that owns this plugin is shutting down.
* We need to kill and reset all internal properties as well as stop listening to Scene events.
2018-02-12 22:16:18 +00:00
*
* @method Phaser.Data.DataManagerPlugin#shutdown
* @private
* @since 3.5.0
2018-02-12 22:16:18 +00:00
*/
shutdown: function ()
{
var eventEmitter = this.systems.events;
eventEmitter.off('shutdown', this.shutdown, this);
},
2018-02-12 22:16:18 +00:00
/**
* The Scene that owns this plugin is being destroyed.
* We need to shutdown and then kill off all external references.
2018-02-12 22:16:18 +00:00
*
* @method Phaser.Data.DataManagerPlugin#destroy
* @since 3.5.0
2018-02-12 22:16:18 +00:00
*/
destroy: function ()
{
DataManager.prototype.destroy.call(this);
this.systems.events.off('start', this.start, this);
this.scene = null;
this.systems = null;
}
});
PluginManager.register('DataManagerPlugin', DataManagerPlugin, 'data');
module.exports = DataManagerPlugin;