Key.enabled boolean allows you to toggle if a Key processes its update method or dispatches any events without deleting and re-creating it.

Author: photonstorm

README.md

@@ -99,6 +99,7 @@ New Features
 * StateManager.restart allows you to quickly restart the *current* state, optionally clearing the world and cache.
 * Tilemap.removeTile(x, y, layer) lets you remove the tile at the given coordinates and updates the collision data.
 * Tilemap.removeTileWorldXY lets you remove the tile at the given pixel value coordinates and updates the collision data.
+* Key.enabled boolean allows you to toggle if a Key processes its update method or dispatches any events without deleting and re-creating it.
 
 
 Bug Fixes

src/input/Key.js

@@ -18,6 +18,12 @@ Phaser.Key = function (game, keycode) {
     */
     this.game = game;
 
+    /**
+    * @property {boolean} enabled - An enabled key processes its update and dispatches events. You can toggle this at run-time to disable a key without deleting it.
+    * @default
+    */
+    this.enabled = true;
+
     /**
     * @property {object} event - Stores the most recent DOM event.
     * @readonly
@@ -110,6 +116,8 @@ Phaser.Key.prototype = {
 
     update: function () {
 
+        if (!this.enabled) { return; }
+
         if (this.isDown)
         {
             this.duration = this.game.time.now - this.timeDown;
@@ -131,6 +139,8 @@ Phaser.Key.prototype = {
     */
     processKeyDown: function (event) {
 
+        if (!this.enabled) { return; }
+
         this.event = event;
 
         if (this.isDown)
@@ -160,6 +170,8 @@ Phaser.Key.prototype = {
     */
     processKeyUp: function (event) {
 
+        if (!this.enabled) { return; }
+
         this.event = event;
 
         if (this.isUp)
@@ -188,6 +200,7 @@ Phaser.Key.prototype = {
         this.isUp = true;
         this.timeUp = this.game.time.now;
         this.duration = this.game.time.now - this.timeDown;
+        this.enabled = true;
 
         this.onDown.removeAll();
         this.onUp.removeAll();