Scene plugin flow overhaul

Every Plugin has been updated to correctly follow the same flow through the Scene lifecycle. Instead of listening for the Scene 'boot' event, which is only dispatched once (when the Scene is first created), they will now listen for the Scene 'start' event, which occurs every time the Scene is started. All plugins now consistently follow the same Shutdown and Destroy patterns too, meaning they tidy-up after themselves on a shutdown, not just a destroy. Overall, this change means that there should be less issues when returning to previously closed Scenes, as the plugins will restart themselves properly.

Author: photonstorm

CHANGELOG.md

@@ -9,10 +9,14 @@
 * The Animation component didn't properly check for the animation state in its update, causing pause / resume to fail. Fix #3556 (thanks @Antriel @siolfyr)
 * The Scene Manager would never reach an `isBooted` state if you didn't add any Scenes into the Game Config. Fix #3553 (thanks @rgk)
 * Fixed issue in HTMLAudioSound where `mute` would get into a recursive loop.
+* Every RenderTexture would draw the same content due to a mis-use of the CanvasPool (this would also effect TileSprites). Fix #3555 (thanks @kuoruan)
 
 ### Updates
 
 * Removed the following properties from BaseSound as they are no longer required. Each class that extends BaseSound implements them directly as getters: `mute`, `loop`, `seek` and `volume`.
+* The Device.OS test to see if Phaser is running under node.js has been strengthened to support node-like environments like Vue (thanks @Chumper)
+* Every Plugin has been updated to correctly follow the same flow through the Scene lifecycle. Instead of listening for the Scene 'boot' event, which is only dispatched once (when the Scene is first created), they will now listen for the Scene 'start' event, which occurs every time the Scene is started. All plugins now consistently follow the same Shutdown and Destroy patterns too, meaning they tidy-up after themselves on a shutdown, not just a destroy. Overall, this change means that there should be less issues when returning to previously closed Scenes, as the plugins will restart themselves properly.
+* When shutting down a Scene all Game Objects that belong to the scene will now automatically destroy themselves. They would previously be removed from the display and update lists, but the objects themselves didn't self-destruct.
 
 ### Examples, Documentation and TypeScript
 

src/cameras/2d/CameraManager.js

@@ -66,11 +66,6 @@ var CameraManager = new Class({
          */
         this.systems = scene.sys;
 
-        if (!scene.sys.settings.isBooted)
-        {
-            scene.sys.events.once('boot', this.boot, this);
-        }
-
         /**
          * The current Camera ID.
          *
@@ -100,25 +95,14 @@ var CameraManager = new Class({
          */
         this.cameraPool = [];
 
-        if (scene.sys.settings.cameras)
-        {
-            //  We have cameras to create
-            this.fromJSON(scene.sys.settings.cameras);
-        }
-        else
-        {
-            //  Make one
-            this.add();
-        }
-
         /**
          * The default Camera in the Camera Manager.
          *
          * @name Phaser.Cameras.Scene2D.CameraManager#main
          * @type {Phaser.Cameras.Scene2D.Camera}
          * @since 3.0.0
          */
-        this.main = this.cameras[0];
+        this.main;
 
         /**
          * This scale affects all cameras. It's used by Scale Manager.
@@ -127,23 +111,42 @@ var CameraManager = new Class({
          * @type {number}
          * @since 3.0.0
          */
-        this.baseScale = 1.0;
+        this.baseScale = 1;
+
+        scene.sys.events.on('start', this.start, this);
     },
 
     /**
-     * Called when the Camera Manager boots.
-     * Starts the event listeners running.
+     * 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.
      *
-     * @method Phaser.Cameras.Scene2D.CameraManager#boot
-     * @since 3.0.0
+     * @method Phaser.Cameras.Scene2D.CameraManager#start
+     * @private
+     * @since 3.4.1
      */
-    boot: function ()
+    start: function ()
     {
-        var eventEmitter = this.systems.events;
+        var sys = this.systems;
+
+        if (sys.settings.cameras)
+        {
+            //  We have cameras to create
+            this.fromJSON(sys.settings.cameras);
+        }
+        else
+        {
+            //  Make one
+            this.add();
+        }
+
+        this.main = this.cameras[0];
+
+        var eventEmitter = sys.events;
 
         eventEmitter.on('update', this.update, this);
-        eventEmitter.on('shutdown', this.shutdown, this);
-        eventEmitter.on('destroy', this.destroy, this);
+        eventEmitter.once('shutdown', this.shutdown, this);
+        eventEmitter.once('destroy', this.destroy, this);
     },
 
     /**
@@ -444,23 +447,14 @@ var CameraManager = new Class({
     },
 
     /**
-     * [description]
+     * 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.
      *
      * @method Phaser.Cameras.Scene2D.CameraManager#shutdown
+     * @private
      * @since 3.0.0
      */
     shutdown: function ()
-    {
-        //  TODO
-    },
-
-    /**
-     * [description]
-     *
-     * @method Phaser.Cameras.Scene2D.CameraManager#destroy
-     * @since 3.0.0
-     */
-    destroy: function ()
     {
         this.main = undefined;
 
@@ -476,7 +470,29 @@ var CameraManager = new Class({
 
         this.cameras = [];
         this.cameraPool = [];
-        this.scene = undefined;
+
+        var eventEmitter = this.systems.events;
+
+        eventEmitter.off('update', this.update, this);
+        eventEmitter.off('shutdown', this.shutdown, this);
+    },
+
+    /**
+     * The Scene that owns this plugin is being destroyed.
+     * We need to shutdown and then kill off all external references.
+     *
+     * @method Phaser.Cameras.Scene2D.CameraManager#destroy
+     * @private
+     * @since 3.0.0
+     */
+    destroy: function ()
+    {
+        this.shutdown();
+
+        this.scene.sys.events.off('start', this.start, this);
+
+        this.scene = null;
+        this.systems = null;
     }
 
 });

src/cameras/sprite3d/CameraManager.js

@@ -53,25 +53,25 @@ var CameraManager = new Class({
          */
         this.cameras = [];
 
-        if (!scene.sys.settings.isBooted)
-        {
-            scene.sys.events.once('boot', this.boot, this);
-        }
+        scene.sys.events.on('start', this.start, this);
     },
 
     /**
-     * [description]
+     * 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.
      *
-     * @method Phaser.Cameras.Sprite3D.CameraManager#boot
-     * @since 3.0.0
+     * @method Phaser.Cameras.Sprite3D.CameraManager#start
+     * @private
+     * @since 3.4.1
      */
-    boot: function ()
+    start: function ()
     {
         var eventEmitter = this.systems.events;
 
         eventEmitter.on('update', this.update, this);
-        eventEmitter.on('shutdown', this.shutdown, this);
-        eventEmitter.on('destroy', this.destroy, this);
+        eventEmitter.once('shutdown', this.shutdown, this);
+        eventEmitter.once('destroy', this.destroy, this);
     },
 
     /**
@@ -222,24 +222,39 @@ var CameraManager = new Class({
     },
 
     /**
-     * [description]
+     * 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.
      *
      * @method Phaser.Cameras.Sprite3D.CameraManager#shutdown
+     * @private
      * @since 3.0.0
      */
     shutdown: function ()
     {
+        var eventEmitter = this.systems.events;
+
+        eventEmitter.off('update', this.update, this);
+        eventEmitter.off('shutdown', this.shutdown, this);
+
+        this.removeAll();
     },
 
     /**
-     * [description]
+     * The Scene that owns this plugin is being destroyed.
+     * We need to shutdown and then kill off all external references.
      *
      * @method Phaser.Cameras.Sprite3D.CameraManager#destroy
+     * @private
      * @since 3.0.0
      */
     destroy: function ()
     {
-        this.scene = undefined;
+        this.shutdown();
+
+        this.scene.sys.events.off('start', this.start, this);
+
+        this.scene = null;
+        this.systems = null;
     }
 
 });

