Merge pull request #5717 from rexrainbow/destroy-from-scene

Add 'fromScene' parameter in GameObject.destroy() method, and DESTROY event
phaserjs · May 26, 2021 · 5552079 · 5552079
2 parents c8cc337 + 07ff5de
commit 5552079
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/src/gameobjects/GameObject.js b/src/gameobjects/GameObject.js
@@ -821,21 +821,25 @@ var GameObject = new Class({
      * @method Phaser.GameObjects.GameObject#destroy
      * @fires Phaser.GameObjects.Events#DESTROY
      * @since 3.0.0
+     * 
+     * @param {boolean} fromScene - True if this Game Object is destroyed from scene, false if not.
      */
-    destroy: function ()
+    destroy: function (fromScene)
     {
         //  This Game Object has already been destroyed
         if (!this.scene || this.ignoreDestroy)
         {
             return;
         }
 
+        if (fromScene === undefined) { fromScene = false; }
+
         if (this.preDestroy)
         {
             this.preDestroy.call(this);
         }
 
-        this.emit(Events.DESTROY, this);
+        this.emit(Events.DESTROY, this, fromScene);
 
         this.removeAllListeners();
 

diff --git a/src/gameobjects/events/DESTROY_EVENT.js b/src/gameobjects/events/DESTROY_EVENT.js
@@ -15,5 +15,6 @@
  * @since 3.0.0
  * 
  * @param {Phaser.GameObjects.GameObject} gameObject - The Game Object which is being destroyed.
+ * @param {boolean} fromScene - True if this Game Object is destroyed from scene, false if not.
  */
 module.exports = 'destroy';