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

Updated documentation per current Phaser tag usage

Browse source
This commit is contained in:
Paul 2014-10-28 21:46:33 -07:00
parent 9a16448021
commit 84363d9f36
6 changed files with 18 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
src/input/Gamepad.js
View file

@ -46,7 +46,7 @@ Phaser.Gamepad = function (game) {
/**
* Gamepad input will only be processed if enabled.
* @member {boolean}
* @property {boolean} enabled
* @default
*/
this.enabled = true;
@ -483,7 +483,8 @@ Phaser.Gamepad.prototype.constructor = Phaser.Gamepad;
/**
* If disabled all Gamepad input will be ignored.
* @member {boolean}
* @property {boolean} disabled
* @memberof Phaser.Gamepad
* @default false
* @deprecated Use {@link Phaser.Gamepad#enabled} instead
*/

5
src/input/Input.js
View file

@ -56,7 +56,7 @@ Phaser.Input = function (game) {
* When enabled, input (eg. Keyboard, Mouse, Touch) will be processed - as long as the individual sources are enabled themselves.
*
* When not enabled, _all_ input sources are ignored. To disable just one type of input; for example, the Mouse, use `input.mouse.enabled = false`.
* @member {boolean}
* @property {boolean} enabled
* @default
*/
this.enabled = true;
@ -990,7 +990,8 @@ Object.defineProperty(Phaser.Input.prototype, "worldY", {
/**
* _All_ input sources (eg. Mouse, Keyboard, Touch) are ignored when Input is disabled.
* To disable just one type of input; for example, the Mouse, use `input.mouse.enabled = false`.
* @member {boolean}
* @property {boolean} disabled
* @memberof Phaser.Input
* @default false
* @deprecated Use {@link Phaser.Input#enabled} instead
*/

5
src/input/Keyboard.js
View file

@ -23,7 +23,7 @@ Phaser.Keyboard = function (game) {
/**
* Keyboard input will only be processed if enabled.
* @member {boolean}
* @property {boolean} enabled
* @default
*/
this.enabled = true;
@ -519,7 +519,8 @@ Phaser.Keyboard.prototype = {
/**
* If disabled all Keyboard input will be ignored.
* @member {boolean}
* @property {boolean} disabled
* @memberof Phaser.Keyboard
* @default false
* @deprecated Use {@link Phaser.Keyboard#enabled} instead
*/

5
src/input/MSPointer.js
View file

@ -28,7 +28,7 @@ Phaser.MSPointer = function (game) {
/**
* MSPointer input will only be processed if enabled.
* @member {boolean}
* @property {boolean} enabled
* @default
*/
this.enabled = true;
@ -178,7 +178,8 @@ Phaser.MSPointer.prototype.constructor = Phaser.MSPointer;
/**
* If disabled all MSPointer input will be ignored.
* @member {boolean}
* @property {boolean} disabled
* @memberof Phaser.MSPointer
* @default false
* @deprecated Use {@link Phaser.MSPointer#enabled} instead
*/

5
src/input/Mouse.js
View file

@ -74,7 +74,7 @@ Phaser.Mouse = function (game) {
/**
* Mouse input will only be processed if enabled.
* @member {boolean}
* @property {boolean} enabled
* @default
*/
this.enabled = true;
@ -548,7 +548,8 @@ Phaser.Mouse.prototype.constructor = Phaser.Mouse;
/**
* If disabled all Mouse input will be ignored.
* @member {boolean}
* @property {boolean} disabled
* @memberof Phaser.Mouse
* @default false
* @deprecated Use {@link Phaser.Mouse#enabled} instead
*/

5
src/input/Touch.js
View file

@ -20,7 +20,7 @@ Phaser.Touch = function (game) {
/**
* Touch events will only be processed if enabled.
* @member {boolean}
* @property {boolean} enabled
* @default
*/
this.enabled = true;
@ -382,7 +382,8 @@ Phaser.Touch.prototype.constructor = Phaser.Touch;
/**
* If disabled all Touch events will be ignored.
* @member {boolean}
* @property {boolean} disabled
* @memberof Phaser.Touch
* @default false
* @deprecated Use {@link Phaser.Touch#enabled} instead
*/