The Input system will now order input based on the scenes from top to bottom

If the global top only flag is on and a scene consumes an input event then they won't flow any further down the scene list. This is optional (but on by default), allowing you to now correctly create a UI Scene above a game scene without the input events polluting one to the other.

src/input/InputManager.js

@@ -38,9 +38,16 @@ var InputManager = new Class({
 
         this.scale = { x: 1, y: 1 };
 
+        //  If the top-most Scene in the Scene List receives an input it will stop input from
+        //  propagating any lower down the scene list, i.e. if you have a UI Scene at the top
+        //  and click something on it, that click will not then be passed down to any other
+        //  Scene below. Disable this to have input events passed through all Scenes, all the time.
+        this.globalTopOnly = true;
+
+        this.ignoreEvents = false;
+
         this.bounds;
 
-        // this._tempMatrix = new TransformMatrix();
         this._tempPoint = { x: 0, y: 0 };
         this._tempHitTest = [];
 
@@ -85,6 +92,8 @@ var InputManager = new Class({
         this.keyboard.update();
         this.gamepad.update();
 
+        this.ignoreEvents = false;
+
         var len = this.queue.length;
 
         //  Currently just 1 pointer supported

src/input/InputPlugin.js

@@ -210,6 +210,8 @@ var InputPlugin = new Class({
         //  Contains ALL Game Objects currently over in the array
         this.emit('pointerdown', pointer, currentlyOver);
 
+        var total = 0;
+
         //  Go through all objects the pointer was over and fire their events / callbacks
         for (var i = 0; i < currentlyOver.length; i++)
         {
@@ -220,10 +222,14 @@ var InputPlugin = new Class({
                 continue;
             }
 
+            total++;
+
             gameObject.emit('pointerdown', pointer, gameObject.input.localX, gameObject.input.localY, pointer.camera);
 
             this.emit('gameobjectdown', pointer, gameObject);
         }
+
+        return total;
     },
 
     processDragEvents: function (pointer, time)
@@ -231,7 +237,7 @@ var InputPlugin = new Class({
         if (this._draggable.length === 0)
         {
             //  There are no draggable items, so let's not even bother going further
-            return;
+            return 0;
         }
 
         var i;
@@ -481,6 +487,8 @@ var InputPlugin = new Class({
 
             pointer.dragState = 0;
         }
+        
+        return (pointer.dragState > 0);
     },
 
     processMoveEvents: function (pointer)
@@ -489,6 +497,8 @@ var InputPlugin = new Class({
 
         this.emit('pointermove', pointer, currentlyOver);
 
+        var total = 0;
+
         //  Go through all objects the pointer was over and fire their events / callbacks
         for (var i = 0; i < currentlyOver.length; i++)
         {
@@ -499,6 +509,8 @@ var InputPlugin = new Class({
                 continue;
             }
 
+            total++;
+
             gameObject.emit('pointermove', pointer, gameObject.input.localX, gameObject.input.localY);
 
             this.emit('gameobjectmove', pointer, gameObject);
@@ -508,6 +520,8 @@ var InputPlugin = new Class({
                 break;
             }
         }
+
+        return total;
     },
 
     processOverOutEvents: function (pointer)
@@ -611,6 +625,8 @@ var InputPlugin = new Class({
 
         //  Then sort it into display list order
         this._over[pointer.id] = this.sortGameObjects(previouslyOver);
+
+        return previouslyOver.length;
     },
 
     processUpEvents: function (pointer)
@@ -808,6 +824,13 @@ var InputPlugin = new Class({
         return this;
     },
 
+    setGlobalTopOnly: function (value)
+    {
+        this.manager.globalTopOnly = value;
+
+        return this;
+    },
+
     setTopOnly: function (value)
     {
         this.topOnly = value;
@@ -887,9 +910,27 @@ var InputPlugin = new Class({
         return interactiveObjects.sort(this.sortHandlerIO.bind(this));
     },
 
+    stopPropagation: function ()
+    {
+        if (this.manager.globalTopOnly)
+        {
+            this.manager.ignoreEvents = true;
+        }
+
+        return this;
+    },
+
     update: function (time, delta)
     {
-        var pointer = this.manager.activePointer;
+        var manager = this.manager;
+
+        //  Another Scene above this one has already consumed the input events
+        if (manager.globalTopOnly && manager.ignoreEvents)
+        {
+            return;
+        }
+
+        var pointer = manager.activePointer;
 
         var runUpdate = (pointer.dirty || this.pollRate === 0);
 
@@ -921,16 +962,16 @@ var InputPlugin = new Class({
             this._temp.splice(1);
         }
 
-        this.processDragEvents(pointer, time);
+        var total = this.processDragEvents(pointer, time);
 
         if (!pointer.wasTouch)
         {
-            this.processOverOutEvents(pointer);
+            total += this.processOverOutEvents(pointer);
         }
 
         if (pointer.justDown)
         {
-            this.processDownEvents(pointer);
+            total += this.processDownEvents(pointer);
         }
 
         if (pointer.justUp)
@@ -940,7 +981,13 @@ var InputPlugin = new Class({
 
         if (pointer.justMoved)
         {
-            this.processMoveEvents(pointer);
+            total += this.processMoveEvents(pointer);
+        }
+
+        if (total > 0 && manager.globalTopOnly)
+        {
+            //  We interacted with an event in this Scene, so block any Scenes below us from doing the same this frame
+            manager.ignoreEvents = true;
         }
     },