Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2024-11-17 10:18:42 +00:00
Code Issues Projects Releases Packages Wiki Activity

Added new captures array.

Browse source
This commit is contained in:
Richard Davey 2018-11-13 15:09:18 +00:00
parent 355bc2e1ee
commit 8de7973c92
1 changed files with 34 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

41
src/input/keyboard/KeyboardPlugin.js
View file

@ -164,19 +164,18 @@ var KeyboardPlugin = new Class({
this.time = 0; this.time = 0;
/** /**
* A flag that controls if all non-modified keys pressed have `preventDefault` called on them or not. * A flag that controls if the non-modified keys, matching those stored in the `captures` array,
* * have `preventDefault` called on them or not. By default this is `true`.
* By default this is `true`.
* *
* A non-modified key is one that doesn't have a modifier key held down with it. The modifier keys are * A non-modified key is one that doesn't have a modifier key held down with it. The modifier keys are
* shift, control, alt and the meta key (Command on a Mac, the Windows Key on Windows). * shift, control, alt and the meta key (Command on a Mac, the Windows Key on Windows).
* Therefore, if the user presses shift + r, it won't prevent this combination, because of the modifier. * Therefore, if the user presses shift + r, it won't prevent this combination, because of the modifier.
* However, if the user presses just the r key on its own, it will have its event prevented. * However, if the user presses just the r key on its own, it will have its event prevented.
* *
* You can set this flag to stop any key from triggering the default browser action, or if you need * You can set this flag to stop any capture key from triggering the default browser action, or if you need
* more specific control, you can create Key objects and set the flag on each of those instead. * more specific control, you can create Key objects and set the flag on each of those instead.
* *
* This flag can be set in the Game Config by setting the `input.keyboard.capture` boolean, or you * This flag can be set in the Game Config by setting the `input.keyboard.capture` to a `false` boolean, or you
* can set it in the Scene Config, in which case the Scene Config setting overrides the Game Config one. * can set it in the Scene Config, in which case the Scene Config setting overrides the Game Config one.
* *
* @name Phaser.Input.Keyboard.KeyboardPlugin#preventDefault * @name Phaser.Input.Keyboard.KeyboardPlugin#preventDefault
@ -185,6 +184,33 @@ var KeyboardPlugin = new Class({
*/ */
this.preventDefault = true; this.preventDefault = true;
/**
* An array of Key Code values that will automatically have `preventDefault` called on them,
* as long as the `KeyboardPlugin.preventDefault` boolean is set to `true`.
*
* By default the array contains: The Space Key, the Cursor Keys, 0 to 9 and A to Z.
*
* The key must be non-modified when pressed in order to be captured.
*
* A non-modified key is one that doesn't have a modifier key held down with it. The modifier keys are
* shift, control, alt and the meta key (Command on a Mac, the Windows Key on Windows).
* Therefore, if the user presses shift + r, it won't prevent this combination, because of the modifier.
* However, if the user presses just the r key on its own, it will have its event prevented.
*
* If you wish to stop capturing the keys, for example switching out to a DOM based element, then
* you can toggle the `KeyboardPlugin.preventDefault` boolean at run-time.
*
* If you need more specific control, you can create Key objects and set the flag on each of those instead.
*
* This array can be populated via the Game Config by setting the `input.keyboard.capture` array, or you
* can set it in the Scene Config, in which case the Scene Config array overrides the Game Config one.
*
* @name Phaser.Input.Keyboard.KeyboardPlugin#captures
* @type {integer[]}
* @since 3.16.0
*/
this.captures = [];
sceneInputPlugin.pluginEvents.once('boot', this.boot, this); sceneInputPlugin.pluginEvents.once('boot', this.boot, this);
sceneInputPlugin.pluginEvents.on('start', this.start, this); sceneInputPlugin.pluginEvents.on('start', this.start, this);
}, },
@ -204,7 +230,8 @@ var KeyboardPlugin = new Class({
this.enabled = GetValue(settings, 'keyboard', config.inputKeyboard); this.enabled = GetValue(settings, 'keyboard', config.inputKeyboard);
this.target = GetValue(settings, 'keyboard.target', config.inputKeyboardEventTarget); this.target = GetValue(settings, 'keyboard.target', config.inputKeyboardEventTarget);
this.preventDefault = GetValue(settings, 'keyboard.capture', config.inputKeyboardCapture); this.captures = GetValue(settings, 'keyboard.capture', config.inputKeyboardCapture);
this.preventDefault = this.captures.length > 0;
this.sceneInputPlugin.pluginEvents.once('destroy', this.destroy, this); this.sceneInputPlugin.pluginEvents.once('destroy', this.destroy, this);
}, },
@ -267,7 +294,7 @@ var KeyboardPlugin = new Class({
var modified = (event.altKey || event.ctrlKey || event.shiftKey || event.metaKey); var modified = (event.altKey || event.ctrlKey || event.shiftKey || event.metaKey);
if (_this.preventDefault && !modified || key && key.preventDefault) if ((_this.preventDefault && !modified && _this.captures.indexOf(event.keyCode) > -1) || (key && key.preventDefault))
{ {
event.preventDefault(); event.preventDefault();
} }