Added enabled property

Author: photonstorm

CHANGELOG.md

@@ -5,6 +5,7 @@
 ### New Features
 
 * GameObject.ignoreDestroy allows you to control if a Game Object is destroyed or not. Setting the flag will tell it to ignore destroy requests from Groups, Containers and even the Scene itself. See the docs for more details.
+* The Scene Input Plugin has a new property `enabled` which allows you to enable or disable input processing on per Scene basis.
 
 ### Bug Fixes
 

src/input/InputPlugin.js

@@ -58,6 +58,15 @@ var InputPlugin = new Class({
          */
         this.systems = scene.sys;
 
+        /**
+         * [description]
+         *
+         * @name Phaser.Input.InputPlugin#settings
+         * @type {SettingsObject}
+         * @since 3.4.1
+         */
+        this.settings = scene.sys.settings;
+
         /**
          * [description]
          *
@@ -67,6 +76,16 @@ var InputPlugin = new Class({
          */
         this.manager = scene.sys.game.input;
 
+        /**
+         * [description]
+         *
+         * @name Phaser.Input.InputPlugin#enabled
+         * @type {boolean}
+         * @default true
+         * @since 3.4.1
+         */
+        this.enabled = true;
+
         /**
          * A reference to this.scene.sys.displayList (set in boot)
          *
@@ -280,11 +299,17 @@ var InputPlugin = new Class({
     {
         var eventEmitter = this.systems.events;
 
+        eventEmitter.on('transitionstart', this.transitionIn, this);
+        eventEmitter.on('transitionout', this.transitionOut, this);
+        eventEmitter.on('transitioncomplete', this.transitionComplete, this);
         eventEmitter.on('preupdate', this.preUpdate, this);
         eventEmitter.on('update', this.update, this);
+
         eventEmitter.once('shutdown', this.shutdown, this);
         eventEmitter.once('destroy', this.destroy, this);
 
+        this.enabled = true;
+
         this.cameras = this.systems.cameras;
 
         this.displayList = this.systems.displayList;
@@ -1434,8 +1459,8 @@ var InputPlugin = new Class({
     {
         var manager = this.manager;
 
-        //  Another Scene above this one has already consumed the input events
-        if (manager.globalTopOnly && manager.ignoreEvents)
+        //  Another Scene above this one has already consumed the input events, or we're in transition
+        if (!this.enabled || (manager.globalTopOnly && manager.ignoreEvents))
         {
             return;
         }
@@ -1514,6 +1539,45 @@ var InputPlugin = new Class({
         }
     },
 
+    /**
+     * The Scene that owns this plugin is transitioning in.
+     *
+     * @method Phaser.Input.InputPlugin#transitionIn
+     * @private
+     * @since 3.4.1
+     */
+    transitionIn: function ()
+    {
+        this.enabled = this.settings.transitionAllowInput;
+    },
+
+    /**
+     * The Scene that owns this plugin has finished transitioning in.
+     *
+     * @method Phaser.Input.InputPlugin#transitionComplete
+     * @private
+     * @since 3.4.1
+     */
+    transitionComplete: function ()
+    {
+        if (!this.settings.transitionAllowInput)
+        {
+            this.enabled = true;
+        }
+    },
+
+    /**
+     * The Scene that owns this plugin is transitioning out.
+     *
+     * @method Phaser.Input.InputPlugin#transitionOut
+     * @private
+     * @since 3.4.1
+     */
+    transitionOut: function ()
+    {
+        this.enabled = this.settings.transitionAllowInput;
+    },
+
     /**
      * 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.
@@ -1540,6 +1604,10 @@ var InputPlugin = new Class({
 
         var eventEmitter = this.systems.events;
 
+        eventEmitter.off('transitionstart', this.transitionIn, this);
+        eventEmitter.off('transitionout', this.transitionOut, this);
+        eventEmitter.off('transitioncomplete', this.transitionComplete, this);
+
         eventEmitter.off('preupdate', this.preUpdate, this);
         eventEmitter.off('update', this.update, this);
         eventEmitter.off('shutdown', this.shutdown, this);