Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2024-11-22 04:33:31 +00:00
Code Issues Projects Releases Packages Wiki Activity

Added jsdoc version numbers

Browse source
This commit is contained in:
Richard Davey 2019-02-12 12:22:25 +00:00
parent 56dfdb7a74
commit dc73993fe2
7 changed files with 140 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -18,481 +18,577 @@ var KeyCodes = {
/**
* @name Phaser.Input.Keyboard.KeyCodes.BACKSPACE
* @since 3.0.0
*/
BACKSPACE: 8,
/**
* @name Phaser.Input.Keyboard.KeyCodes.TAB
* @since 3.0.0
*/
TAB: 9,
/**
* @name Phaser.Input.Keyboard.KeyCodes.ENTER
* @since 3.0.0
*/
ENTER: 13,
/**
* @name Phaser.Input.Keyboard.KeyCodes.SHIFT
* @since 3.0.0
*/
SHIFT: 16,
/**
* @name Phaser.Input.Keyboard.KeyCodes.CTRL
* @since 3.0.0
*/
CTRL: 17,
/**
* @name Phaser.Input.Keyboard.KeyCodes.ALT
* @since 3.0.0
*/
ALT: 18,
/**
* @name Phaser.Input.Keyboard.KeyCodes.PAUSE
* @since 3.0.0
*/
PAUSE: 19,
/**
* @name Phaser.Input.Keyboard.KeyCodes.CAPS_LOCK
* @since 3.0.0
*/
CAPS_LOCK: 20,
/**
* @name Phaser.Input.Keyboard.KeyCodes.ESC
* @since 3.0.0
*/
ESC: 27,
/**
* @name Phaser.Input.Keyboard.KeyCodes.SPACE
* @since 3.0.0
*/
SPACE: 32,
/**
* @name Phaser.Input.Keyboard.KeyCodes.PAGE_UP
* @since 3.0.0
*/
PAGE_UP: 33,
/**
* @name Phaser.Input.Keyboard.KeyCodes.PAGE_DOWN
* @since 3.0.0
*/
PAGE_DOWN: 34,
/**
* @name Phaser.Input.Keyboard.KeyCodes.END
* @since 3.0.0
*/
END: 35,
/**
* @name Phaser.Input.Keyboard.KeyCodes.HOME
* @since 3.0.0
*/
HOME: 36,
/**
* @name Phaser.Input.Keyboard.KeyCodes.LEFT
* @since 3.0.0
*/
LEFT: 37,
/**
* @name Phaser.Input.Keyboard.KeyCodes.UP
* @since 3.0.0
*/
UP: 38,
/**
* @name Phaser.Input.Keyboard.KeyCodes.RIGHT
* @since 3.0.0
*/
RIGHT: 39,
/**
* @name Phaser.Input.Keyboard.KeyCodes.DOWN
* @since 3.0.0
*/
DOWN: 40,
/**
* @name Phaser.Input.Keyboard.KeyCodes.PRINT_SCREEN
* @since 3.0.0
*/
PRINT_SCREEN: 42,
/**
* @name Phaser.Input.Keyboard.KeyCodes.INSERT
* @since 3.0.0
*/
INSERT: 45,
/**
* @name Phaser.Input.Keyboard.KeyCodes.DELETE
* @since 3.0.0
*/
DELETE: 46,
/**
* @name Phaser.Input.Keyboard.KeyCodes.ZERO
* @since 3.0.0
*/
ZERO: 48,
/**
* @name Phaser.Input.Keyboard.KeyCodes.ONE
* @since 3.0.0
*/
ONE: 49,
/**
* @name Phaser.Input.Keyboard.KeyCodes.TWO
* @since 3.0.0
*/
TWO: 50,
/**
* @name Phaser.Input.Keyboard.KeyCodes.THREE
* @since 3.0.0
*/
THREE: 51,
/**
* @name Phaser.Input.Keyboard.KeyCodes.FOUR
* @since 3.0.0
*/
FOUR: 52,
/**
* @name Phaser.Input.Keyboard.KeyCodes.FIVE
* @since 3.0.0
*/
FIVE: 53,
/**
* @name Phaser.Input.Keyboard.KeyCodes.SIX
* @since 3.0.0
*/
SIX: 54,
/**
* @name Phaser.Input.Keyboard.KeyCodes.SEVEN
* @since 3.0.0
*/
SEVEN: 55,
/**
* @name Phaser.Input.Keyboard.KeyCodes.EIGHT
* @since 3.0.0
*/
EIGHT: 56,
/**
* @name Phaser.Input.Keyboard.KeyCodes.NINE
* @since 3.0.0
*/
NINE: 57,
/**
* @name Phaser.Input.Keyboard.KeyCodes.NUMPAD_ZERO
* @since 3.0.0
*/
NUMPAD_ZERO: 96,
/**
* @name Phaser.Input.Keyboard.KeyCodes.NUMPAD_ONE
* @since 3.0.0
*/
NUMPAD_ONE: 97,
/**
* @name Phaser.Input.Keyboard.KeyCodes.NUMPAD_TWO
* @since 3.0.0
*/
NUMPAD_TWO: 98,
/**
* @name Phaser.Input.Keyboard.KeyCodes.NUMPAD_THREE
* @since 3.0.0
*/
NUMPAD_THREE: 99,
/**
* @name Phaser.Input.Keyboard.KeyCodes.NUMPAD_FOUR
* @since 3.0.0
*/
NUMPAD_FOUR: 100,
/**
* @name Phaser.Input.Keyboard.KeyCodes.NUMPAD_FIVE
* @since 3.0.0
*/
NUMPAD_FIVE: 101,
/**
* @name Phaser.Input.Keyboard.KeyCodes.NUMPAD_SIX
* @since 3.0.0
*/
NUMPAD_SIX: 102,
/**
* @name Phaser.Input.Keyboard.KeyCodes.NUMPAD_SEVEN
* @since 3.0.0
*/
NUMPAD_SEVEN: 103,
/**
* @name Phaser.Input.Keyboard.KeyCodes.NUMPAD_EIGHT
* @since 3.0.0
*/
NUMPAD_EIGHT: 104,
/**
* @name Phaser.Input.Keyboard.KeyCodes.NUMPAD_NINE
* @since 3.0.0
*/
NUMPAD_NINE: 105,
/**
* @name Phaser.Input.Keyboard.KeyCodes.A
* @since 3.0.0
*/
A: 65,
/**
* @name Phaser.Input.Keyboard.KeyCodes.B
* @since 3.0.0
*/
B: 66,
/**
* @name Phaser.Input.Keyboard.KeyCodes.C
* @since 3.0.0
*/
C: 67,
/**
* @name Phaser.Input.Keyboard.KeyCodes.D
* @since 3.0.0
*/
D: 68,
/**
* @name Phaser.Input.Keyboard.KeyCodes.E
* @since 3.0.0
*/
E: 69,
/**
* @name Phaser.Input.Keyboard.KeyCodes.F
* @since 3.0.0
*/
F: 70,
/**
* @name Phaser.Input.Keyboard.KeyCodes.G
* @since 3.0.0
*/
G: 71,
/**
* @name Phaser.Input.Keyboard.KeyCodes.H
* @since 3.0.0
*/
H: 72,
/**
* @name Phaser.Input.Keyboard.KeyCodes.I
* @since 3.0.0
*/
I: 73,
/**
* @name Phaser.Input.Keyboard.KeyCodes.J
* @since 3.0.0
*/
J: 74,
/**
* @name Phaser.Input.Keyboard.KeyCodes.K
* @since 3.0.0
*/
K: 75,
/**
* @name Phaser.Input.Keyboard.KeyCodes.L
* @since 3.0.0
*/
L: 76,
/**
* @name Phaser.Input.Keyboard.KeyCodes.M
* @since 3.0.0
*/
M: 77,
/**
* @name Phaser.Input.Keyboard.KeyCodes.N
* @since 3.0.0
*/
N: 78,
/**
* @name Phaser.Input.Keyboard.KeyCodes.O
* @since 3.0.0
*/
O: 79,
/**
* @name Phaser.Input.Keyboard.KeyCodes.P
* @since 3.0.0
*/
P: 80,
/**
* @name Phaser.Input.Keyboard.KeyCodes.Q
* @since 3.0.0
*/
Q: 81,
/**
* @name Phaser.Input.Keyboard.KeyCodes.R
* @since 3.0.0
*/
R: 82,
/**
* @name Phaser.Input.Keyboard.KeyCodes.S
* @since 3.0.0
*/
S: 83,
/**
* @name Phaser.Input.Keyboard.KeyCodes.T
* @since 3.0.0
*/
T: 84,
/**
* @name Phaser.Input.Keyboard.KeyCodes.U
* @since 3.0.0
*/
U: 85,
/**
* @name Phaser.Input.Keyboard.KeyCodes.V
* @since 3.0.0
*/
V: 86,
/**
* @name Phaser.Input.Keyboard.KeyCodes.W
* @since 3.0.0
*/
W: 87,
/**
* @name Phaser.Input.Keyboard.KeyCodes.X
* @since 3.0.0
*/
X: 88,
/**
* @name Phaser.Input.Keyboard.KeyCodes.Y
* @since 3.0.0
*/
Y: 89,
/**
* @name Phaser.Input.Keyboard.KeyCodes.Z
* @since 3.0.0
*/
Z: 90,
/**
* @name Phaser.Input.Keyboard.KeyCodes.F1
* @since 3.0.0
*/
F1: 112,
/**
* @name Phaser.Input.Keyboard.KeyCodes.F2
* @since 3.0.0
*/
F2: 113,
/**
* @name Phaser.Input.Keyboard.KeyCodes.F3
* @since 3.0.0
*/
F3: 114,
/**
* @name Phaser.Input.Keyboard.KeyCodes.F4
* @since 3.0.0
*/
F4: 115,
/**
* @name Phaser.Input.Keyboard.KeyCodes.F5
* @since 3.0.0
*/
F5: 116,
/**
* @name Phaser.Input.Keyboard.KeyCodes.F6
* @since 3.0.0
*/
F6: 117,
/**
* @name Phaser.Input.Keyboard.KeyCodes.F7
* @since 3.0.0
*/
F7: 118,
/**
* @name Phaser.Input.Keyboard.KeyCodes.F8
* @since 3.0.0
*/
F8: 119,
/**
* @name Phaser.Input.Keyboard.KeyCodes.F9
* @since 3.0.0
*/
F9: 120,
/**
* @name Phaser.Input.Keyboard.KeyCodes.F10
* @since 3.0.0
*/
F10: 121,
/**
* @name Phaser.Input.Keyboard.KeyCodes.F11
* @since 3.0.0
*/
F11: 122,
/**
* @name Phaser.Input.Keyboard.KeyCodes.F12
* @since 3.0.0
*/
F12: 123,
/**
* @name Phaser.Input.Keyboard.KeyCodes.SEMICOLON
* @since 3.0.0
*/
SEMICOLON: 186,
/**
* @name Phaser.Input.Keyboard.KeyCodes.PLUS
* @since 3.0.0
*/
PLUS: 187,
/**
* @name Phaser.Input.Keyboard.KeyCodes.COMMA
* @since 3.0.0
*/
COMMA: 188,
/**
* @name Phaser.Input.Keyboard.KeyCodes.MINUS
* @since 3.0.0
*/
MINUS: 189,
/**
* @name Phaser.Input.Keyboard.KeyCodes.PERIOD
* @since 3.0.0
*/
PERIOD: 190,
/**
* @name Phaser.Input.Keyboard.KeyCodes.FORWARD_SLASH
* @since 3.0.0
*/
FORWARD_SLASH: 191,
/**
* @name Phaser.Input.Keyboard.KeyCodes.BACK_SLASH
* @since 3.0.0
*/
BACK_SLASH: 220,
/**
* @name Phaser.Input.Keyboard.KeyCodes.QUOTES
* @since 3.0.0
*/
QUOTES: 222,
/**
* @name Phaser.Input.Keyboard.KeyCodes.BACKTICK
* @since 3.0.0
*/
BACKTICK: 192,
/**
* @name Phaser.Input.Keyboard.KeyCodes.OPEN_BRACKET
* @since 3.0.0
*/
OPEN_BRACKET: 219,
/**
* @name Phaser.Input.Keyboard.KeyCodes.CLOSED_BRACKET
* @since 3.0.0
*/
CLOSED_BRACKET: 221,
/**
* @name Phaser.Input.Keyboard.KeyCodes.SEMICOLON_FIREFOX
* @since 3.0.0
*/
SEMICOLON_FIREFOX: 59,
/**
* @name Phaser.Input.Keyboard.KeyCodes.COLON
* @since 3.0.0
*/
COLON: 58,
/**
* @name Phaser.Input.Keyboard.KeyCodes.COMMA_FIREFOX_WINDOWS
* @since 3.0.0
*/
COMMA_FIREFOX_WINDOWS: 60,
/**
* @name Phaser.Input.Keyboard.KeyCodes.COMMA_FIREFOX
* @since 3.0.0
*/
COMMA_FIREFOX: 62,
/**
* @name Phaser.Input.Keyboard.KeyCodes.BRACKET_RIGHT_FIREFOX
* @since 3.0.0
*/
BRACKET_RIGHT_FIREFOX: 174,
/**
* @name Phaser.Input.Keyboard.KeyCodes.BRACKET_LEFT_FIREFOX
* @since 3.0.0
*/
BRACKET_LEFT_FIREFOX: 175
};

