Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2024-11-27 07:01:20 +00:00
Code Issues Projects Releases Packages Wiki Activity

Fixing documentation errors #450

Browse source
This commit is contained in:
photonstorm 2014-02-19 16:59:27 +00:00
parent aac31bdaa4
commit 95b3872508
1 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
src/input/SinglePad.js
View file

@ -117,7 +117,7 @@ Phaser.SinglePad.prototype = {
/** /**
* Add callbacks to the this Gamepad to handle connect/disconnect/button down/button up/axis change/float value buttons * Add callbacks to the this Gamepad to handle connect/disconnect/button down/button up/axis change/float value buttons
* @method Phaser.Gamepad#addCallbacks * @method Phaser.SinglePad#addCallbacks
* @param {Object} context - The context under which the callbacks are run. * @param {Object} context - The context under which the callbacks are run.
* @param {Object} callbacks - Object that takes six different callbak methods: * @param {Object} callbacks - Object that takes six different callbak methods:
* onConnectCallback, onDisconnectCallback, onDownCallback, onUpCallback, onAxisCallback, onFloatCallback * onConnectCallback, onDisconnectCallback, onDownCallback, onUpCallback, onAxisCallback, onFloatCallback
@ -207,8 +207,8 @@ Phaser.SinglePad.prototype = {
/** /**
* Gamepad connect function, should be called by Phaser.Gamepad * Gamepad connect function, should be called by Phaser.Gamepad
* @param {Object} rawPad - The raw gamepad object
* @method Phaser.SinglePad#connect * @method Phaser.SinglePad#connect
* @param {Object} rawPad - The raw gamepad object
*/ */
connect: function (rawPad) { connect: function (rawPad) {
@ -260,8 +260,8 @@ Phaser.SinglePad.prototype = {
/** /**
* Handles changes in axis * Handles changes in axis
* @param {Object} axisState - State of the relevant axis
* @method Phaser.SinglePad#processAxisChange * @method Phaser.SinglePad#processAxisChange
* @param {Object} axisState - State of the relevant axis
*/ */
processAxisChange: function (axisState) { processAxisChange: function (axisState) {
@ -291,9 +291,9 @@ Phaser.SinglePad.prototype = {
/** /**
* Handles button down press * Handles button down press
* @method Phaser.SinglePad#processButtonDown
* @param {number} buttonCode - Which buttonCode of this button * @param {number} buttonCode - Which buttonCode of this button
* @param {Object} value - Button value * @param {Object} value - Button value
* @method Phaser.SinglePad#processButtonDown
*/ */
processButtonDown: function (buttonCode, value) { processButtonDown: function (buttonCode, value) {
@ -349,9 +349,9 @@ Phaser.SinglePad.prototype = {
/** /**
* Handles button release * Handles button release
* @method Phaser.SinglePad#processButtonUp
* @param {number} buttonCode - Which buttonCode of this button * @param {number} buttonCode - Which buttonCode of this button
* @param {Object} value - Button value * @param {Object} value - Button value
* @method Phaser.SinglePad#processButtonUp
*/ */
processButtonUp: function (buttonCode, value) { processButtonUp: function (buttonCode, value) {
@ -397,9 +397,9 @@ Phaser.SinglePad.prototype = {
/** /**
* Handles buttons with floating values (like analog buttons that acts almost like an axis but still registers like a button) * Handles buttons with floating values (like analog buttons that acts almost like an axis but still registers like a button)
* @method Phaser.SinglePad#processButtonFloat
* @param {number} buttonCode - Which buttonCode of this button * @param {number} buttonCode - Which buttonCode of this button
* @param {Object} value - Button value (will range somewhere between 0 and 1, but not specifically 0 or 1. * @param {Object} value - Button value (will range somewhere between 0 and 1, but not specifically 0 or 1.
* @method Phaser.SinglePad#processButtonFloat
*/ */
processButtonFloat: function (buttonCode, value) { processButtonFloat: function (buttonCode, value) {
@ -438,7 +438,7 @@ Phaser.SinglePad.prototype = {
/** /**
* Returns value of requested axis * Returns value of requested axis
* @method Phaser.SinglePad#isDown * @method Phaser.SinglePad#axis
* @param {number} axisCode - The index of the axis to check * @param {number} axisCode - The index of the axis to check
* @return {number} Axis value if available otherwise false * @return {number} Axis value if available otherwise false
*/ */
@ -472,7 +472,7 @@ Phaser.SinglePad.prototype = {
/** /**
* Returns the "just released" state of a button from this gamepad. Just released is considered as being true if the button was released within the duration given (default 250ms). * Returns the "just released" state of a button from this gamepad. Just released is considered as being true if the button was released within the duration given (default 250ms).
* @method Phaser.SinglePad#justPressed * @method Phaser.SinglePad#justReleased
* @param {number} buttonCode - The buttonCode of the button to check for. * @param {number} buttonCode - The buttonCode of the button to check for.
* @param {number} [duration=250] - The duration below which the button is considered as being just released. * @param {number} [duration=250] - The duration below which the button is considered as being just released.
* @return {boolean} True if the button is just released otherwise false. * @return {boolean} True if the button is just released otherwise false.