UpdateList now extends ProcessQueue and uses all of its methods instead.

Author: photonstorm

src/gameobjects/UpdateList.js

@@ -5,6 +5,7 @@
  */
 
 var Class = require('../utils/Class');
+var ProcessQueue = require('../structs/ProcessQueue');
 var PluginCache = require('../plugins/PluginCache');
 var SceneEvents = require('../scene/events');
 
@@ -17,6 +18,7 @@ var SceneEvents = require('../scene/events');
  * Some or all of these Game Objects may also be part of the Scene's [Display List]{@link Phaser.GameObjects.DisplayList}, for Rendering.
  *
  * @class UpdateList
+ * @extends Phaser.Structs.ProcessQueue
  * @memberof Phaser.GameObjects
  * @constructor
  * @since 3.0.0
@@ -25,10 +27,14 @@ var SceneEvents = require('../scene/events');
  */
 var UpdateList = new Class({
 
+    Extends: ProcessQueue,
+
     initialize:
 
     function UpdateList (scene)
     {
+        ProcessQueue.call(this);
+
         /**
          * The Scene that the Update List belongs to.
          *
@@ -47,38 +53,8 @@ var UpdateList = new Class({
          */
         this.systems = scene.sys;
 
-        /**
-         * The list of Game Objects.
-         *
-         * @name Phaser.GameObjects.UpdateList#_list
-         * @type {array}
-         * @private
-         * @default []
-         * @since 3.0.0
-         */
-        this._list = [];
-
-        /**
-         * Game Objects that are pending insertion into the list.
-         *
-         * @name Phaser.GameObjects.UpdateList#_pendingInsertion
-         * @type {array}
-         * @private
-         * @default []
-         * @since 3.0.0
-         */
-        this._pendingInsertion = [];
-
-        /**
-         * Game Objects that are pending removal from the list.
-         *
-         * @name Phaser.GameObjects.UpdateList#_pendingRemoval
-         * @type {array}
-         * @private
-         * @default []
-         * @since 3.0.0
-         */
-        this._pendingRemoval = [];
+        // this._addEvent = 'add';
+        // this.removeEvent = 'remove';
 
         scene.sys.events.once(SceneEvents.BOOT, this.boot, this);
         scene.sys.events.on(SceneEvents.START, this.start, this);
@@ -110,90 +86,25 @@ var UpdateList = new Class({
     {
         var eventEmitter = this.systems.events;
 
-        eventEmitter.on(SceneEvents.PRE_UPDATE, this.preUpdate, this);
-        eventEmitter.on(SceneEvents.UPDATE, this.update, this);
+        eventEmitter.on(SceneEvents.PRE_UPDATE, this.update, this);
+        eventEmitter.on(SceneEvents.UPDATE, this.sceneUpdate, this);
         eventEmitter.once(SceneEvents.SHUTDOWN, this.shutdown, this);
     },
 
-    /**
-     * Add a Game Object to the Update List.
-     *
-     * @method Phaser.GameObjects.UpdateList#add
-     * @since 3.0.0
-     *
-     * @param {Phaser.GameObjects.GameObject} child - The Game Object to add.
-     *
-     * @return {Phaser.GameObjects.GameObject} The added Game Object.
-     */
-    add: function (child)
-    {
-        //  Is child already in this list?
-
-        if (this._list.indexOf(child) === -1 && this._pendingInsertion.indexOf(child) === -1)
-        {
-            this._pendingInsertion.push(child);
-        }
-
-        return child;
-    },
-
-    /**
-     * The pre-update step.
-     *
-     * Handles Game Objects that are pending insertion to and removal from the list.
-     *
-     * @method Phaser.GameObjects.UpdateList#preUpdate
-     * @since 3.0.0
-     */
-    preUpdate: function ()
-    {
-        var toRemove = this._pendingRemoval.length;
-        var toInsert = this._pendingInsertion.length;
-
-        if (toRemove === 0 && toInsert === 0)
-        {
-            //  Quick bail
-            return;
-        }
-
-        var i;
-        var gameObject;
-
-        //  Delete old gameObjects
-        for (i = 0; i < toRemove; i++)
-        {
-            gameObject = this._pendingRemoval[i];
-
-            var index = this._list.indexOf(gameObject);
-
-            if (index > -1)
-            {
-                this._list.splice(index, 1);
-            }
-        }
-
-        //  Move pending to active
-        this._list = this._list.concat(this._pendingInsertion.splice(0));
-
-        //  Clear the lists
-        this._pendingRemoval.length = 0;
-        this._pendingInsertion.length = 0;
-    },
-
     /**
      * The update step.
      *
      * Pre-updates every active Game Object in the list.
      *
-     * @method Phaser.GameObjects.UpdateList#update
-     * @since 3.0.0
+     * @method Phaser.GameObjects.UpdateList#sceneUpdate
+     * @since 3.20.0
      *
      * @param {number} time - The current timestamp.
      * @param {number} delta - The delta time elapsed since the last frame.
      */
-    update: function (time, delta)
+    sceneUpdate: function (time, delta)
     {
-        var list = this._list;
+        var list = this._active;
         var length = list.length;
 
         for (var i = 0; i < length; i++)
@@ -207,79 +118,42 @@ var UpdateList = new Class({
         }
     },
 
-    /**
-     * Remove a Game Object from the list.
-     *
-     * @method Phaser.GameObjects.UpdateList#remove
-     * @since 3.0.0
-     *
-     * @param {Phaser.GameObjects.GameObject} child - The Game Object to remove from the list.
-     *
-     * @return {Phaser.GameObjects.GameObject} The removed Game Object.
-     */
-    remove: function (child)
-    {
-        if (this._list.indexOf(child) !== -1 && this._pendingRemoval.indexOf(child) === -1)
-        {
-            this._pendingRemoval.push(child);
-        }
-
-        return child;
-    },
-
-    /**
-     * Remove all Game Objects from the list.
-     *
-     * @method Phaser.GameObjects.UpdateList#removeAll
-     * @since 3.0.0
-     *
-     * @return {Phaser.GameObjects.UpdateList} This UpdateList.
-     */
-    removeAll: function ()
-    {
-        var i = this._list.length;
-
-        while (i--)
-        {
-            this.remove(this._list[i]);
-        }
-
-        return this;
-    },
-
     /**
      * 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.GameObjects.UpdateList#shutdown
      * @since 3.0.0
      */
     shutdown: function ()
     {
-        var i = this._list.length;
+        var i = this._active.length;
 
         while (i--)
         {
-            this._list[i].destroy(true);
+            this._active[i].destroy(true);
         }
 
-        i = this._pendingRemoval.length;
+        i = this._pending.length;
 
         while (i--)
         {
-            this._pendingRemoval[i].destroy(true);
+            this._pending[i].destroy(true);
         }
 
-        i = this._pendingInsertion.length;
+        i = this._destroy.length;
 
         while (i--)
         {
-            this._pendingInsertion[i].destroy(true);
+            this._destroy[i].destroy(true);
         }
 
-        this._list.length = 0;
-        this._pendingRemoval.length = 0;
-        this._pendingInsertion.length = 0;
+        this._toProcess = 0;
+
+        this._pending = [];
+        this._active = [];
+        this._destroy = [];
 
         var eventEmitter = this.systems.events;
 
@@ -290,6 +164,7 @@ var UpdateList = new Class({
 
     /**
      * The Scene that owns this plugin is being destroyed.
+     * 
      * We need to shutdown and then kill off all external references.
      *
      * @method Phaser.GameObjects.UpdateList#destroy
@@ -303,23 +178,6 @@ var UpdateList = new Class({
 
         this.scene = null;
         this.systems = null;
-    },
-
-    /**
-     * The length of the list.
-     *
-     * @name Phaser.GameObjects.UpdateList#length
-     * @type {integer}
-     * @readonly
-     * @since 3.10.0
-     */
-    length: {
-
-        get: function ()
-        {
-            return this._list.length;
-        }
-
     }
 
 });