1
src/physics/arcade/PhysicsGroup.js
View file

@ -147,6 +147,7 @@ var PhysicsGroup = new Class({
* @name Phaser.Physics.Arcade.Group#classType
* @type {GroupClassTypeConstructor}
* @default ArcadeSprite
* @since 3.0.0
*/
config.classType = GetFastValue(config, 'classType', ArcadeSprite);

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

@ -25,6 +25,7 @@ module.exports = {
* Never collides.
*
* @name Phaser.Physics.Impact.COLLIDES.NEVER
* @since 3.0.0
*/
NEVER: 0,
@ -32,6 +33,7 @@ module.exports = {
* Lite collision.
*
* @name Phaser.Physics.Impact.COLLIDES.LITE
* @since 3.0.0
*/
LITE: 1,
@ -39,6 +41,7 @@ module.exports = {
* Passive collision.
*
* @name Phaser.Physics.Impact.COLLIDES.PASSIVE
* @since 3.0.0
*/
PASSIVE: 2,
@ -46,6 +49,7 @@ module.exports = {
* Active collision.
*
* @name Phaser.Physics.Impact.COLLIDES.ACTIVE
* @since 3.0.0
*/
ACTIVE: 4,
@ -53,6 +57,7 @@ module.exports = {
* Fixed collision.
*
* @name Phaser.Physics.Impact.COLLIDES.FIXED
* @since 3.0.0
*/
FIXED: 8

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

@ -25,6 +25,7 @@ module.exports = {
* Collides with nothing.
*
* @name Phaser.Physics.Impact.TYPE.NONE
* @since 3.0.0
*/
NONE: 0,
@ -32,6 +33,7 @@ module.exports = {
* Type A. Collides with Type B.
*
* @name Phaser.Physics.Impact.TYPE.A
* @since 3.0.0
*/
A: 1,
@ -39,6 +41,7 @@ module.exports = {
* Type B. Collides with Type A.
*
* @name Phaser.Physics.Impact.TYPE.B
* @since 3.0.0
*/
B: 2,
@ -46,6 +49,7 @@ module.exports = {
* Collides with both types A and B.
*
* @name Phaser.Physics.Impact.TYPE.BOTH
* @since 3.0.0
*/
BOTH: 3

29
src/renderer/BlendModes.js
View file

@ -20,6 +20,7 @@ module.exports = {
* Skips the Blend Mode check in the renderer.
*
* @name Phaser.BlendModes.SKIP_CHECK
* @since 3.0.0
*/
SKIP_CHECK: -1,
@ -28,6 +29,7 @@ module.exports = {
* This is the default setting and draws new shapes on top of the existing canvas content.
*
* @name Phaser.BlendModes.NORMAL
* @since 3.0.0
*/
NORMAL: 0,
@ -36,6 +38,7 @@ module.exports = {
* Where both shapes overlap the color is determined by adding color values.
*
* @name Phaser.BlendModes.ADD
* @since 3.0.0
*/
ADD: 1,
@ -44,6 +47,7 @@ module.exports = {
* The pixels are of the top layer are multiplied with the corresponding pixel of the bottom layer. A darker picture is the result.
*
* @name Phaser.BlendModes.MULTIPLY
* @since 3.0.0
*/
MULTIPLY: 2,
@ -52,6 +56,7 @@ module.exports = {
* The pixels are inverted, multiplied, and inverted again. A lighter picture is the result (opposite of multiply)
*
* @name Phaser.BlendModes.SCREEN
* @since 3.0.0
*/
SCREEN: 3,
@ -60,6 +65,7 @@ module.exports = {
* A combination of multiply and screen. Dark parts on the base layer become darker, and light parts become lighter.
*
* @name Phaser.BlendModes.OVERLAY
* @since 3.0.0
*/
OVERLAY: 4,
@ -68,6 +74,7 @@ module.exports = {
* Retains the darkest pixels of both layers.
*
* @name Phaser.BlendModes.DARKEN
* @since 3.0.0
*/
DARKEN: 5,
@ -76,6 +83,7 @@ module.exports = {
* Retains the lightest pixels of both layers.
*
* @name Phaser.BlendModes.LIGHTEN
* @since 3.0.0
*/
LIGHTEN: 6,
@ -84,6 +92,7 @@ module.exports = {
* Divides the bottom layer by the inverted top layer.
*
* @name Phaser.BlendModes.COLOR_DODGE
* @since 3.0.0
*/
COLOR_DODGE: 7,
@ -92,6 +101,7 @@ module.exports = {
* Divides the inverted bottom layer by the top layer, and then inverts the result.
*
* @name Phaser.BlendModes.COLOR_BURN
* @since 3.0.0
*/
COLOR_BURN: 8,
@ -100,6 +110,7 @@ module.exports = {
* A combination of multiply and screen like overlay, but with top and bottom layer swapped.
*
* @name Phaser.BlendModes.HARD_LIGHT
* @since 3.0.0
*/
HARD_LIGHT: 9,
@ -108,6 +119,7 @@ module.exports = {
* A softer version of hard-light. Pure black or white does not result in pure black or white.
*
* @name Phaser.BlendModes.SOFT_LIGHT
* @since 3.0.0
*/
SOFT_LIGHT: 10,
@ -116,6 +128,7 @@ module.exports = {
* Subtracts the bottom layer from the top layer or the other way round to always get a positive value.
*
* @name Phaser.BlendModes.DIFFERENCE
* @since 3.0.0
*/
DIFFERENCE: 11,
@ -124,6 +137,7 @@ module.exports = {
* Like difference, but with lower contrast.
*
* @name Phaser.BlendModes.EXCLUSION
* @since 3.0.0
*/
EXCLUSION: 12,
@ -132,6 +146,7 @@ module.exports = {
* Preserves the luma and chroma of the bottom layer, while adopting the hue of the top layer.
*
* @name Phaser.BlendModes.HUE
* @since 3.0.0
*/
HUE: 13,
@ -140,6 +155,7 @@ module.exports = {
* Preserves the luma and hue of the bottom layer, while adopting the chroma of the top layer.
*
* @name Phaser.BlendModes.SATURATION
* @since 3.0.0
*/
SATURATION: 14,
@ -148,6 +164,7 @@ module.exports = {
* Preserves the luma of the bottom layer, while adopting the hue and chroma of the top layer.
*
* @name Phaser.BlendModes.COLOR
* @since 3.0.0
*/
COLOR: 15,
@ -156,6 +173,7 @@ module.exports = {
* Preserves the hue and chroma of the bottom layer, while adopting the luma of the top layer.
*
* @name Phaser.BlendModes.LUMINOSITY
* @since 3.0.0
*/
LUMINOSITY: 16,
@ -163,6 +181,7 @@ module.exports = {
* Alpha erase blend mode. For Canvas and WebGL.
*
* @name Phaser.BlendModes.ERASE
* @since 3.0.0
*/
ERASE: 17,
@ -171,6 +190,7 @@ module.exports = {
* The new shape is drawn only where both the new shape and the destination canvas overlap. Everything else is made transparent.
*
* @name Phaser.BlendModes.SOURCE_IN
* @since 3.0.0
*/
SOURCE_IN: 18,
@ -179,6 +199,7 @@ module.exports = {
* The new shape is drawn where it doesn't overlap the existing canvas content.
*
* @name Phaser.BlendModes.SOURCE_OUT
* @since 3.0.0
*/
SOURCE_OUT: 19,
@ -187,6 +208,7 @@ module.exports = {
* The new shape is only drawn where it overlaps the existing canvas content.
*
* @name Phaser.BlendModes.SOURCE_ATOP
* @since 3.0.0
*/
SOURCE_ATOP: 20,
@ -195,6 +217,7 @@ module.exports = {
* New shapes are drawn behind the existing canvas content.
*
* @name Phaser.BlendModes.DESTINATION_OVER
* @since 3.0.0
*/
DESTINATION_OVER: 21,
@ -203,6 +226,7 @@ module.exports = {
* The existing canvas content is kept where both the new shape and existing canvas content overlap. Everything else is made transparent.
*
* @name Phaser.BlendModes.DESTINATION_IN
* @since 3.0.0
*/
DESTINATION_IN: 22,
@ -211,6 +235,7 @@ module.exports = {
* The existing content is kept where it doesn't overlap the new shape.
*
* @name Phaser.BlendModes.DESTINATION_OUT
* @since 3.0.0
*/
DESTINATION_OUT: 23,
@ -219,6 +244,7 @@ module.exports = {
* The existing canvas is only kept where it overlaps the new shape. The new shape is drawn behind the canvas content.
*
* @name Phaser.BlendModes.DESTINATION_ATOP
* @since 3.0.0
*/
DESTINATION_ATOP: 24,
@ -227,6 +253,7 @@ module.exports = {
* Where both shapes overlap the color is determined by adding color values.
*
* @name Phaser.BlendModes.LIGHTER
* @since 3.0.0
*/
LIGHTER: 25,
@ -235,6 +262,7 @@ module.exports = {
* Only the new shape is shown.
*
* @name Phaser.BlendModes.COPY
* @since 3.0.0
*/
COPY: 26,
@ -243,6 +271,7 @@ module.exports = {
* Shapes are made transparent where both overlap and drawn normal everywhere else.
*
* @name Phaser.BlendModes.XOR
* @since 3.0.0
*/
XOR: 27

3
src/renderer/ScaleModes.js
View file

@ -20,6 +20,7 @@ module.exports = {
* Default Scale Mode (Linear).
*
* @name Phaser.ScaleModes.DEFAULT
* @since 3.0.0
*/
DEFAULT: 0,
@ -27,6 +28,7 @@ module.exports = {
* Linear Scale Mode.
*
* @name Phaser.ScaleModes.LINEAR
* @since 3.0.0
*/
LINEAR: 0,
@ -34,6 +36,7 @@ module.exports = {
* Nearest Scale Mode.
*
* @name Phaser.ScaleModes.NEAREST
* @since 3.0.0
*/
NEAREST: 1

2
src/textures/const.js
View file

@ -19,6 +19,7 @@ var CONST = {
* Linear filter type.
*
* @name Phaser.Textures.FilterMode.LINEAR
* @since 3.0.0
*/
LINEAR: 0,
@ -26,6 +27,7 @@ var CONST = {
* Nearest neighbor filter type.
*
* @name Phaser.Textures.FilterMode.NEAREST
* @since 3.0.0
*/
NEAREST: 1