Removed debug call and merged Scene Systems boot and start sequences. Fix phaserjs#3579

Author: photonstorm

CHANGELOG.md

@@ -1,5 +1,16 @@
 # Change Log
 
+## Version 3.5.1 - Kirito - in development
+
+### Updates
+
+* The change made in 3.5.0 with how the Scene systems lifecycle is handled has been tweaked. When a Scene is instantiated it will now emit a boot event, as before, and Systems that need it will listen for this event and set-up their internal properties as required. They'll also do the same under the 'start' event, allowing them to restart properly once shutdown. In 3.5 if a Scene was previously not launched or started you wouldn't be able to access all of its internal systems fully, but in 3.5.1 you can.
+
+### Bug Fixes
+
+* LoaderPlugin.destroy would try and remove an incorrect event listener.
+
+
 ## Version 3.5.0 - Kirito - 16th April 2018
 
 ### Changes to Cameras

package.json

@@ -1,6 +1,6 @@
 {
   "name": "phaser",
-  "version": "3.5.0",
+  "version": "3.5.1",
   "release": "Kirito",
   "description": "A fast, free and fun HTML5 Game Framework for Desktop and Mobile web browsers.",
   "author": "Richard Davey <rich@photonstorm.com> (http://www.photonstorm.com)",

src/cameras/2d/CameraManager.js

@@ -113,19 +113,19 @@ var CameraManager = new Class({
          */
         this.baseScale = 1;
 
+        scene.sys.events.once('boot', this.boot, this);
         scene.sys.events.on('start', this.start, this);
     },
 
     /**
-     * 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.
+     * This method is called automatically, only once, when the Scene is first created.
      * Do not invoke it directly.
      *
-     * @method Phaser.Cameras.Scene2D.CameraManager#start
+     * @method Phaser.Cameras.Scene2D.CameraManager#boot
      * @private
-     * @since 3.5.0
+     * @since 3.5.1
      */
-    start: function ()
+    boot: function ()
     {
         var sys = this.systems;
 
@@ -141,8 +141,25 @@ var CameraManager = new Class({
         }
 
         this.main = this.cameras[0];
+    },
 
-        var eventEmitter = sys.events;
+    /**
+     * 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#start
+     * @private
+     * @since 3.5.0
+     */
+    start: function ()
+    {
+        if (!this.main)
+        {
+            this.boot();
+        }
+
+        var eventEmitter = this.systems.events;
 
         eventEmitter.on('update', this.update, this);
         eventEmitter.once('shutdown', this.shutdown, this);

src/const.js

@@ -20,7 +20,7 @@ var CONST = {
      * @type {string}
      * @since 3.0.0
      */
-    VERSION: '3.5.0-beta',
+    VERSION: '3.5.1',
 
     BlendModes: require('./renderer/BlendModes'),
 

src/data/DataManagerPlugin.js

@@ -50,9 +50,23 @@ var DataManagerPlugin = new Class({
          */
         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;
+    },
+
     /**
      * 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.

src/gameobjects/GameObjectCreator.js

@@ -69,9 +69,24 @@ var GameObjectCreator = new Class({
          */
         this.updateList;
 
+        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.GameObjects.GameObjectCreator#boot
+     * @private
+     * @since 3.5.1
+     */
+    boot: function ()
+    {
+        this.displayList = this.systems.displayList;
+        this.updateList = this.systems.updateList;
+    },
+
     /**
      * 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.
@@ -83,9 +98,6 @@ var GameObjectCreator = new Class({
      */
     start: function ()
     {
-        this.displayList = this.systems.displayList;
-        this.updateList = this.systems.updateList;
-
         var eventEmitter = this.systems.events;
 
         eventEmitter.once('shutdown', this.shutdown, this);

src/gameobjects/GameObjectFactory.js

@@ -68,9 +68,24 @@ var GameObjectFactory = new Class({
          */
         this.updateList;
 
+        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.GameObjects.GameObjectFactory#boot
+     * @private
+     * @since 3.5.1
+     */
+    boot: function ()
+    {
+        this.displayList = this.systems.displayList;
+        this.updateList = this.systems.updateList;
+    },
+
     /**
      * 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.
@@ -82,9 +97,6 @@ var GameObjectFactory = new Class({
      */
     start: function ()
     {
-        this.displayList = this.systems.displayList;
-        this.updateList = this.systems.updateList;
-
         var eventEmitter = this.systems.events;
 
         eventEmitter.once('shutdown', this.shutdown, this);

src/input/InputPlugin.js

@@ -283,9 +283,25 @@ var InputPlugin = new Class({
          */
         this._validTypes = [ 'onDown', 'onUp', 'onOver', 'onOut', 'onMove', 'onDragStart', 'onDrag', 'onDragEnd', 'onDragEnter', 'onDragLeave', 'onDragOver', 'onDrop' ];
 
+        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.Input.InputPlugin#boot
+     * @private
+     * @since 3.5.1
+     */
+    boot: function ()
+    {
+        this.cameras = this.systems.cameras;
+
+        this.displayList = this.systems.displayList;
+    },
+
     /**
      * 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.
@@ -309,10 +325,6 @@ var InputPlugin = new Class({
         eventEmitter.once('destroy', this.destroy, this);
 
         this.enabled = true;
-
-        this.cameras = this.systems.cameras;
-
-        this.displayList = this.systems.displayList;
     },
 
     /**

src/loader/LoaderPlugin.js

@@ -241,19 +241,19 @@ var LoaderPlugin = new Class({
          */
         this.state = CONST.LOADER_IDLE;
 
-        scene.sys.events.on('start', this.boot, this);
+        scene.sys.events.on('start', this.pluginStart, this);
     },
 
     /**
      * 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.Loader.LoaderPlugin#boot
+     * @method Phaser.Loader.LoaderPlugin#pluginStart
      * @private
-     * @since 3.0.0
+     * @since 3.5.1
      */
-    boot: function ()
+    pluginStart: function ()
     {
         var eventEmitter = this.systems.events;
 
@@ -1008,7 +1008,7 @@ var LoaderPlugin = new Class({
 
         this.state = CONST.LOADER_DESTROYED;
 
-        this.scene.sys.events.off('start', this.start, this);
+        this.systems.events.off('start', this.pluginStart, this);
 
         this.list = null;
         this.inflight = null;

src/physics/arcade/ArcadePhysics.js

@@ -78,9 +78,24 @@ var ArcadePhysics = new Class({
          */
         this.add;
 
+        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.Physics.Arcade.ArcadePhysics#boot
+     * @private
+     * @since 3.5.1
+     */
+    boot: function ()
+    {
+        this.world = new World(this.scene, this.config);
+        this.add = new Factory(this.world);
+    },
+
     /**
      * 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.
@@ -92,8 +107,11 @@ var ArcadePhysics = new Class({
      */
     start: function ()
     {
-        this.world = new World(this.scene, this.config);
-        this.add = new Factory(this.world);
+        if (!this.world)
+        {
+            this.world = new World(this.scene, this.config);
+            this.add = new Factory(this.world);
+        }
 
         var eventEmitter = this.systems.events;
 
@@ -454,7 +472,11 @@ var ArcadePhysics = new Class({
         eventEmitter.off('postupdate', this.world.postUpdate, this.world);
         eventEmitter.off('shutdown', this.shutdown, this);
 
-        this.world.shutdown();
+        this.add.destroy();
+        this.world.destroy();
+
+        this.add = null;
+        this.world = null;
     },
 
     /**
@@ -468,15 +490,10 @@ var ArcadePhysics = new Class({
     {
         this.shutdown();
 
-        this.add.destroy();
-        this.world.destroy();
-
         this.scene.sys.events.off('start', this.start, this);
 
         this.scene = null;
         this.systems = null;
-        this.world = null;
-        this.add = null;
     }
 
 });