Refactored the game over and out handling to work with the non-legacy input system. Fix phaserjs#4344

Author: photonstorm

CHANGELOG.md

@@ -36,7 +36,7 @@ The following changes all effect the Matter JS Pointer Constraint class:
 * The `Mesh.setAlpha` method has been restored, even though it's empty and does nothing, to prevent runtime errors when adding a Mesh or Quad object to a Container. Fix #4338 #4343 (thanks @pfdtravalmatic @charmingny)
 * `KeyboardPlugin.checkDown` would always fail if using the new event system, because the time value it was checking wasn't updated.
 * Entering Fullscreen mode in the Scale Manager and then pressing ESC would leave the injected fullsceen div in the DOM, causing it to fail with a node insertion failure the second time you wanted to enter fullscreen mode. Fix #4352 (thanks @ngdevr)
-
+* Due to the changes in the Input event system, the `GAME_OUT` event would never fire unless the input system was in legacy mode. The OUT and OVER handlers have been refactored and will now fire as soon as the DOM event happens. As a result the `InputManager._emitIsOverEvent` property has been removed, as the native event is sent directly to the handler and doesn't need storing locally any more. Fix #4344 (thanks @RademCZ)
 
 ### Examples, Documentation and TypeScript
 

src/input/InputManager.js

@@ -135,16 +135,6 @@ var InputManager = new Class({
          */
         this.isOver = true;
 
-        /**
-         * The DOM Event that was fired when the canvas dispatched an over or out event.
-         *
-         * @name Phaser.Input.InputManager#_emitIsOverEvent
-         * @type {(MouseEvent|TouchEvent)}
-         * @private
-         * @since 3.16.0
-         */
-        this._emitIsOverEvent = false;
-
         /**
          * Are there any up callbacks defined?
          *
@@ -456,6 +446,7 @@ var InputManager = new Class({
      * Internal canvas state change, called automatically by the Mouse Manager.
      *
      * @method Phaser.Input.InputManager#setCanvasOver
+     * @fires Phaser.Input.Events#GAME_OVER
      * @private
      * @since 3.16.0
      *
@@ -465,13 +456,14 @@ var InputManager = new Class({
     {
         this.isOver = true;
 
-        this._emitIsOverEvent = event;
+        this.events.emit(Events.GAME_OVER, event);
     },
 
     /**
      * Internal canvas state change, called automatically by the Mouse Manager.
      *
      * @method Phaser.Input.InputManager#setCanvasOut
+     * @fires Phaser.Input.Events#GAME_OUT
      * @private
      * @since 3.16.0
      *
@@ -481,7 +473,7 @@ var InputManager = new Class({
     {
         this.isOver = false;
 
-        this._emitIsOverEvent = event;
+        this.events.emit(Events.GAME_OUT, event);
     },
 
     /**
@@ -647,9 +639,6 @@ var InputManager = new Class({
             this.canvas.style.cursor = this.defaultCursor;
         }
 
-        //  Reset the isOver event
-        this._emitIsOverEvent = null;
-
         this.dirty = false;
 
         this._updatedThisFrame = false;

src/input/InputPlugin.js

@@ -407,6 +407,9 @@ var InputPlugin = new Class({
 
         eventEmitter.once(SceneEvents.SHUTDOWN, this.shutdown, this);
 
+        this.manager.events.on(Events.GAME_OUT, this.onGameOut, this);
+        this.manager.events.on(Events.GAME_OVER, this.onGameOver, this);
+
         this.enabled = true;
 
         //  Populate the pointer drag states
@@ -416,6 +419,38 @@ var InputPlugin = new Class({
         this.pluginEvents.emit(Events.START);
     },
 
+    /**
+     * Game Over handler.
+     *
+     * @method Phaser.Input.InputPlugin#onGameOver
+     * @fires Phaser.Input.Events#GAME_OVER
+     * @private
+     * @since 3.16.2
+     */
+    onGameOver: function (event)
+    {
+        if (this.isActive())
+        {
+            this.emit(Events.GAME_OVER, event.timeStamp, event);
+        }
+    },
+
+    /**
+     * Game Out handler.
+     *
+     * @method Phaser.Input.InputPlugin#onGameOut
+     * @fires Phaser.Input.Events#GAME_OUT
+     * @private
+     * @since 3.16.2
+     */
+    onGameOut: function (event)
+    {
+        if (this.isActive())
+        {
+            this.emit(Events.GAME_OUT, event.timeStamp, event);
+        }
+    },
+
     /**
      * The pre-update handler is responsible for checking the pending removal and insertion lists and
      * deleting old Game Objects.
@@ -485,8 +520,6 @@ var InputPlugin = new Class({
      * Called automatically by the Scene Systems step.
      *
      * @method Phaser.Input.InputPlugin#update
-     * @fires Phaser.Input.Events#GAME_OUT
-     * @fires Phaser.Input.Events#GAME_OVER
      * @fires Phaser.Input.Events#UPDATE
      * @private
      * @since 3.0.0
@@ -511,13 +544,6 @@ var InputPlugin = new Class({
             return;
         }
 
-        if (manager._emitIsOverEvent)
-        {
-            var event = (manager.isOver) ? Events.GAME_OVER : Events.GAME_OUT;
-
-            this.emit(event, time, manager._emitIsOverEvent);
-        }
-
         var runUpdate = (manager.dirty || this.pollRate === 0);
 
         if (this.pollRate > -1)
@@ -2356,6 +2382,9 @@ var InputPlugin = new Class({
             eventEmitter.off(SceneEvents.UPDATE, this.update, this);
         }
 
+        this.manager.events.off(Events.GAME_OUT, this.onGameOut, this);
+        this.manager.events.off(Events.GAME_OVER, this.onGameOver, this);
+
         eventEmitter.off(SceneEvents.SHUTDOWN, this.shutdown, this);
     },