Made fromScene optional

phaserjs · May 26, 2021 · 55b69e5 · 55b69e5
1 parent 99db692
commit 55b69e5
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 6 deletions.
diff --git a/src/gameobjects/GameObject.js b/src/gameobjects/GameObject.js
@@ -821,8 +821,8 @@ 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.
+     *
+     * @param {boolean} [fromScene=false] - `True` if this Game Object is being destroyed by the Scene, `false` if not.
      */
     destroy: function (fromScene)
     {

diff --git a/src/gameobjects/events/DESTROY_EVENT.js b/src/gameobjects/events/DESTROY_EVENT.js
@@ -6,15 +6,15 @@
 
 /**
  * The Game Object Destroy Event.
- * 
+ *
  * This event is dispatched when a Game Object instance is being destroyed.
- * 
+ *
  * Listen for it on a Game Object instance using `GameObject.on('destroy', listener)`.
  *
  * @event Phaser.GameObjects.Events#DESTROY
  * @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.
+ * @param {boolean} fromScene - `True` if this Game Object is being destroyed by the Scene, `false` if not.
  */
 module.exports = 'destroy';