Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2025-02-17 22:48:34 +00:00
Code Issues Projects Releases Packages Wiki Activity

Merge branch 'master' into containers

Browse source
This commit is contained in:
Felipe Alfonso 2018-03-30 11:50:54 -03:00
commit 749a69c387
25 changed files with 215 additions and 291 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
CHANGELOG.md
View file

@ -26,6 +26,7 @@ being passed to the simulation. The default value is 1 to remain consistent with
* The RenderTexture now uses the ComputedSize component instead of Size (which requires a frame), allowing calls to getBounds to work. Fix #3451 (thanks @kuoruan)
* PathFollower.start has been renamed to `startFollow`, but PathFollower.setPath was still using `PathFollower.start` (thanks @samid737)
* BaseSoundManager.rate and BaseSoundManager.detune would incorrectly called `setRate` on its sounds, instead of `calculateRate`.
* The Gamepad Axis `getValue` method now correctly applies the threshold and zeroes out the returned value.
### Updates
@ -35,6 +36,11 @@ being passed to the simulation. The default value is 1 to remain consistent with
* The file `InteractiveObject.js` has been renamed to `CreateInteractiveObject.js` to more accurately reflect what it does and to avoid type errors in the docs.
* Renamed the Camera Controls module exports for `Fixed` to `FixedKeyControl` and `Smoothed` to `SmoothedKeyControl` to match the class names. Fix #3463 (thanks @seivan)
* The ComputedSize Component now has `setSize` and `setDisplaySize` methods. This component is used for Game Objects that have a non-texture based size.
* The GamepadManager now extends EventEmitter directly, just like the KeyboardManager does.
* The Gamepad Axis threshold has been increased from 0.05 to 0.1.
Also, my thanks to the following for helping with the Phaser 3 Examples, either by reporting errors or fixing them: @gabegordon @melissaelopez @samid737 @nbs @tgrajewski @pagesrichie @hexus

13
README.md
View file

