wassname/phaser
1
0
Fork 0
mirror of https://github.com/wassname/phaser.git synced 2026-09-09 11:28:47 +08:00
Code Issues Packages Projects Releases Wiki Activity

Input and keyboard docs.

Browse Source
This commit is contained in:
Richard Davey
2013-10-02 13:18:58 +01:00
parent 852e82d0ca
commit 1a2dc05609
52 changed files with 8935 additions and 284 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/input/Keyboard.js
+92 -69
View File
@@ -2,10 +2,8 @@
* @author Richard Davey <rich@photonstorm.com>
* @copyright 2013 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
* @module Phaser.Keyboard
*/
/**
* Phaser - Keyboard constructor.
*
@@ -39,45 +37,53 @@ Phaser.Keyboard = function (game) {
*/
this._capture = {};
this.callbackContext = this;
this.onDownCallback = null;
this.onUpCallback = null;
/**
* You can disable all Keyboard Input by setting disabled to true. While true all new input related events will be ignored.
* @property {boolean} disabled - The disabled state of the Keyboard.
* @default
*/
disabled: false,
this.onDown = new Phaser.Signal();
this.onUp = new Phaser.Signal();
/**
* @property {function} _onKeyDown
* @private
* @default
*/
_onKeyDown: null,
/**
* @property {function} _onKeyUp
* @private
* @default
*/
_onKeyUp: null,
/**
* @property {Object} callbackContext - The context under which the callbacks are run.
*/
this.callbackContext = this;
/**
* @property {function} onDownCallback - This callback is invoked every time a key is pressed down.
*/
this.onDownCallback = null;
/**
* @property {function} onUpCallback - This callback is invoked every time a key is released.
*/
this.onUpCallback = null;
};
Phaser.Keyboard.prototype = {
/**
* @property {Phaser.Game} game - Local reference to game.
*/
game: null,
/**
* You can disable all Input by setting disabled = true. While set all new input related events will be ignored.
* @default
* @property {boolean} disabled
* Add callbacks to the Keyboard handler so that each time a key is pressed down or releases the callbacks are activated.
* @method Phaser.Keyboard#addCallbacks
* @param {Object} context - The context under which the callbacks are run.
* @param {function} onDown - This callback is invoked every time a key is pressed down.
* @param {function} [onUp=null] - This callback is invoked every time a key is released.
*/
disabled: false,
/**
* Description.
* @property {Description} _onKeyDown
* @private
* @default
*/
_onKeyDown: null,
/**
* Description.
* @property {Description} _onKeyUp
* @private
* @default
*/
_onKeyUp: null,
addCallbacks: function (context, onDown, onUp) {
this.callbackContext = context;
@@ -90,6 +96,14 @@ Phaser.Keyboard.prototype = {
},
/**
* If you need more fine-grained control over a Key you can create a new Phaser.Key object via this method.
* The Key object can then be polled, have events attached to it, etc.
*
* @method Phaser.Keyboard#addKey
* @param {number} keycode - The keycode of the key, i.e. Phaser.Keyboard.UP or Phaser.Keyboard.SPACE_BAR
* @return {Phaser.Key} The Key object which you can store locally and reference directly.
*/
addKey: function (keycode) {
this._hotkeys[keycode] = new Phaser.Key(this.game, keycode);
@@ -97,16 +111,24 @@ Phaser.Keyboard.prototype = {
},
/**
* Removes a Key object from the Keyboard manager.
*
* @method Phaser.Keyboard#removeKey
* @param {number} keycode - The keycode of the key to remove, i.e. Phaser.Keyboard.UP or Phaser.Keyboard.SPACE_BAR
*/
removeKey: function (keycode) {
delete (this._hotkeys[keycode]);
},
/**
* Description.
* @method start
*/
/**
* Starts the Keyboard event listeners running (keydown and keyup). They are attached to the document.body.
* This is called automatically by Phaser.Input and should not normally be invoked directly.
*
* @method Phaser.Keyboard#start
*/
start: function () {
var _this = this;
@@ -124,10 +146,11 @@ Phaser.Keyboard.prototype = {
},
/**
* Description.
* @method stop
*/
/**
* Stops the Keyboard event listeners from running (keydown and keyup). They are removed from the document.body.
*
* @method Phaser.Keyboard#stop
*/
stop: function () {
document.body.removeEventListener('keydown', this._onKeyDown);
@@ -140,7 +163,7 @@ Phaser.Keyboard.prototype = {
* There are some keys this can be annoying for, like the arrow keys or space bar, which make the browser window scroll.
* You can use addKeyCapture to consume the keyboard event for specific keys so it doesn't bubble up to the the browser.
* Pass in either a single keycode or an array/hash of keycodes.
* @method addKeyCapture
* @method Phaser.Keyboard#addKeyCapture
* @param {Any} keycode
*/
addKeyCapture: function (keycode) {
@@ -159,8 +182,8 @@ Phaser.Keyboard.prototype = {
},
/**
* Description.
* @method removeKeyCapture
* Removes an existing key capture.
* @method Phaser.Keyboard#removeKeyCapture
* @param {number} keycode
*/
removeKeyCapture: function (keycode) {
@@ -170,8 +193,8 @@ Phaser.Keyboard.prototype = {
},
/**
* Description.
* @method clearCaptures
* Clear all set key captures.
* @method Phaser.Keyboard#clearCaptures
*/
clearCaptures: function () {
@@ -180,9 +203,10 @@ Phaser.Keyboard.prototype = {
},
/**
* Description.
* @method processKeyDown
* Process the keydown event.
* @method Phaser.Keyboard#processKeyDown
* @param {KeyboardEvent} event
* @protected
*/
processKeyDown: function (event) {
@@ -235,9 +259,10 @@ Phaser.Keyboard.prototype = {
},
/**
* Description.
* @method processKeyUp
* Process the keyup event.
* @method Phaser.Keyboard#processKeyUp
* @param {KeyboardEvent} event
* @protected
*/
processKeyUp: function (event) {
@@ -267,8 +292,8 @@ Phaser.Keyboard.prototype = {
},
/**
* Description.
* @method reset
* Reset the "isDown" state of all keys.
* @method Phaser.Keyboard#reset
*/
reset: function () {
@@ -279,12 +304,12 @@ Phaser.Keyboard.prototype = {
},
/**
* Description.
* @method justPressed
* @param {number} keycode
* @param {number} [duration]
* @return {boolean}
/**
* Returns the "just pressed" state of the key. Just pressed is considered true if the key was pressed down within the duration given (default 250ms)
* @method Phaser.Keyboard#justPressed
* @param {number} keycode - The keycode of the key to remove, i.e. Phaser.Keyboard.UP or Phaser.Keyboard.SPACE_BAR
* @param {number} [duration=250] - The duration below which the key is considered as being just pressed.
* @return {boolean} True if the key is just pressed otherwise false.
*/
justPressed: function (keycode, duration) {
@@ -300,11 +325,11 @@ Phaser.Keyboard.prototype = {
},
/**
* Description.
* @method justReleased
* @param {number} keycode
* @param {number} [duration]
* @return {boolean}
* Returns the "just released" state of the Key. Just released is considered as being true if the key was released within the duration given (default 250ms)
* @method Phaser.Keyboard#justPressed
* @param {number} keycode - The keycode of the key to remove, i.e. Phaser.Keyboard.UP or Phaser.Keyboard.SPACE_BAR
* @param {number} [duration=250] - The duration below which the key is considered as being just released.
* @return {boolean} True if the key is just released otherwise false.
*/
justReleased: function (keycode, duration) {
@@ -320,10 +345,10 @@ Phaser.Keyboard.prototype = {
},
/**
* Description.
* @method isDown
* @param {number} keycode
* @return {boolean}
* Returns true of the key is currently pressed down. Note that it can only detect key presses on the web browser.
* @method Phaser.Keyboard#isDown
* @param {number} keycode - The keycode of the key to remove, i.e. Phaser.Keyboard.UP or Phaser.Keyboard.SPACE_BAR
* @return {boolean} True if the key is currently down.
*/
isDown: function (keycode) {
@@ -338,8 +363,6 @@ Phaser.Keyboard.prototype = {
};
// Statics
Phaser.Keyboard.A = "A".charCodeAt(0);
Phaser.Keyboard.B = "B".charCodeAt(0);
Phaser.Keyboard.C = "C".charCodeAt(0);