src/data/DataManagerPlugin.js

@@ -30,6 +30,8 @@ var DataManagerPlugin = new Class({
 
     function DataManagerPlugin (scene)
     {
+        DataManager.call(this, this.scene, scene.sys.events);
+
         /**
          * [description]
          *
@@ -48,51 +50,58 @@ var DataManagerPlugin = new Class({
          */
         this.systems = scene.sys;
 
-        if (!scene.sys.settings.isBooted)
-        {
-            scene.sys.events.once('boot', this.boot, this);
-        }
-
-        DataManager.call(this, this.scene, scene.sys.events);
+        scene.sys.events.on('start', this.start, this);
     },
 
     /**
-     * [description]
+     * 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.
      *
-     * @method Phaser.Data.DataManagerPlugin#boot
-     * @since 3.0.0
+     * @method Phaser.Data.DataManagerPlugin#start
+     * @private
+     * @since 3.4.1
      */
-    boot: function ()
+    start: function ()
     {
+        this.events = this.scene.sys.events;
+
         var eventEmitter = this.systems.events;
 
-        eventEmitter.on('shutdown', this.shutdownPlugin, this);
-        eventEmitter.on('destroy', this.destroyPlugin, this);
+        eventEmitter.once('shutdown', this.shutdown, this);
+        eventEmitter.once('destroy', this.destroy, this);
     },
 
     /**
-     * [description]
+     * 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.
      *
-     * @method Phaser.Data.DataManagerPlugin#shutdownPlugin
-     * @since 3.0.0
+     * @method Phaser.Data.DataManagerPlugin#shutdown
+     * @private
+     * @since 3.4.1
      */
-    shutdownPlugin: function ()
+    shutdown: function ()
     {
-        //  Should we reset the events?
+        var eventEmitter = this.systems.events;
+
+        eventEmitter.off('shutdown', this.shutdown, this);
     },
 
     /**
-     * [description]
+     * The Scene that owns this plugin is being destroyed.
+     * We need to shutdown and then kill off all external references.
      *
-     * @method Phaser.Data.DataManagerPlugin#destroyPlugin
-     * @since 3.0.0
+     * @method Phaser.Data.DataManagerPlugin#destroy
+     * @since 3.4.1
      */
-    destroyPlugin: function ()
+    destroy: function ()
     {
-        this.destroy();
+        DataManager.prototype.destroy.call(this);
+
+        this.scene.sys.events.off('start', this.start, this);
 
-        this.scene = undefined;
-        this.systems = undefined;
+        this.scene = null;
+        this.systems = null;
     }
 
 });