@ -105,6 +105,19 @@ or the minified version:
<script src="//cdn.jsdelivr.net/npm/phaser@3.3.0/dist/phaser.min.js"></script>
```
### API Documentation
1. Go to https://photonstorm.github.io/phaser3-docs/index.html to read the docs online.
2. Checkout the [phaser3-docs](https://github.com/photonstorm/phaser3-docs) repository and then read the documentation by pointing your browser to the local `docs/` folder.
The documentation for Phaser 3 is an on-going project. Please help us by searching the Phaser code for any instance of the string `[description]` and then replacing it with some documentation.
### TypeScript Definitions
[TypeScript Definitions](https://github.com/photonstorm/phaser3-docs/tree/master/typescript) are now available.
They are automatically generated from the jsdoc comments in the Phaser source code. If you wish to help refine them then you must edit the Phaser jsdoc blocks directly. You can find more details, including the source to the conversion tool we wrote in the Docs repo.
### License
Phaser is released under the [MIT License](https://opensource.org/licenses/MIT).

19
src/cameras/controls/index.js
View file

@ -10,7 +10,26 @@
module.exports = {
/**
* This alias will be removed in a future version.
* Use `FixedKeyControl` instead.
*
* @deprecated
* @name Phaser.Cameras.Controls.Fixed
*/
Fixed: require('./FixedKeyControl'),
FixedKeyControl: require('./FixedKeyControl'),
/**
* This alias will be removed in a future version.
* Use `SmoothedKeyControl` instead.
*
* @deprecated
* @name Phaser.Cameras.Controls.Smoothed
*/
Smoothed: require('./SmoothedKeyControl'),
SmoothedKeyControl: require('./SmoothedKeyControl')
};

17
src/const.js
View file

@ -4,12 +4,19 @@
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
/**
* Global consts.
*
* @ignore
*/
var CONST = {
/**
* Phaser Release Version
*
* @name Phaser.VERSION
* @readOnly
* @type {string}
* @since 3.0.0
*/
@ -23,6 +30,7 @@ var CONST = {
* AUTO Detect Renderer.
*
* @name Phaser.AUTO
* @readOnly
* @type {integer}
* @since 3.0.0
*/
@ -32,6 +40,7 @@ var CONST = {
* Canvas Renderer.
*
* @name Phaser.CANVAS
* @readOnly
* @type {integer}
* @since 3.0.0
*/
@ -41,6 +50,7 @@ var CONST = {
* WebGL Renderer.
*
* @name Phaser.WEBGL
* @readOnly
* @type {integer}
* @since 3.0.0
*/
@ -50,6 +60,7 @@ var CONST = {
* Headless Renderer.
*
* @name Phaser.HEADLESS
* @readOnly
* @type {integer}
* @since 3.0.0
*/
@ -60,6 +71,7 @@ var CONST = {
* to help you remember what the value is doing in your code.
*
* @name Phaser.FOREVER
* @readOnly
* @type {integer}
* @since 3.0.0
*/
@ -69,6 +81,7 @@ var CONST = {
* Direction constant.
*
* @name Phaser.NONE
* @readOnly
* @type {integer}
* @since 3.0.0
*/
@ -78,6 +91,7 @@ var CONST = {
* Direction constant.
*
* @name Phaser.UP
* @readOnly
* @type {integer}
* @since 3.0.0
*/
@ -87,6 +101,7 @@ var CONST = {
* Direction constant.
*
* @name Phaser.DOWN
* @readOnly
* @type {integer}
* @since 3.0.0
*/
@ -96,6 +111,7 @@ var CONST = {
* Direction constant.
*
* @name Phaser.LEFT
* @readOnly
* @type {integer}
* @since 3.0.0
*/
@ -105,6 +121,7 @@ var CONST = {
* Direction constant.
*
* @name Phaser.RIGHT
* @readOnly
* @type {integer}
* @since 3.0.0
*/

2
src/gameobjects/DisplayList.js
View file

@ -14,7 +14,7 @@ var StableSort = require('../utils/array/StableSort');
* [description]
*
* @class DisplayList
* @extends Phaser.Structs.List
* @extends Phaser.Structs.List.<Phaser.GameObjects.GameObject>
* @memberOf Phaser.GameObjects
* @constructor
* @since 3.0.0

1
src/gameobjects/components/ToJSON.js
View file

@ -6,7 +6,6 @@
/**
* @typedef {object} JSONGameObject
* @generic {object} DATA - [data]
*
* @property {string} name - The name of this Game Object.
* @property {string} type - A textual representation of this Game Object, i.e. `sprite`.

2
src/input/CreateInteractiveObject.js
View file

@ -22,7 +22,7 @@
* @property {boolean} enabled - [description]
* @property {boolean} draggable - [description]
* @property {boolean} dropZone - [description]
* @property {[type]} target - [description]
* @property {?Phaser.GameObjects.GameObject} target - [description]
* @property {Phaser.Cameras.Scene2D.Camera} camera - [description]
* @property {*} hitArea - [description]
* @property {HitAreaCallback} hitAreaCallback - [description]

22
src/input/gamepad/Axis.js
View file

@ -52,7 +52,8 @@ var Axis = new Class({
this.index = index;
/**
* Between -1 and 1 with 0 being dead center.
* The raw axis value, between -1 and 1 with 0 being dead center.
* Use the method `getValue` to get a normalized value with the threshold applied.
*
* @name Phaser.Input.Gamepad.Axis#value
* @type {float}
@ -61,7 +62,15 @@ var Axis = new Class({
*/
this.value = 0;
this.threshold = 0.05;
/**
* Movement tolerance threshold below which axis values are ignored in `getValue`.
*
* @name Phaser.Input.Gamepad.Axis#threshold
* @type {float}
* @default 0.1
* @since 3.0.0
*/
this.threshold = 0.1;
},
/**
@ -87,14 +96,7 @@ var Axis = new Class({
*/
getValue: function ()
{
var percentage = (Math.abs(this.value) - this.threshold) / (1 - this.threshold);
if (percentage < 0)
{
percentage = 0;
}
return percentage * (this.value > 0 ? 1 : -1);
return (Math.abs(this.value) < this.threshold) ? 0 : this.value;
}
});

2
src/input/gamepad/Button.js
View file

@ -40,7 +40,7 @@ var Button = new Class({
* @type {Phaser.Events.EventEmitter}
* @since 3.0.0
*/
this.events = pad.events;
this.events = pad.manager;
/**
* [description]

15
src/input/gamepad/Gamepad.js
View file

@ -36,15 +36,6 @@ var Gamepad = new Class({
*/
this.manager = manager;
/**
* [description]
*
* @name Phaser.Input.Gamepad.Gamepad#events
* @type {Phaser.Events.EventEmitter}
* @since 3.0.0
*/
this.events = manager.events;
/**
* [description]
*
@ -143,8 +134,10 @@ var Gamepad = new Class({
{
axes[i] = new Axis(this, i);
}
axes[i].update(axisData);
else
{
axes[i].update(axisData);
}
}
}

21
src/input/gamepad/GamepadManager.js
View file

@ -5,6 +5,7 @@
*/
var Class = require('../../utils/Class');
var EventEmitter = require('eventemitter3');
var Gamepad = require('./Gamepad');
// https://developer.mozilla.org/en-US/docs/Web/API/Gamepad_API
@ -16,7 +17,7 @@ var Gamepad = require('./Gamepad');
* @typedef {object} Pad
*
* @property {string} id - [description]
* @property {number} index - [description]
* @property {integer} index - [description]
*/
/**
@ -30,6 +31,7 @@ var Gamepad = require('./Gamepad');
* [description]
*
* @class GamepadManager
* @extends Phaser.Events.EventEmitter
* @memberOf Phaser.Input.Gamepad
* @constructor
* @since 3.0.0
@ -38,10 +40,14 @@ var Gamepad = require('./Gamepad');
*/
var GamepadManager = new Class({
Extends: EventEmitter,
initialize:
function GamepadManager (inputManager)
{
EventEmitter.call(this);
/**
* [description]
*
@ -51,15 +57,6 @@ var GamepadManager = new Class({
*/
this.manager = inputManager;
/**
* [description]
*
* @name Phaser.Input.Gamepad.GamepadManager#events
* @type {Phaser.Events.EventEmitter}
* @since 3.0.0
*/
this.events = inputManager.events;
/**
* [description]
*
@ -346,7 +343,7 @@ var GamepadManager = new Class({
pad = this.getPad(event.gamepad.index);
this.events.emit('connected', pad, event);
this.emit('connected', pad, event);
break;
@ -354,7 +351,7 @@ var GamepadManager = new Class({
pad = this.getPad(event.gamepad.index);
this.events.emit('disconnected', pad, event);
this.emit('disconnected', pad, event);
break;
}

174
src/input/keyboard/keys/KeyCodes.js
View file

@ -4,566 +4,418 @@
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
module.exports = {
/**
* Keyboard Codes.
*
* @name Phaser.Input.Keyboard.KeyCodes
* @enum {integer}
* @memberOf Phaser.Input.Keyboard
* @readOnly
* @since 3.0.0
*/
var KeyCodes = {
/**
* @name Phaser.Input.Keyboard.KeyCodes.BACKSPACE
* @type {integer}
* @since 3.0.0
*/
BACKSPACE: 8,
/**
* @name Phaser.Input.Keyboard.KeyCodes.TAB
* @type {integer}
* @since 3.0.0
*/
TAB: 9,
/**
* @name Phaser.Input.Keyboard.KeyCodes.ENTER
* @type {integer}
* @since 3.0.0
*/
ENTER: 13,
/**
* @name Phaser.Input.Keyboard.KeyCodes.SHIFT
* @type {integer}
* @since 3.0.0
*/
SHIFT: 16,
/**
* @name Phaser.Input.Keyboard.KeyCodes.CTRL
* @type {integer}
* @since 3.0.0
*/
CTRL: 17,
/**
* @name Phaser.Input.Keyboard.KeyCodes.ALT
* @type {integer}
* @since 3.0.0
*/
ALT: 18,
/**
* @name Phaser.Input.Keyboard.KeyCodes.PAUSE
* @type {integer}
* @since 3.0.0
*/
PAUSE: 19,
/**
* @name Phaser.Input.Keyboard.KeyCodes.CAPS_LOCK
* @type {integer}
* @since 3.0.0
*/
CAPS_LOCK: 20,
/**
* @name Phaser.Input.Keyboard.KeyCodes.ESC
* @type {integer}
* @since 3.0.0
*/
ESC: 27,
/**
* @name Phaser.Input.Keyboard.KeyCodes.SPACE
* @type {integer}
* @since 3.0.0
*/
SPACE: 32,
/**
* @name Phaser.Input.Keyboard.KeyCodes.PAGE_UP
* @type {integer}
* @since 3.0.0
*/
PAGE_UP: 33,
/**
* @name Phaser.Input.Keyboard.KeyCodes.PAGE_DOWN
* @type {integer}
* @since 3.0.0
*/
PAGE_DOWN: 34,
/**
* @name Phaser.Input.Keyboard.KeyCodes.END
* @type {integer}
* @since 3.0.0
*/
END: 35,
/**
* @name Phaser.Input.Keyboard.KeyCodes.HOME
* @type {integer}
* @since 3.0.0
*/
HOME: 36,
/**
* @name Phaser.Input.Keyboard.KeyCodes.LEFT
* @type {integer}
* @since 3.0.0
*/
LEFT: 37,
/**
* @name Phaser.Input.Keyboard.KeyCodes.UP
* @type {integer}
* @since 3.0.0
*/
UP: 38,
/**
* @name Phaser.Input.Keyboard.KeyCodes.RIGHT
* @type {integer}
* @since 3.0.0
*/
RIGHT: 39,
/**
* @name Phaser.Input.Keyboard.KeyCodes.DOWN
* @type {integer}
* @since 3.0.0
*/
DOWN: 40,
/**
* @name Phaser.Input.Keyboard.KeyCodes.PRINT_SCREEN
* @type {integer}
* @since 3.0.0
*/
PRINT_SCREEN: 42,
/**
* @name Phaser.Input.Keyboard.KeyCodes.INSERT
* @type {integer}
* @since 3.0.0
*/
INSERT: 45,
/**
* @name Phaser.Input.Keyboard.KeyCodes.DELETE
* @type {integer}
* @since 3.0.0
*/
DELETE: 46,
/**
* @name Phaser.Input.Keyboard.KeyCodes.ZERO
* @type {integer}
* @since 3.0.0
*/
ZERO: 48,
/**
* @name Phaser.Input.Keyboard.KeyCodes.ONE
* @type {integer}
* @since 3.0.0
*/
ONE: 49,
/**
* @name Phaser.Input.Keyboard.KeyCodes.TWO
* @type {integer}
* @since 3.0.0
*/
TWO: 50,
/**
* @name Phaser.Input.Keyboard.KeyCodes.THREE
* @type {integer}
* @since 3.0.0
*/
THREE: 51,
/**
* @name Phaser.Input.Keyboard.KeyCodes.FOUR
* @type {integer}
* @since 3.0.0
*/
FOUR: 52,
/**
* @name Phaser.Input.Keyboard.KeyCodes.FIVE
* @type {integer}
* @since 3.0.0
*/
FIVE: 53,
/**
* @name Phaser.Input.Keyboard.KeyCodes.SIX
* @type {integer}
* @since 3.0.0
*/
SIX: 54,
/**
* @name Phaser.Input.Keyboard.KeyCodes.SEVEN
* @type {integer}
* @since 3.0.0
*/
SEVEN: 55,
/**
* @name Phaser.Input.Keyboard.KeyCodes.EIGHT
* @type {integer}
* @since 3.0.0
*/
EIGHT: 56,
/**
* @name Phaser.Input.Keyboard.KeyCodes.NINE
* @type {integer}
* @since 3.0.0
*/
NINE: 57,
/**
* @name Phaser.Input.Keyboard.KeyCodes.A
* @type {integer}
* @since 3.0.0
*/
A: 65,
/**
* @name Phaser.Input.Keyboard.KeyCodes.B
* @type {integer}
* @since 3.0.0
*/
B: 66,
/**
* @name Phaser.Input.Keyboard.KeyCodes.C
* @type {integer}
* @since 3.0.0
*/
C: 67,
/**
* @name Phaser.Input.Keyboard.KeyCodes.D
* @type {integer}
* @since 3.0.0
*/
D: 68,
/**
* @name Phaser.Input.Keyboard.KeyCodes.E
* @type {integer}
* @since 3.0.0
*/
E: 69,
/**
* @name Phaser.Input.Keyboard.KeyCodes.F
* @type {integer}
* @since 3.0.0
*/
F: 70,
/**
* @name Phaser.Input.Keyboard.KeyCodes.G
* @type {integer}
* @since 3.0.0
*/
G: 71,
/**
* @name Phaser.Input.Keyboard.KeyCodes.H
* @type {integer}
* @since 3.0.0
*/
H: 72,
/**
* @name Phaser.Input.Keyboard.KeyCodes.I
* @type {integer}
* @since 3.0.0
*/
I: 73,
/**
* @name Phaser.Input.Keyboard.KeyCodes.J
* @type {integer}
* @since 3.0.0
*/
J: 74,
/**
* @name Phaser.Input.Keyboard.KeyCodes.K
* @type {integer}
* @since 3.0.0
*/
K: 75,
/**
* @name Phaser.Input.Keyboard.KeyCodes.L
* @type {integer}
* @since 3.0.0
*/
L: 76,
/**
* @name Phaser.Input.Keyboard.KeyCodes.M
* @type {integer}
* @since 3.0.0
*/
M: 77,
/**
* @name Phaser.Input.Keyboard.KeyCodes.N
* @type {integer}
* @since 3.0.0
*/
N: 78,
/**
* @name Phaser.Input.Keyboard.KeyCodes.O
* @type {integer}
* @since 3.0.0
*/
O: 79,
/**
* @name Phaser.Input.Keyboard.KeyCodes.P
* @type {integer}
* @since 3.0.0
*/
P: 80,
/**
* @name Phaser.Input.Keyboard.KeyCodes.Q
* @type {integer}
* @since 3.0.0
*/
Q: 81,
/**
* @name Phaser.Input.Keyboard.KeyCodes.R
* @type {integer}
* @since 3.0.0
*/
R: 82,
/**
* @name Phaser.Input.Keyboard.KeyCodes.S
* @type {integer}
* @since 3.0.0
*/
S: 83,
/**
* @name Phaser.Input.Keyboard.KeyCodes.T
* @type {integer}
* @since 3.0.0
*/
T: 84,
/**
* @name Phaser.Input.Keyboard.KeyCodes.U
* @type {integer}
* @since 3.0.0
*/
U: 85,
/**
* @name Phaser.Input.Keyboard.KeyCodes.V
* @type {integer}
* @since 3.0.0
*/
V: 86,
/**
* @name Phaser.Input.Keyboard.KeyCodes.W
* @type {integer}
* @since 3.0.0
*/
W: 87,
/**
* @name Phaser.Input.Keyboard.KeyCodes.X
* @type {integer}
* @since 3.0.0
*/
X: 88,
/**
* @name Phaser.Input.Keyboard.KeyCodes.Y
* @type {integer}
* @since 3.0.0
*/
Y: 89,
/**
* @name Phaser.Input.Keyboard.KeyCodes.Z
* @type {integer}
* @since 3.0.0
*/
Z: 90,
/**
* @name Phaser.Input.Keyboard.KeyCodes.F1
* @type {integer}
* @since 3.0.0
*/
F1: 112,
/**
* @name Phaser.Input.Keyboard.KeyCodes.F2
* @type {integer}
* @since 3.0.0
*/
F2: 113,
/**
* @name Phaser.Input.Keyboard.KeyCodes.F3
* @type {integer}
* @since 3.0.0
*/
F3: 114,
/**
* @name Phaser.Input.Keyboard.KeyCodes.F4
* @type {integer}
* @since 3.0.0
*/
F4: 115,
/**
* @name Phaser.Input.Keyboard.KeyCodes.F5
* @type {integer}
* @since 3.0.0
*/
F5: 116,
/**
* @name Phaser.Input.Keyboard.KeyCodes.F6
* @type {integer}
* @since 3.0.0
*/
F6: 117,
/**
* @name Phaser.Input.Keyboard.KeyCodes.F7
* @type {integer}
* @since 3.0.0
*/
F7: 118,
/**
* @name Phaser.Input.Keyboard.KeyCodes.F8
* @type {integer}
* @since 3.0.0
*/
F8: 119,
/**
* @name Phaser.Input.Keyboard.KeyCodes.F9
* @type {integer}
* @since 3.0.0
*/
F9: 120,
/**
* @name Phaser.Input.Keyboard.KeyCodes.F10
* @type {integer}
* @since 3.0.0
*/
F10: 121,
/**
* @name Phaser.Input.Keyboard.KeyCodes.F11
* @type {integer}
* @since 3.0.0
*/
F11: 122,
/**
* @name Phaser.Input.Keyboard.KeyCodes.F12
* @type {integer}
* @since 3.0.0
*/
F12: 123,
/**
* @name Phaser.Input.Keyboard.KeyCodes.SEMICOLON
* @type {integer}
* @since 3.0.0
*/
SEMICOLON: 186,
/**
* @name Phaser.Input.Keyboard.KeyCodes.PLUS
* @type {integer}
* @since 3.0.0
*/
PLUS: 187,
/**
* @name Phaser.Input.Keyboard.KeyCodes.COMMA
* @type {integer}
* @since 3.0.0
*/
COMMA: 188,
/**
* @name Phaser.Input.Keyboard.KeyCodes.MINUS
* @type {integer}
* @since 3.0.0
*/
MINUS: 189,
/**
* @name Phaser.Input.Keyboard.KeyCodes.PERIOD
* @type {integer}
* @since 3.0.0
*/
PERIOD: 190,
/**
* @name Phaser.Input.Keyboard.KeyCodes.FORWARD_SLASH
* @type {integer}
* @since 3.0.0
*/
FORWARD_SLASH: 191,
/**
* @name Phaser.Input.Keyboard.KeyCodes.BACK_SLASH
* @type {integer}
* @since 3.0.0
*/
BACK_SLASH: 220,
/**
* @name Phaser.Input.Keyboard.KeyCodes.QUOTES
* @type {integer}
* @since 3.0.0
*/
QUOTES: 222,
/**
* @name Phaser.Input.Keyboard.KeyCodes.BACKTICK
* @type {integer}
* @since 3.0.0
*/
BACKTICK: 192,
/**
* @name Phaser.Input.Keyboard.KeyCodes.OPEN_BRACKET
* @type {integer}
* @since 3.0.0
*/
OPEN_BRACKET: 219,
/**
* @name Phaser.Input.Keyboard.KeyCodes.CLOSED_BRACKET
* @type {integer}
* @since 3.0.0
*/
CLOSED_BRACKET: 221
};
module.exports = KeyCodes;

19
src/physics/arcade/const.js
View file

@ -4,12 +4,19 @@
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
module.exports = {
/**
* Arcade Physics consts.
*
* @ignore
*/
var CONST = {
/**
* [description]
*
* @name Phaser.Physics.Arcade.DYNAMIC_BODY
* @readOnly
* @type {number}
* @since 3.0.0
*/
@ -19,6 +26,7 @@ module.exports = {
* [description]
*
* @name Phaser.Physics.Arcade.STATIC_BODY
* @readOnly
* @type {number}
* @since 3.0.0
*/
@ -28,6 +36,7 @@ module.exports = {
* [description]
*
* @name Phaser.Physics.Arcade.GROUP
* @readOnly
* @type {number}
* @since 3.0.0
*/
@ -37,6 +46,7 @@ module.exports = {
* [description]
*
* @name Phaser.Physics.Arcade.TILEMAPLAYER
* @readOnly
* @type {number}
* @since 3.0.0
*/
@ -46,6 +56,7 @@ module.exports = {
* [description]
*
* @name Phaser.Physics.Arcade.FACING_NONE
* @readOnly
* @type {number}
* @since 3.0.0
*/
@ -55,6 +66,7 @@ module.exports = {
* [description]
*
* @name Phaser.Physics.Arcade.FACING_UP
* @readOnly
* @type {number}
* @since 3.0.0
*/
@ -64,6 +76,7 @@ module.exports = {
* [description]
*
* @name Phaser.Physics.Arcade.FACING_DOWN
* @readOnly
* @type {number}
* @since 3.0.0
*/
@ -73,6 +86,7 @@ module.exports = {
* [description]
*
* @name Phaser.Physics.Arcade.FACING_LEFT
* @readOnly
* @type {number}
* @since 3.0.0
*/
@ -82,9 +96,12 @@ module.exports = {
* [description]
*
* @name Phaser.Physics.Arcade.FACING_RIGHT
* @readOnly
* @type {number}
* @since 3.0.0
*/
FACING_RIGHT: 14
};
module.exports = CONST;

14
src/physics/impact/COLLIDES.js
View file

@ -14,7 +14,9 @@
* FIXED collisions is undefined.
*
* @name Phaser.Physics.Impact.COLLIDES
* @type {object}
* @enum {integer}
* @memberOf Phaser.Physics.Impact
* @readOnly
* @since 3.0.0
*/
module.exports = {
@ -23,8 +25,6 @@ module.exports = {
* Never collides.
*
* @name Phaser.Physics.Impact.COLLIDES.NEVER
* @type {integer}
* @since 3.0.0
*/
NEVER: 0,
@ -32,8 +32,6 @@ module.exports = {
* Lite collision.
*
* @name Phaser.Physics.Impact.COLLIDES.LITE
* @type {integer}
* @since 3.0.0
*/
LITE: 1,
@ -41,8 +39,6 @@ module.exports = {
* Passive collision.
*
* @name Phaser.Physics.Impact.COLLIDES.PASSIVE
* @type {integer}
* @since 3.0.0
*/
PASSIVE: 2,
@ -50,8 +46,6 @@ module.exports = {
* Active collision.
*
* @name Phaser.Physics.Impact.COLLIDES.ACTIVE
* @type {integer}
* @since 3.0.0
*/
ACTIVE: 4,
@ -59,8 +53,6 @@ module.exports = {
* Fixed collision.
*
* @name Phaser.Physics.Impact.COLLIDES.FIXED
* @type {integer}
* @since 3.0.0
*/
FIXED: 8

12
src/physics/impact/TYPE.js
View file

@ -14,7 +14,9 @@
* FIXED collisions is undefined.
*
* @name Phaser.Physics.Impact.TYPE
* @type {object}
* @enum {integer}
* @memberOf Phaser.Physics.Impact
* @readOnly
* @since 3.0.0
*/
module.exports = {
@ -23,8 +25,6 @@ module.exports = {
* Collides with nothing.
*
* @name Phaser.Physics.Impact.TYPE.NONE
* @type {integer}
* @since 3.0.0
*/
NONE: 0,
@ -32,8 +32,6 @@ module.exports = {
* Type A. Collides with Type B.
*
* @name Phaser.Physics.Impact.TYPE.A
* @type {integer}
* @since 3.0.0
*/
A: 1,
@ -41,8 +39,6 @@ module.exports = {
* Type B. Collides with Type A.
*
* @name Phaser.Physics.Impact.TYPE.B
* @type {integer}
* @since 3.0.0
*/
B: 2,
@ -50,8 +46,6 @@ module.exports = {
* Collides with both types A and B.
*
* @name Phaser.Physics.Impact.TYPE.BOTH
* @type {integer}
* @since 3.0.0
*/
BOTH: 3

44
src/renderer/BlendModes.js
View file

@ -5,7 +5,13 @@
*/
/**
* @namespace Phaser.BlendModes
* Phaser Blend Modes.
*
* @name Phaser.BlendModes
* @enum {integer}
* @memberOf Phaser
* @readOnly
* @since 3.0.0
*/
module.exports = {
@ -14,8 +20,6 @@ module.exports = {
* Skips the Blend Mode check in the renderer.
*
* @name Phaser.BlendModes.SKIP_CHECK
* @type {integer}
* @since 3.0.0
*/
SKIP_CHECK: -1,
@ -23,8 +27,6 @@ module.exports = {
* Normal blend mode.
*
* @name Phaser.BlendModes.NORMAL
* @type {integer}
* @since 3.0.0
*/
NORMAL: 0,
@ -32,8 +34,6 @@ module.exports = {
* Add blend mode.
*
* @name Phaser.BlendModes.ADD
* @type {integer}
* @since 3.0.0
*/
ADD: 1,
@ -41,8 +41,6 @@ module.exports = {
* Multiply blend mode.
*
* @name Phaser.BlendModes.MULTIPLY
* @type {integer}
* @since 3.0.0
*/
MULTIPLY: 2,
@ -50,8 +48,6 @@ module.exports = {
* Screen blend mode.
*
* @name Phaser.BlendModes.SCREEN
* @type {integer}
* @since 3.0.0
*/
SCREEN: 3,
@ -59,8 +55,6 @@ module.exports = {
* Overlay blend mode.
*
* @name Phaser.BlendModes.OVERLAY
* @type {integer}
* @since 3.0.0
*/
OVERLAY: 4,
@ -68,8 +62,6 @@ module.exports = {
* Darken blend mode.
*
* @name Phaser.BlendModes.DARKEN
* @type {integer}
* @since 3.0.0
*/
DARKEN: 5,
@ -77,8 +69,6 @@ module.exports = {
* Lighten blend mode.
*
* @name Phaser.BlendModes.LIGHTEN
* @type {integer}
* @since 3.0.0
*/
LIGHTEN: 6,
@ -86,8 +76,6 @@ module.exports = {
* Color Dodge blend mode.
*
* @name Phaser.BlendModes.COLOR_DODGE
* @type {integer}
* @since 3.0.0
*/
COLOR_DODGE: 7,
@ -95,8 +83,6 @@ module.exports = {
* Color Burn blend mode.
*
* @name Phaser.BlendModes.COLOR_BURN
* @type {integer}
* @since 3.0.0
*/
COLOR_BURN: 8,
@ -104,8 +90,6 @@ module.exports = {
* Hard Light blend mode.
*
* @name Phaser.BlendModes.HARD_LIGHT
* @type {integer}
* @since 3.0.0
*/
HARD_LIGHT: 9,
@ -113,8 +97,6 @@ module.exports = {
* Soft Light blend mode.
*
* @name Phaser.BlendModes.SOFT_LIGHT
* @type {integer}
* @since 3.0.0
*/
SOFT_LIGHT: 10,
@ -122,8 +104,6 @@ module.exports = {
* Difference blend mode.
*
* @name Phaser.BlendModes.DIFFERENCE
* @type {integer}
* @since 3.0.0
*/
DIFFERENCE: 11,
@ -131,8 +111,6 @@ module.exports = {
* Exclusion blend mode.
*
* @name Phaser.BlendModes.EXCLUSION
* @type {integer}
* @since 3.0.0
*/
EXCLUSION: 12,
@ -140,8 +118,6 @@ module.exports = {
* Hue blend mode.
*
* @name Phaser.BlendModes.HUE
* @type {integer}
* @since 3.0.0
*/
HUE: 13,
@ -149,8 +125,6 @@ module.exports = {
* Saturation blend mode.
*
* @name Phaser.BlendModes.SATURATION
* @type {integer}
* @since 3.0.0
*/
SATURATION: 14,
@ -158,8 +132,6 @@ module.exports = {
* Color blend mode.
*
* @name Phaser.BlendModes.COLOR
* @type {integer}
* @since 3.0.0
*/
COLOR: 15,
@ -167,8 +139,6 @@ module.exports = {
* Luminosity blend mode.
*
* @name Phaser.BlendModes.LUMINOSITY
* @type {integer}
* @since 3.0.0
*/
LUMINOSITY: 16

14
src/renderer/ScaleModes.js
View file

@ -5,7 +5,13 @@
*/
/**
* @namespace Phaser.ScaleModes
* Phaser Scale Modes.
*
* @name Phaser.ScaleModes
* @enum {integer}
* @memberOf Phaser
* @readOnly
* @since 3.0.0
*/
module.exports = {
@ -14,8 +20,6 @@ module.exports = {
* Default Scale Mode (Linear).
*
* @name Phaser.ScaleModes.DEFAULT
* @type {integer}
* @since 3.0.0
*/
DEFAULT: 0,
@ -23,8 +27,6 @@ module.exports = {
* Linear Scale Mode.
*
* @name Phaser.ScaleModes.LINEAR
* @type {integer}
* @since 3.0.0
*/
LINEAR: 0,
@ -32,8 +34,6 @@ module.exports = {
* Nearest Scale Mode.
*
* @name Phaser.ScaleModes.NEAREST
* @type {integer}
* @since 3.0.0
*/
NEAREST: 1

4
src/renderer/canvas/CanvasRenderer.js
View file

@ -132,7 +132,7 @@ var CanvasRenderer = new Class({
* Map to the required function.
*
* @name Phaser.Renderer.Canvas.CanvasRenderer#drawImage
* @type {Phaser.Renderer.Canvas.DrawImage}
* @type {function}
* @since 3.0.0
*/
this.drawImage = DrawImage(this.config.roundPixels);
@ -141,7 +141,7 @@ var CanvasRenderer = new Class({
* [description]
*
* @name Phaser.Renderer.Canvas.CanvasRenderer#blitImage
* @type {Phaser.Renderer.Canvas.BlitImage}
* @type {function}
* @since 3.0.0
*/
this.blitImage = BlitImage(this.config.roundPixels);

19
src/scene/const.js
View file

@ -4,13 +4,19 @@
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
/**
* Scene consts.
*
* @ignore
*/
module.exports = {
var CONST = {
/**
* Scene state.
*
* @name Phaser.Scenes.PENDING
* @readOnly
* @type {integer}
* @since 3.0.0
*/
@ -20,6 +26,7 @@ module.exports = {
* Scene state.
*
* @name Phaser.Scenes.INIT
* @readOnly
* @type {integer}
* @since 3.0.0
*/
@ -29,6 +36,7 @@ module.exports = {
* Scene state.
*
* @name Phaser.Scenes.START
* @readOnly
* @type {integer}
* @since 3.0.0
*/
@ -38,6 +46,7 @@ module.exports = {
* Scene state.
*
* @name Phaser.Scenes.LOADING
* @readOnly
* @type {integer}
* @since 3.0.0
*/
@ -47,6 +56,7 @@ module.exports = {
* Scene state.
*
* @name Phaser.Scenes.CREATING
* @readOnly
* @type {integer}
* @since 3.0.0
*/
@ -56,6 +66,7 @@ module.exports = {
* Scene state.
*
* @name Phaser.Scenes.RUNNING
* @readOnly
* @type {integer}
* @since 3.0.0
*/
@ -65,6 +76,7 @@ module.exports = {
* Scene state.
*
* @name Phaser.Scenes.PAUSED
* @readOnly
* @type {integer}
* @since 3.0.0
*/
@ -74,6 +86,7 @@ module.exports = {
* Scene state.
*
* @name Phaser.Scenes.SLEEPING
* @readOnly
* @type {integer}
* @since 3.0.0
*/
@ -83,6 +96,7 @@ module.exports = {
* Scene state.
*
* @name Phaser.Scenes.SHUTDOWN
* @readOnly
* @type {integer}
* @since 3.0.0
*/
@ -92,9 +106,12 @@ module.exports = {
* Scene state.
*
* @name Phaser.Scenes.DESTROYED
* @readOnly
* @type {integer}
* @since 3.0.0
*/
DESTROYED: 9
};
module.exports = CONST;

28
src/structs/List.js
View file

@ -8,7 +8,7 @@ var Class = require('../utils/Class');
/**
* @callback EachListCallback
* @generic {*} I - [item]
* @generic I - [item]
*
* @param {*} item - [description]
* @param {...*} [args] - Additional arguments that will be passed to the callback, after the child.
@ -18,8 +18,6 @@ var Class = require('../utils/Class');
* @classdesc
* [description]
*
* @generic T
*
* @class List
* @memberOf Phaser.Structs
* @constructor
@ -245,7 +243,7 @@ var List = new Class({
* @since 3.0.0
*
* @genericUse {T} - [value]
* @genericUse {?T} - [$return]
* @genericUse {T | null} - [$return]
*
* @param {string} property - The property to check against the value.
* @param {*} value - The value to check if the property strictly equals.
@ -273,7 +271,7 @@ var List = new Class({
* @method Phaser.Structs.List#getByName
* @since 3.0.0
*
* @genericUse {?T} - [$return]
* @genericUse {T | null} - [$return]
*
* @param {string} name - The name to search for.
*
@ -290,7 +288,7 @@ var List = new Class({
* @method Phaser.Structs.List#getRandom
* @since 3.0.0
*
* @genericUse {?T} - [$return]
* @genericUse {T | null} - [$return]
*
* @param {integer} [startIndex=0] - Offset from the front of the group (lowest child).
* @param {integer} [length=(to top)] - Restriction on the number of values you want to randomly select from.
@ -319,7 +317,7 @@ var List = new Class({
* @since 3.0.0
*
* @genericUse {T} - [value]
* @genericUse {?T} - [$return]
* @genericUse {T | null} - [$return]
*
* @param {string} property - [description]
* @param {*} value - [description]
@ -578,6 +576,8 @@ var List = new Class({
* @method Phaser.Structs.List#removeAll
* @since 3.0.0
*
* @genericUse {Phaser.Structs.List.<T>} - [$return]
*
* @return {Phaser.Structs.List} This List object.
*/
removeAll: function ()
@ -598,7 +598,7 @@ var List = new Class({
* @method Phaser.Structs.List#bringToTop
* @since 3.0.0
*
* @generic {T} O - [child,$return]
* @genericUse {T} - [child,$return]
*
* @param {*} child - [description]
*
@ -621,7 +621,7 @@ var List = new Class({
* @method Phaser.Structs.List#sendToBack
* @since 3.0.0
*
* @generic {T} O - [child,$return]
* @genericUse {T} - [child,$return]
*
* @param {*} child - [description]
*
@ -644,7 +644,7 @@ var List = new Class({
* @method Phaser.Structs.List#moveUp
* @since 3.0.0
*
* @generic {T} O - [child,$return]
* @genericUse {T} - [child,$return]
*
* @param {*} child - [description]
*
@ -673,7 +673,7 @@ var List = new Class({
* @method Phaser.Structs.List#moveDown
* @since 3.0.0
*
* @generic {T} O - [child,$return]
* @genericUse {T} - [child,$return]
*
* @param {*} child - [description]
*
@ -702,6 +702,8 @@ var List = new Class({
* @method Phaser.Structs.List#reverse
* @since 3.0.0
*
* @genericUse {Phaser.Structs.List.<T>} - [$return]
*
* @return {Phaser.Structs.List} This List object.
*/
reverse: function ()
@ -717,6 +719,8 @@ var List = new Class({
* @method Phaser.Structs.List#shuffle
* @since 3.0.0
*
* @genericUse {Phaser.Structs.List.<T>} - [$return]
*
* @return {Phaser.Structs.List} This List object.
*/
shuffle: function ()
@ -738,7 +742,7 @@ var List = new Class({
* @method Phaser.Structs.List#replace
* @since 3.0.0
*
* @generic {T} O - [oldChild,newChild,$return]
* @genericUse {T} - [oldChild,newChild,$return]
*
* @param {*} oldChild - The child in this List that will be replaced.
* @param {*} newChild - The child to be inserted into this List.

36
src/structs/Map.js
View file

@ -8,7 +8,7 @@ var Class = require('../utils/Class');
/**
* @callback EachMapCallback
* @generic {*} E - [entry]
* @generic E - [entry]
*
* @param {string} key - [description]
* @param {E} entry - [description]
@ -30,8 +30,9 @@ var Class = require('../utils/Class');
* @constructor
* @since 3.0.0
*
* @generic T
* @genericUse {T[]} - [elements]
* @generic K
* @generic V
* @genericUse {V[]} - [elements]
*
* @param {Array.<*>} elements - [description]
*/
@ -44,7 +45,7 @@ var Map = new Class({
/**
* [description]
*
* @genericUse {Object.<string, T>} - [$type]
* @genericUse {Object.<string, V>} - [$type]
*
* @name Phaser.Structs.Map#entries
* @type {Object.<string, *>}
@ -78,7 +79,9 @@ var Map = new Class({
* @method Phaser.Structs.Map#set
* @since 3.0.0
*
* @genericUse {T} - [value]
* @genericUse {K} - [key]
* @genericUse {V} - [value]
* @genericUse {Phaser.Structs.Map.<K, V>} - [$return]
*
* @param {string} key - [description]
* @param {*} value - [description]
@ -102,7 +105,8 @@ var Map = new Class({
* @method Phaser.Structs.Map#get
* @since 3.0.0
*
* @genericUse {T} - [$return]
* @genericUse {K} - [key]
* @genericUse {V} - [$return]
*
* @param {string} key - [description]
*
@ -122,7 +126,7 @@ var Map = new Class({
* @method Phaser.Structs.Map#getArray
* @since 3.0.0
*
* @genericUse {T[]} - [$return]
* @genericUse {V[]} - [$return]
*
* @return {Array.<*>} [description]
*/
@ -145,6 +149,8 @@ var Map = new Class({
* @method Phaser.Structs.Map#has
* @since 3.0.0
*
* @genericUse {K} - [key]
*
* @param {string} key - [description]
*
* @return {boolean} [description]
@ -160,6 +166,9 @@ var Map = new Class({
* @method Phaser.Structs.Map#delete
* @since 3.0.0
*
* @genericUse {K} - [key]
* @genericUse {Phaser.Structs.Map.<K, V>} - [$return]
*
* @param {string} key - [description]
*
* @return {Phaser.Structs.Map} This Map object.
@ -181,6 +190,8 @@ var Map = new Class({
* @method Phaser.Structs.Map#clear
* @since 3.0.0
*
* @genericUse {Phaser.Structs.Map.<K, V>} - [$return]
*
* @return {Phaser.Structs.Map} This Map object.
*/
clear: function ()
@ -202,6 +213,8 @@ var Map = new Class({
* @method Phaser.Structs.Map#keys
* @since 3.0.0
*
* @genericUse {K[]} - [$return]
*
* @return {string[]} [description]
*/
keys: function ()
@ -215,7 +228,7 @@ var Map = new Class({
* @method Phaser.Structs.Map#values
* @since 3.0.0
*
* @genericUse {T[]} - [$return]
* @genericUse {V[]} - [$return]
*
* @return {Array.<*>} [description]
*/
@ -260,7 +273,8 @@ var Map = new Class({
* @method Phaser.Structs.Map#each
* @since 3.0.0
*
* @genericUse {EachMapCallback.<T>} - [callback]
* @genericUse {EachMapCallback.<V>} - [callback]
* @genericUse {Phaser.Structs.Map.<K, V>} - [$return]
*
* @param {EachMapCallback} callback - [description]
*
@ -287,7 +301,7 @@ var Map = new Class({
* @method Phaser.Structs.Map#contains
* @since 3.0.0
*
* @genericUse {T} - [value]
* @genericUse {V} - [value]
*
* @param {*} value - [description]
*
@ -316,6 +330,8 @@ var Map = new Class({
* @method Phaser.Structs.Map#merge
* @since 3.0.0
*
* @genericUse {Phaser.Structs.Map.<K, V>} - [map,$return]
*
* @param {Phaser.Structs.Map} map - [description]
* @param {boolean} [override=false] - [description]
*

2
src/structs/ProcessQueue.js
View file

@ -81,6 +81,7 @@ var ProcessQueue = new Class({
* @since 3.0.0
*
* @genericUse {T} - [item]
* @genericUse {Phaser.Structs.ProcessQueue.<T>} - [$return]
*
* @param {*} item - [description]
*
@ -102,6 +103,7 @@ var ProcessQueue = new Class({
* @since 3.0.0
*
* @genericUse {T} - [item]
* @genericUse {Phaser.Structs.ProcessQueue.<T>} - [$return]
*
* @param {*} item - [description]
*

16
src/structs/Set.js
View file

@ -8,7 +8,7 @@ var Class = require('../utils/Class');
/**
* @callback EachSetCallback
* @generic {*} E - [entry]
* @generic E - [entry]
*
* @param {*} entry - [description]
* @param {number} index - [description]
@ -64,6 +64,7 @@ var Set = new Class({
* @since 3.0.0
*
* @genericUse {T} - [value]
* @genericUse {Phaser.Structs.Set.<T>} - [$return]
*
* @param {*} value - [description]
*
@ -127,6 +128,7 @@ var Set = new Class({
* @since 3.0.0
*
* @genericUse {T} - [value]
* @genericUse {Phaser.Structs.Set.<T>} - [$return]
*
* @param {*} value - [description]
*
@ -172,6 +174,7 @@ var Set = new Class({
* @since 3.0.0
*
* @genericUse {EachSetCallback.<T>} - [callback]
* @genericUse {Phaser.Structs.Set.<T>} - [$return]
*
* @param {EachSetCallback} callback - [description]
* @param {*} callbackScope - [description]
@ -215,6 +218,7 @@ var Set = new Class({
* @since 3.0.0
*
* @genericUse {EachSetCallback.<T>} - [callback]
* @genericUse {Phaser.Structs.Set.<T>} - [$return]
*
* @param {EachSetCallback} callback - [description]
* @param {*} callbackScope - [description]
@ -256,6 +260,8 @@ var Set = new Class({
* @method Phaser.Structs.Set#iterateLocal
* @since 3.0.0
*
* @genericUse {Phaser.Structs.Set.<T>} - [$return]
*
* @param {string} callbackKey - [description]
* @param {...*} [args] - Additional arguments that will be passed to the callback, after the child.
*
@ -289,6 +295,8 @@ var Set = new Class({
* @method Phaser.Structs.Set#clear
* @since 3.0.0
*
* @genericUse {Phaser.Structs.Set.<T>} - [$return]
*
* @return {Phaser.Structs.Set} This Set object.
*/
clear: function ()
@ -321,6 +329,8 @@ var Set = new Class({
* @method Phaser.Structs.Set#union
* @since 3.0.0
*
* @genericUse {Phaser.Structs.Set.<T>} - [set,$return]
*
* @param {Phaser.Structs.Set} set - [description]
*
* @return {Phaser.Structs.Set} [description]
@ -348,6 +358,8 @@ var Set = new Class({
* @method Phaser.Structs.Set#intersect
* @since 3.0.0
*
* @genericUse {Phaser.Structs.Set.<T>} - [set,$return]
*
* @param {Phaser.Structs.Set} set - [description]
*
* @return {Phaser.Structs.Set} [description]
@ -373,6 +385,8 @@ var Set = new Class({
* @method Phaser.Structs.Set#difference
* @since 3.0.0
*
* @genericUse {Phaser.Structs.Set.<T>} - [set,$return]
*
* @param {Phaser.Structs.Set} set - [description]
*
* @return {Phaser.Structs.Set} [description]

2
src/textures/Texture.js
View file

@ -372,7 +372,7 @@ var Texture = new Class({
* @method Phaser.Textures.Texture#setFilter
* @since 3.0.0
*
* @param {(Phaser.Textures.FilterMode.LINEAR|Phaser.Textures.FilterMode.NEAREST)} filterMode - The Filter Mode.
* @param {Phaser.Textures.FilterMode} filterMode - The Filter Mode.
*/
setFilter: function (filterMode)
{

2
src/textures/TextureSource.js
View file

@ -164,7 +164,7 @@ var TextureSource = new Class({
* @method Phaser.Textures.TextureSource#setFilter
* @since 3.0.0
*
* @param {(Phaser.Textures.FilterMode.LINEAR|Phaser.Textures.FilterMode.NEAREST)} filterMode - The Filter Mode.
* @param {Phaser.Textures.FilterMode} filterMode - The Filter Mode.
*/
setFilter: function (filterMode)
{