mirror of
https://github.com/photonstorm/phaser
synced 2024-11-28 15:41:37 +00:00
Lots more jsdoc tweaks and improvements
This commit is contained in:
Richard Davey
parent
c8439393fb
commit
b50e1c78b5
49 changed files with 176 additions and 66 deletions
22
src/const.js
22
src/const.js
|
|
@ -16,7 +16,7 @@ var CONST = {
|
|||
* Phaser Release Version
|
||||
*
|
||||
* @name Phaser.VERSION
|
||||
* @readonly
|
||||
* @const
|
||||
* @type {string}
|
||||
* @since 3.0.0
|
||||
*/
|
||||
|
|
@ -30,7 +30,7 @@ var CONST = {
|
|||
* AUTO Detect Renderer.
|
||||
*
|
||||
* @name Phaser.AUTO
|
||||
* @readonly
|
||||
* @const
|
||||
* @type {integer}
|
||||
* @since 3.0.0
|
||||
*/
|
||||
|
|
@ -40,7 +40,7 @@ var CONST = {
|
|||
* Canvas Renderer.
|
||||
*
|
||||
* @name Phaser.CANVAS
|
||||
* @readonly
|
||||
* @const
|
||||
* @type {integer}
|
||||
* @since 3.0.0
|
||||
*/
|
||||
|
|
@ -50,7 +50,7 @@ var CONST = {
|
|||
* WebGL Renderer.
|
||||
*
|
||||
* @name Phaser.WEBGL
|
||||
* @readonly
|
||||
* @const
|
||||
* @type {integer}
|
||||
* @since 3.0.0
|
||||
*/
|
||||
|
|
@ -60,7 +60,7 @@ var CONST = {
|
|||
* Headless Renderer.
|
||||
*
|
||||
* @name Phaser.HEADLESS
|
||||
* @readonly
|
||||
* @const
|
||||
* @type {integer}
|
||||
* @since 3.0.0
|
||||
*/
|
||||
|
|
@ -71,7 +71,7 @@ var CONST = {
|
|||
* to help you remember what the value is doing in your code.
|
||||
*
|
||||
* @name Phaser.FOREVER
|
||||
* @readonly
|
||||
* @const
|
||||
* @type {integer}
|
||||
* @since 3.0.0
|
||||
*/
|
||||
|
|
@ -81,7 +81,7 @@ var CONST = {
|
|||
* Direction constant.
|
||||
*
|
||||
* @name Phaser.NONE
|
||||
* @readonly
|
||||
* @const
|
||||
* @type {integer}
|
||||
* @since 3.0.0
|
||||
*/
|
||||
|
|
@ -91,7 +91,7 @@ var CONST = {
|
|||
* Direction constant.
|
||||
*
|
||||
* @name Phaser.UP
|
||||
* @readonly
|
||||
* @const
|
||||
* @type {integer}
|
||||
* @since 3.0.0
|
||||
*/
|
||||
|
|
@ -101,7 +101,7 @@ var CONST = {
|
|||
* Direction constant.
|
||||
*
|
||||
* @name Phaser.DOWN
|
||||
* @readonly
|
||||
* @const
|
||||
* @type {integer}
|
||||
* @since 3.0.0
|
||||
*/
|
||||
|
|
@ -111,7 +111,7 @@ var CONST = {
|
|||
* Direction constant.
|
||||
*
|
||||
* @name Phaser.LEFT
|
||||
* @readonly
|
||||
* @const
|
||||
* @type {integer}
|
||||
* @since 3.0.0
|
||||
*/
|
||||
|
|
@ -121,7 +121,7 @@ var CONST = {
|
|||
* Direction constant.
|
||||
*
|
||||
* @name Phaser.RIGHT
|
||||
* @readonly
|
||||
* @const
|
||||
* @type {integer}
|
||||
* @since 3.0.0
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ var GetColor = function (value)
|
|||
* Provides methods used for setting the tint of a Game Object.
|
||||
* Should be applied as a mixin and not used directly.
|
||||
*
|
||||
* @name Phaser.GameObjects.Components.Tint
|
||||
* @namespace Phaser.GameObjects.Components.Tint
|
||||
* @webglOnly
|
||||
* @since 3.0.0
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -307,7 +307,7 @@ var World = new Class({
|
|||
* - 0.5 = double speed
|
||||
*
|
||||
* @name Phaser.Physics.Arcade.World#timeScale
|
||||
* @property {number}
|
||||
* @type {number}
|
||||
* @default 1
|
||||
* @since 3.10.0
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@
|
|||
/**
|
||||
* Provides methods used for setting the acceleration properties of an Arcade Physics Body.
|
||||
*
|
||||
* @name Phaser.Physics.Arcade.Components.Acceleration
|
||||
* @namespace Phaser.Physics.Arcade.Components.Acceleration
|
||||
* @since 3.0.0
|
||||
*/
|
||||
var Acceleration = {
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@
|
|||
/**
|
||||
* Provides methods used for setting the angular acceleration properties of an Arcade Physics Body.
|
||||
*
|
||||
* @name Phaser.Physics.Arcade.Components.Angular
|
||||
* @namespace Phaser.Physics.Arcade.Components.Angular
|
||||
* @since 3.0.0
|
||||
*/
|
||||
var Angular = {
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@
|
|||
/**
|
||||
* Provides methods used for setting the bounce properties of an Arcade Physics Body.
|
||||
*
|
||||
* @name Phaser.Physics.Arcade.Components.Bounce
|
||||
* @namespace Phaser.Physics.Arcade.Components.Bounce
|
||||
* @since 3.0.0
|
||||
*/
|
||||
var Bounce = {
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@
|
|||
/**
|
||||
* Provides methods used for setting the debug properties of an Arcade Physics Body.
|
||||
*
|
||||
* @name Phaser.Physics.Arcade.Components.Debug
|
||||
* @namespace Phaser.Physics.Arcade.Components.Debug
|
||||
* @since 3.0.0
|
||||
*/
|
||||
var Debug = {
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@
|
|||
/**
|
||||
* Provides methods used for setting the drag properties of an Arcade Physics Body.
|
||||
*
|
||||
* @name Phaser.Physics.Arcade.Components.Drag
|
||||
* @namespace Phaser.Physics.Arcade.Components.Drag
|
||||
* @since 3.0.0
|
||||
*/
|
||||
var Drag = {
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@
|
|||
/**
|
||||
* Provides methods used for setting the enable properties of an Arcade Physics Body.
|
||||
*
|
||||
* @name Phaser.Physics.Arcade.Components.Enable
|
||||
* @namespace Phaser.Physics.Arcade.Components.Enable
|
||||
* @since 3.0.0
|
||||
*/
|
||||
var Enable = {
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@
|
|||
/**
|
||||
* Sets the friction (e.g. the amount of velocity reduced over time) of the physics body when moving horizontally in the X axis. The higher than friction, the faster the body will slow down once force stops being applied to it.
|
||||
*
|
||||
* @name Phaser.Physics.Arcade.Components.Friction
|
||||
* @namespace Phaser.Physics.Arcade.Components.Friction
|
||||
* @since 3.0.0
|
||||
*/
|
||||
var Friction = {
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@
|
|||
* Provides methods for setting the gravity properties of an Arcade Physics Game Object.
|
||||
* Should be applied as a mixin and not used directly.
|
||||
*
|
||||
* @name Phaser.Physics.Arcade.Components.Gravity
|
||||
* @namespace Phaser.Physics.Arcade.Components.Gravity
|
||||
* @since 3.0.0
|
||||
*/
|
||||
var Gravity = {
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@
|
|||
/**
|
||||
* Provides methods used for setting the immovable properties of an Arcade Physics Body.
|
||||
*
|
||||
* @name Phaser.Physics.Arcade.Components.Immovable
|
||||
* @namespace Phaser.Physics.Arcade.Components.Immovable
|
||||
* @since 3.0.0
|
||||
*/
|
||||
var Immovable = {
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@
|
|||
/**
|
||||
* Provides methods used for setting the mass properties of an Arcade Physics Body.
|
||||
*
|
||||
* @name Phaser.Physics.Arcade.Components.Mass
|
||||
* @namespace Phaser.Physics.Arcade.Components.Mass
|
||||
* @since 3.0.0
|
||||
*/
|
||||
var Mass = {
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@
|
|||
* Provides methods for setting the size of an Arcade Physics Game Object.
|
||||
* Should be applied as a mixin and not used directly.
|
||||
*
|
||||
* @name Phaser.Physics.Arcade.Components.Size
|
||||
* @namespace Phaser.Physics.Arcade.Components.Size
|
||||
* @since 3.0.0
|
||||
*/
|
||||
var Size = {
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@
|
|||
*
|
||||
* Should be applied as a mixin and not used directly.
|
||||
*
|
||||
* @name Phaser.Physics.Arcade.Components.Velocity
|
||||
* @namespace Phaser.Physics.Arcade.Components.Velocity
|
||||
* @since 3.0.0
|
||||
*/
|
||||
var Velocity = {
|
||||
|
|
|
|||
|
|
@ -13,18 +13,19 @@
|
|||
* with other LITE or PASSIVE entities at all. The behavior for FIXED vs.
|
||||
* FIXED collisions is undefined.
|
||||
*
|
||||
* @name Phaser.Physics.Impact.COLLIDES
|
||||
* @enum {integer}
|
||||
* @namespace Phaser.Physics.Impact.COLLIDES
|
||||
* @memberof Phaser.Physics.Impact
|
||||
* @readonly
|
||||
* @since 3.0.0
|
||||
*/
|
||||
|
||||
module.exports = {
|
||||
|
||||
/**
|
||||
* Never collides.
|
||||
*
|
||||
* @name Phaser.Physics.Impact.COLLIDES.NEVER
|
||||
* @type {integer}
|
||||
* @const
|
||||
* @since 3.0.0
|
||||
*/
|
||||
NEVER: 0,
|
||||
|
|
@ -33,6 +34,8 @@ module.exports = {
|
|||
* Lite collision.
|
||||
*
|
||||
* @name Phaser.Physics.Impact.COLLIDES.LITE
|
||||
* @type {integer}
|
||||
* @const
|
||||
* @since 3.0.0
|
||||
*/
|
||||
LITE: 1,
|
||||
|
|
@ -41,6 +44,8 @@ module.exports = {
|
|||
* Passive collision.
|
||||
*
|
||||
* @name Phaser.Physics.Impact.COLLIDES.PASSIVE
|
||||
* @type {integer}
|
||||
* @const
|
||||
* @since 3.0.0
|
||||
*/
|
||||
PASSIVE: 2,
|
||||
|
|
@ -49,6 +54,8 @@ module.exports = {
|
|||
* Active collision.
|
||||
*
|
||||
* @name Phaser.Physics.Impact.COLLIDES.ACTIVE
|
||||
* @type {integer}
|
||||
* @const
|
||||
* @since 3.0.0
|
||||
*/
|
||||
ACTIVE: 4,
|
||||
|
|
@ -57,6 +64,8 @@ module.exports = {
|
|||
* Fixed collision.
|
||||
*
|
||||
* @name Phaser.Physics.Impact.COLLIDES.FIXED
|
||||
* @type {integer}
|
||||
* @const
|
||||
* @since 3.0.0
|
||||
*/
|
||||
FIXED: 8
|
||||
|
|
|
|||
|
|
@ -13,10 +13,8 @@
|
|||
* with other LITE or PASSIVE entities at all. The behavior for FIXED vs.
|
||||
* FIXED collisions is undefined.
|
||||
*
|
||||
* @name Phaser.Physics.Impact.TYPE
|
||||
* @enum {integer}
|
||||
* @namespace Phaser.Physics.Impact.TYPE
|
||||
* @memberof Phaser.Physics.Impact
|
||||
* @readonly
|
||||
* @since 3.0.0
|
||||
*/
|
||||
module.exports = {
|
||||
|
|
@ -25,6 +23,8 @@ module.exports = {
|
|||
* Collides with nothing.
|
||||
*
|
||||
* @name Phaser.Physics.Impact.TYPE.NONE
|
||||
* @type {integer}
|
||||
* @const
|
||||
* @since 3.0.0
|
||||
*/
|
||||
NONE: 0,
|
||||
|
|
@ -33,6 +33,8 @@ module.exports = {
|
|||
* Type A. Collides with Type B.
|
||||
*
|
||||
* @name Phaser.Physics.Impact.TYPE.A
|
||||
* @type {integer}
|
||||
* @const
|
||||
* @since 3.0.0
|
||||
*/
|
||||
A: 1,
|
||||
|
|
@ -41,6 +43,8 @@ module.exports = {
|
|||
* Type B. Collides with Type A.
|
||||
*
|
||||
* @name Phaser.Physics.Impact.TYPE.B
|
||||
* @type {integer}
|
||||
* @const
|
||||
* @since 3.0.0
|
||||
*/
|
||||
B: 2,
|
||||
|
|
@ -49,6 +53,8 @@ module.exports = {
|
|||
* Collides with both types A and B.
|
||||
*
|
||||
* @name Phaser.Physics.Impact.TYPE.BOTH
|
||||
* @type {integer}
|
||||
* @const
|
||||
* @since 3.0.0
|
||||
*/
|
||||
BOTH: 3
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@
|
|||
* The Impact Acceleration component.
|
||||
* Should be applied as a mixin.
|
||||
*
|
||||
* @name Phaser.Physics.Impact.Components.Acceleration
|
||||
* @namespace Phaser.Physics.Impact.Components.Acceleration
|
||||
* @since 3.0.0
|
||||
*/
|
||||
var Acceleration = {
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@
|
|||
* The Impact Body Scale component.
|
||||
* Should be applied as a mixin.
|
||||
*
|
||||
* @name Phaser.Physics.Impact.Components.BodyScale
|
||||
* @namespace Phaser.Physics.Impact.Components.BodyScale
|
||||
* @since 3.0.0
|
||||
*/
|
||||
var BodyScale = {
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ var TYPE = require('../TYPE');
|
|||
* The Impact Body Type component.
|
||||
* Should be applied as a mixin.
|
||||
*
|
||||
* @name Phaser.Physics.Impact.Components.BodyType
|
||||
* @namespace Phaser.Physics.Impact.Components.BodyType
|
||||
* @since 3.0.0
|
||||
*/
|
||||
var BodyType = {
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@
|
|||
* The Impact Bounce component.
|
||||
* Should be applied as a mixin.
|
||||
*
|
||||
* @name Phaser.Physics.Impact.Components.Bounce
|
||||
* @namespace Phaser.Physics.Impact.Components.Bounce
|
||||
* @since 3.0.0
|
||||
*/
|
||||
var Bounce = {
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ var TYPE = require('../TYPE');
|
|||
* The Impact Check Against component.
|
||||
* Should be applied as a mixin.
|
||||
*
|
||||
* @name Phaser.Physics.Impact.Components.CheckAgainst
|
||||
* @namespace Phaser.Physics.Impact.Components.CheckAgainst
|
||||
* @since 3.0.0
|
||||
*/
|
||||
var CheckAgainst = {
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ var COLLIDES = require('../COLLIDES');
|
|||
* The Impact Collides component.
|
||||
* Should be applied as a mixin.
|
||||
*
|
||||
* @name Phaser.Physics.Impact.Components.Collides
|
||||
* @namespace Phaser.Physics.Impact.Components.Collides
|
||||
* @since 3.0.0
|
||||
*/
|
||||
var Collides = {
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@
|
|||
* The Impact Debug component.
|
||||
* Should be applied as a mixin.
|
||||
*
|
||||
* @name Phaser.Physics.Impact.Components.Debug
|
||||
* @namespace Phaser.Physics.Impact.Components.Debug
|
||||
* @since 3.0.0
|
||||
*/
|
||||
var Debug = {
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@
|
|||
* The Impact Friction component.
|
||||
* Should be applied as a mixin.
|
||||
*
|
||||
* @name Phaser.Physics.Impact.Components.Friction
|
||||
* @namespace Phaser.Physics.Impact.Components.Friction
|
||||
* @since 3.0.0
|
||||
*/
|
||||
var Friction = {
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@
|
|||
* The Impact Gravity component.
|
||||
* Should be applied as a mixin.
|
||||
*
|
||||
* @name Phaser.Physics.Impact.Components.Gravity
|
||||
* @namespace Phaser.Physics.Impact.Components.Gravity
|
||||
* @since 3.0.0
|
||||
*/
|
||||
var Gravity = {
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@
|
|||
* The Impact Offset component.
|
||||
* Should be applied as a mixin.
|
||||
*
|
||||
* @name Phaser.Physics.Impact.Components.Offset
|
||||
* @namespace Phaser.Physics.Impact.Components.Offset
|
||||
* @since 3.0.0
|
||||
*/
|
||||
var Offset = {
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@
|
|||
* The Impact Set Game Object component.
|
||||
* Should be applied as a mixin.
|
||||
*
|
||||
* @name Phaser.Physics.Impact.Components.SetGameObject
|
||||
* @namespace Phaser.Physics.Impact.Components.SetGameObject
|
||||
* @since 3.0.0
|
||||
*/
|
||||
var SetGameObject = {
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@
|
|||
* The Impact Velocity component.
|
||||
* Should be applied as a mixin.
|
||||
*
|
||||
* @name Phaser.Physics.Impact.Components.Velocity
|
||||
* @namespace Phaser.Physics.Impact.Components.Velocity
|
||||
* @since 3.0.0
|
||||
*/
|
||||
var Velocity = {
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@
|
|||
/**
|
||||
* A component to set restitution on objects.
|
||||
*
|
||||
* @name Phaser.Physics.Matter.Components.Bounce
|
||||
* @namespace Phaser.Physics.Matter.Components.Bounce
|
||||
* @since 3.0.0
|
||||
*/
|
||||
var Bounce = {
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@
|
|||
/**
|
||||
* Contains methods for changing the collision filter of a Matter Body. Should be used as a mixin and not called directly.
|
||||
*
|
||||
* @name Phaser.Physics.Matter.Components.Collision
|
||||
* @namespace Phaser.Physics.Matter.Components.Collision
|
||||
* @since 3.0.0
|
||||
*/
|
||||
var Collision = {
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ var Body = require('../lib/body/Body');
|
|||
/**
|
||||
* A component to apply force to Matter.js bodies.
|
||||
*
|
||||
* @name Phaser.Physics.Matter.Components.Force
|
||||
* @namespace Phaser.Physics.Matter.Components.Force
|
||||
* @since 3.0.0
|
||||
*/
|
||||
var Force = {
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@
|
|||
/**
|
||||
* Contains methods for changing the friction of a Game Object's Matter Body. Should be used a mixin, not called directly.
|
||||
*
|
||||
* @name Phaser.Physics.Matter.Components.Friction
|
||||
* @namespace Phaser.Physics.Matter.Components.Friction
|
||||
* @since 3.0.0
|
||||
*/
|
||||
var Friction = {
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@
|
|||
/**
|
||||
* A component to manipulate world gravity for Matter.js bodies.
|
||||
*
|
||||
* @name Phaser.Physics.Matter.Components.Gravity
|
||||
* @namespace Phaser.Physics.Matter.Components.Gravity
|
||||
* @since 3.0.0
|
||||
*/
|
||||
var Gravity = {
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ var Vector2 = require('../../../math/Vector2');
|
|||
/**
|
||||
* Allows accessing the mass, density, and center of mass of a Matter-enabled Game Object. Should be used as a mixin and not directly.
|
||||
*
|
||||
* @name Phaser.Physics.Matter.Components.Mass
|
||||
* @namespace Phaser.Physics.Matter.Components.Mass
|
||||
* @since 3.0.0
|
||||
*/
|
||||
var Mass = {
|
||||
|
|
@ -53,6 +53,7 @@ var Mass = {
|
|||
* The body's center of mass.
|
||||
*
|
||||
* @name Phaser.Physics.Matter.Components.Mass#centerOfMass
|
||||
* @type {Phaser.Math.Vector2}
|
||||
* @readonly
|
||||
* @since 3.10.0
|
||||
*
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@
|
|||
/**
|
||||
* [description]
|
||||
*
|
||||
* @name Phaser.Physics.Matter.Components.Sensor
|
||||
* @namespace Phaser.Physics.Matter.Components.Sensor
|
||||
* @since 3.0.0
|
||||
*/
|
||||
var Sensor = {
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ var Vertices = require('../lib/geometry/Vertices');
|
|||
/**
|
||||
* [description]
|
||||
*
|
||||
* @name Phaser.Physics.Matter.Components.SetBody
|
||||
* @namespace Phaser.Physics.Matter.Components.SetBody
|
||||
* @since 3.0.0
|
||||
*/
|
||||
var SetBody = {
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ var MatterEvents = require('../lib/core/Events');
|
|||
/**
|
||||
* [description]
|
||||
*
|
||||
* @name Phaser.Physics.Matter.Components.Sleep
|
||||
* @namespace Phaser.Physics.Matter.Components.Sleep
|
||||
* @since 3.0.0
|
||||
*/
|
||||
var Sleep = {
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ var Body = require('../lib/body/Body');
|
|||
/**
|
||||
* [description]
|
||||
*
|
||||
* @name Phaser.Physics.Matter.Components.Static
|
||||
* @namespace Phaser.Physics.Matter.Components.Static
|
||||
* @since 3.0.0
|
||||
*/
|
||||
var Static = {
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@ var _FLAG = 4; // 0100
|
|||
/**
|
||||
* Provides methods used for getting and setting the position, scale and rotation of a Game Object.
|
||||
*
|
||||
* @name Phaser.Physics.Matter.Components.Transform
|
||||
* @namespace Phaser.Physics.Matter.Components.Transform
|
||||
* @since 3.0.0
|
||||
*/
|
||||
var Transform = {
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ var Body = require('../lib/body/Body');
|
|||
/**
|
||||
* [description]
|
||||
*
|
||||
* @name Phaser.Physics.Matter.Components.Velocity
|
||||
* @namespace Phaser.Physics.Matter.Components.Velocity
|
||||
* @since 3.0.0
|
||||
*/
|
||||
var Velocity = {
|
||||
|
|
|
|||
|
|
@ -7,10 +7,8 @@
|
|||
/**
|
||||
* Phaser Blend Modes.
|
||||
*
|
||||
* @name Phaser.BlendModes
|
||||
* @enum {integer}
|
||||
* @namespace Phaser.BlendModes
|
||||
* @memberof Phaser
|
||||
* @readonly
|
||||
* @since 3.0.0
|
||||
*/
|
||||
|
||||
|
|
@ -20,6 +18,8 @@ module.exports = {
|
|||
* Skips the Blend Mode check in the renderer.
|
||||
*
|
||||
* @name Phaser.BlendModes.SKIP_CHECK
|
||||
* @type {integer}
|
||||
* @const
|
||||
* @since 3.0.0
|
||||
*/
|
||||
SKIP_CHECK: -1,
|
||||
|
|
@ -29,6 +29,8 @@ module.exports = {
|
|||
* This is the default setting and draws new shapes on top of the existing canvas content.
|
||||
*
|
||||
* @name Phaser.BlendModes.NORMAL
|
||||
* @type {integer}
|
||||
* @const
|
||||
* @since 3.0.0
|
||||
*/
|
||||
NORMAL: 0,
|
||||
|
|
@ -38,6 +40,8 @@ module.exports = {
|
|||
* Where both shapes overlap the color is determined by adding color values.
|
||||
*
|
||||
* @name Phaser.BlendModes.ADD
|
||||
* @type {integer}
|
||||
* @const
|
||||
* @since 3.0.0
|
||||
*/
|
||||
ADD: 1,
|
||||
|
|
@ -47,6 +51,8 @@ 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
|
||||
* @type {integer}
|
||||
* @const
|
||||
* @since 3.0.0
|
||||
*/
|
||||
MULTIPLY: 2,
|
||||
|
|
@ -56,6 +62,8 @@ module.exports = {
|
|||
* The pixels are inverted, multiplied, and inverted again. A lighter picture is the result (opposite of multiply)
|
||||
*
|
||||
* @name Phaser.BlendModes.SCREEN
|
||||
* @type {integer}
|
||||
* @const
|
||||
* @since 3.0.0
|
||||
*/
|
||||
SCREEN: 3,
|
||||
|
|
@ -65,6 +73,8 @@ 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
|
||||
* @type {integer}
|
||||
* @const
|
||||
* @since 3.0.0
|
||||
*/
|
||||
OVERLAY: 4,
|
||||
|
|
@ -74,6 +84,8 @@ module.exports = {
|
|||
* Retains the darkest pixels of both layers.
|
||||
*
|
||||
* @name Phaser.BlendModes.DARKEN
|
||||
* @type {integer}
|
||||
* @const
|
||||
* @since 3.0.0
|
||||
*/
|
||||
DARKEN: 5,
|
||||
|
|
@ -83,6 +95,8 @@ module.exports = {
|
|||
* Retains the lightest pixels of both layers.
|
||||
*
|
||||
* @name Phaser.BlendModes.LIGHTEN
|
||||
* @type {integer}
|
||||
* @const
|
||||
* @since 3.0.0
|
||||
*/
|
||||
LIGHTEN: 6,
|
||||
|
|
@ -92,6 +106,8 @@ module.exports = {
|
|||
* Divides the bottom layer by the inverted top layer.
|
||||
*
|
||||
* @name Phaser.BlendModes.COLOR_DODGE
|
||||
* @type {integer}
|
||||
* @const
|
||||
* @since 3.0.0
|
||||
*/
|
||||
COLOR_DODGE: 7,
|
||||
|
|
@ -101,6 +117,8 @@ module.exports = {
|
|||
* Divides the inverted bottom layer by the top layer, and then inverts the result.
|
||||
*
|
||||
* @name Phaser.BlendModes.COLOR_BURN
|
||||
* @type {integer}
|
||||
* @const
|
||||
* @since 3.0.0
|
||||
*/
|
||||
COLOR_BURN: 8,
|
||||
|
|
@ -110,6 +128,8 @@ module.exports = {
|
|||
* A combination of multiply and screen like overlay, but with top and bottom layer swapped.
|
||||
*
|
||||
* @name Phaser.BlendModes.HARD_LIGHT
|
||||
* @type {integer}
|
||||
* @const
|
||||
* @since 3.0.0
|
||||
*/
|
||||
HARD_LIGHT: 9,
|
||||
|
|
@ -119,6 +139,8 @@ 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
|
||||
* @type {integer}
|
||||
* @const
|
||||
* @since 3.0.0
|
||||
*/
|
||||
SOFT_LIGHT: 10,
|
||||
|
|
@ -128,6 +150,8 @@ 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
|
||||
* @type {integer}
|
||||
* @const
|
||||
* @since 3.0.0
|
||||
*/
|
||||
DIFFERENCE: 11,
|
||||
|
|
@ -137,6 +161,8 @@ module.exports = {
|
|||
* Like difference, but with lower contrast.
|
||||
*
|
||||
* @name Phaser.BlendModes.EXCLUSION
|
||||
* @type {integer}
|
||||
* @const
|
||||
* @since 3.0.0
|
||||
*/
|
||||
EXCLUSION: 12,
|
||||
|
|
@ -146,6 +172,8 @@ module.exports = {
|
|||
* Preserves the luma and chroma of the bottom layer, while adopting the hue of the top layer.
|
||||
*
|
||||
* @name Phaser.BlendModes.HUE
|
||||
* @type {integer}
|
||||
* @const
|
||||
* @since 3.0.0
|
||||
*/
|
||||
HUE: 13,
|
||||
|
|
@ -155,6 +183,8 @@ module.exports = {
|
|||
* Preserves the luma and hue of the bottom layer, while adopting the chroma of the top layer.
|
||||
*
|
||||
* @name Phaser.BlendModes.SATURATION
|
||||
* @type {integer}
|
||||
* @const
|
||||
* @since 3.0.0
|
||||
*/
|
||||
SATURATION: 14,
|
||||
|
|
@ -164,6 +194,8 @@ module.exports = {
|
|||
* Preserves the luma of the bottom layer, while adopting the hue and chroma of the top layer.
|
||||
*
|
||||
* @name Phaser.BlendModes.COLOR
|
||||
* @type {integer}
|
||||
* @const
|
||||
* @since 3.0.0
|
||||
*/
|
||||
COLOR: 15,
|
||||
|
|
@ -173,6 +205,8 @@ module.exports = {
|
|||
* Preserves the hue and chroma of the bottom layer, while adopting the luma of the top layer.
|
||||
*
|
||||
* @name Phaser.BlendModes.LUMINOSITY
|
||||
* @type {integer}
|
||||
* @const
|
||||
* @since 3.0.0
|
||||
*/
|
||||
LUMINOSITY: 16,
|
||||
|
|
@ -181,6 +215,8 @@ module.exports = {
|
|||
* Alpha erase blend mode. For Canvas and WebGL.
|
||||
*
|
||||
* @name Phaser.BlendModes.ERASE
|
||||
* @type {integer}
|
||||
* @const
|
||||
* @since 3.0.0
|
||||
*/
|
||||
ERASE: 17,
|
||||
|
|
@ -190,6 +226,8 @@ 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
|
||||
* @type {integer}
|
||||
* @const
|
||||
* @since 3.0.0
|
||||
*/
|
||||
SOURCE_IN: 18,
|
||||
|
|
@ -199,6 +237,8 @@ module.exports = {
|
|||
* The new shape is drawn where it doesn't overlap the existing canvas content.
|
||||
*
|
||||
* @name Phaser.BlendModes.SOURCE_OUT
|
||||
* @type {integer}
|
||||
* @const
|
||||
* @since 3.0.0
|
||||
*/
|
||||
SOURCE_OUT: 19,
|
||||
|
|
@ -208,6 +248,8 @@ module.exports = {
|
|||
* The new shape is only drawn where it overlaps the existing canvas content.
|
||||
*
|
||||
* @name Phaser.BlendModes.SOURCE_ATOP
|
||||
* @type {integer}
|
||||
* @const
|
||||
* @since 3.0.0
|
||||
*/
|
||||
SOURCE_ATOP: 20,
|
||||
|
|
@ -217,6 +259,8 @@ module.exports = {
|
|||
* New shapes are drawn behind the existing canvas content.
|
||||
*
|
||||
* @name Phaser.BlendModes.DESTINATION_OVER
|
||||
* @type {integer}
|
||||
* @const
|
||||
* @since 3.0.0
|
||||
*/
|
||||
DESTINATION_OVER: 21,
|
||||
|
|
@ -226,6 +270,8 @@ 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
|
||||
* @type {integer}
|
||||
* @const
|
||||
* @since 3.0.0
|
||||
*/
|
||||
DESTINATION_IN: 22,
|
||||
|
|
@ -235,6 +281,8 @@ module.exports = {
|
|||
* The existing content is kept where it doesn't overlap the new shape.
|
||||
*
|
||||
* @name Phaser.BlendModes.DESTINATION_OUT
|
||||
* @type {integer}
|
||||
* @const
|
||||
* @since 3.0.0
|
||||
*/
|
||||
DESTINATION_OUT: 23,
|
||||
|
|
@ -244,6 +292,8 @@ 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
|
||||
* @type {integer}
|
||||
* @const
|
||||
* @since 3.0.0
|
||||
*/
|
||||
DESTINATION_ATOP: 24,
|
||||
|
|
@ -253,6 +303,8 @@ module.exports = {
|
|||
* Where both shapes overlap the color is determined by adding color values.
|
||||
*
|
||||
* @name Phaser.BlendModes.LIGHTER
|
||||
* @type {integer}
|
||||
* @const
|
||||
* @since 3.0.0
|
||||
*/
|
||||
LIGHTER: 25,
|
||||
|
|
@ -262,15 +314,19 @@ module.exports = {
|
|||
* Only the new shape is shown.
|
||||
*
|
||||
* @name Phaser.BlendModes.COPY
|
||||
* @type {integer}
|
||||
* @const
|
||||
* @since 3.0.0
|
||||
*/
|
||||
COPY: 26,
|
||||
|
||||
/**
|
||||
* xor blend mode. For Canvas only.
|
||||
* Xor blend mode. For Canvas only.
|
||||
* Shapes are made transparent where both overlap and drawn normal everywhere else.
|
||||
*
|
||||
* @name Phaser.BlendModes.XOR
|
||||
* @type {integer}
|
||||
* @const
|
||||
* @since 3.0.0
|
||||
*/
|
||||
XOR: 27
|
||||
|
|
|
|||
|
|
@ -7,10 +7,8 @@
|
|||
/**
|
||||
* Phaser Scale Modes.
|
||||
*
|
||||
* @name Phaser.ScaleModes
|
||||
* @enum {integer}
|
||||
* @namespace Phaser.ScaleModes
|
||||
* @memberof Phaser
|
||||
* @readonly
|
||||
* @since 3.0.0
|
||||
*/
|
||||
|
||||
|
|
@ -20,6 +18,8 @@ module.exports = {
|
|||
* Default Scale Mode (Linear).
|
||||
*
|
||||
* @name Phaser.ScaleModes.DEFAULT
|
||||
* @type {integer}
|
||||
* @const
|
||||
* @since 3.0.0
|
||||
*/
|
||||
DEFAULT: 0,
|
||||
|
|
@ -28,6 +28,8 @@ module.exports = {
|
|||
* Linear Scale Mode.
|
||||
*
|
||||
* @name Phaser.ScaleModes.LINEAR
|
||||
* @type {integer}
|
||||
* @const
|
||||
* @since 3.0.0
|
||||
*/
|
||||
LINEAR: 0,
|
||||
|
|
@ -36,6 +38,8 @@ module.exports = {
|
|||
* Nearest Scale Mode.
|
||||
*
|
||||
* @name Phaser.ScaleModes.NEAREST
|
||||
* @type {integer}
|
||||
* @const
|
||||
* @since 3.0.0
|
||||
*/
|
||||
NEAREST: 1
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@
|
|||
* Implements a model view projection matrices.
|
||||
* Pipelines can implement this for doing 2D and 3D rendering.
|
||||
*
|
||||
* @name Phaser.Renderer.WebGL.Pipelines.ModelViewProjection
|
||||
* @namespace Phaser.Renderer.WebGL.Pipelines.ModelViewProjection
|
||||
* @since 3.0.0
|
||||
*/
|
||||
var ModelViewProjection = {
|
||||
|
|
|
|||
|
|
@ -29,6 +29,8 @@ module.exports = {
|
|||
* You can still center it yourself via CSS.
|
||||
*
|
||||
* @name Phaser.Scale.Center.NO_CENTER
|
||||
* @type {integer}
|
||||
* @const
|
||||
* @since 3.16.0
|
||||
*/
|
||||
NO_CENTER: 0,
|
||||
|
|
@ -41,6 +43,8 @@ module.exports = {
|
|||
* game canvas, and does not factor in any other CSS styles you may have applied.
|
||||
*
|
||||
* @name Phaser.Scale.Center.CENTER_BOTH
|
||||
* @type {integer}
|
||||
* @const
|
||||
* @since 3.16.0
|
||||
*/
|
||||
CENTER_BOTH: 1,
|
||||
|
|
@ -53,6 +57,8 @@ module.exports = {
|
|||
* game canvas, and does not factor in any other CSS styles you may have applied.
|
||||
*
|
||||
* @name Phaser.Scale.Center.CENTER_HORIZONTALLY
|
||||
* @type {integer}
|
||||
* @const
|
||||
* @since 3.16.0
|
||||
*/
|
||||
CENTER_HORIZONTALLY: 2,
|
||||
|
|
@ -65,6 +71,8 @@ module.exports = {
|
|||
* game canvas, and does not factor in any other CSS styles you may have applied.
|
||||
*
|
||||
* @name Phaser.Scale.Center.CENTER_VERTICALLY
|
||||
* @type {integer}
|
||||
* @const
|
||||
* @since 3.16.0
|
||||
*/
|
||||
CENTER_VERTICALLY: 3
|
||||
|
|
|
|||
|
|
@ -28,6 +28,8 @@ module.exports = {
|
|||
* A landscape orientation.
|
||||
*
|
||||
* @name Phaser.Scale.Orientation.LANDSCAPE
|
||||
* @type {string}
|
||||
* @const
|
||||
* @since 3.16.0
|
||||
*/
|
||||
LANDSCAPE: 'landscape-primary',
|
||||
|
|
@ -36,6 +38,8 @@ module.exports = {
|
|||
* A portrait orientation.
|
||||
*
|
||||
* @name Phaser.Scale.Orientation.PORTRAIT
|
||||
* @type {string}
|
||||
* @const
|
||||
* @since 3.16.0
|
||||
*/
|
||||
PORTRAIT: 'portrait-primary'
|
||||
|
|
|
|||
|
|
@ -30,6 +30,8 @@ module.exports = {
|
|||
* to call the Scale Managers `resize` method to give the new dimensions, or input events will stop working.
|
||||
*
|
||||
* @name Phaser.Scale.ScaleModes.NONE
|
||||
* @type {integer}
|
||||
* @const
|
||||
* @since 3.16.0
|
||||
*/
|
||||
NONE: 0,
|
||||
|
|
@ -38,6 +40,8 @@ module.exports = {
|
|||
* The height is automatically adjusted based on the width.
|
||||
*
|
||||
* @name Phaser.Scale.ScaleModes.WIDTH_CONTROLS_HEIGHT
|
||||
* @type {integer}
|
||||
* @const
|
||||
* @since 3.16.0
|
||||
*/
|
||||
WIDTH_CONTROLS_HEIGHT: 1,
|
||||
|
|
@ -46,6 +50,8 @@ module.exports = {
|
|||
* The width is automatically adjusted based on the height.
|
||||
*
|
||||
* @name Phaser.Scale.ScaleModes.HEIGHT_CONTROLS_WIDTH
|
||||
* @type {integer}
|
||||
* @const
|
||||
* @since 3.16.0
|
||||
*/
|
||||
HEIGHT_CONTROLS_WIDTH: 2,
|
||||
|
|
@ -56,6 +62,8 @@ module.exports = {
|
|||
* inside the area which is not covered.
|
||||
*
|
||||
* @name Phaser.Scale.ScaleModes.FIT
|
||||
* @type {integer}
|
||||
* @const
|
||||
* @since 3.16.0
|
||||
*/
|
||||
FIT: 3,
|
||||
|
|
@ -65,6 +73,8 @@ module.exports = {
|
|||
* area while keeping the aspect ratio. This may extend further out than the target size.
|
||||
*
|
||||
* @name Phaser.Scale.ScaleModes.ENVELOP
|
||||
* @type {integer}
|
||||
* @const
|
||||
* @since 3.16.0
|
||||
*/
|
||||
ENVELOP: 4,
|
||||
|
|
@ -73,6 +83,8 @@ module.exports = {
|
|||
* The Canvas is resized to fit all available _parent_ space, regardless of aspect ratio.
|
||||
*
|
||||
* @name Phaser.Scale.ScaleModes.RESIZE
|
||||
* @type {integer}
|
||||
* @const
|
||||
* @since 3.16.0
|
||||
*/
|
||||
RESIZE: 5
|
||||
|
|
|
|||
|
|
@ -28,6 +28,8 @@ module.exports = {
|
|||
* The game canvas will not be zoomed by Phaser.
|
||||
*
|
||||
* @name Phaser.Scale.Zoom.NO_ZOOM
|
||||
* @type {integer}
|
||||
* @const
|
||||
* @since 3.16.0
|
||||
*/
|
||||
NO_ZOOM: 1,
|
||||
|
|
@ -36,6 +38,8 @@ module.exports = {
|
|||
* The game canvas will be 2x zoomed by Phaser.
|
||||
*
|
||||
* @name Phaser.Scale.Zoom.ZOOM_2X
|
||||
* @type {integer}
|
||||
* @const
|
||||
* @since 3.16.0
|
||||
*/
|
||||
ZOOM_2X: 2,
|
||||
|
|
@ -44,6 +48,8 @@ module.exports = {
|
|||
* The game canvas will be 4x zoomed by Phaser.
|
||||
*
|
||||
* @name Phaser.Scale.Zoom.ZOOM_4X
|
||||
* @type {integer}
|
||||
* @const
|
||||
* @since 3.16.0
|
||||
*/
|
||||
ZOOM_4X: 4,
|
||||
|
|
@ -53,6 +59,8 @@ module.exports = {
|
|||
* fit into the parent, or browser window if no parent is set.
|
||||
*
|
||||
* @name Phaser.Scale.Zoom.MAX_ZOOM
|
||||
* @type {integer}
|
||||
* @const
|
||||
* @since 3.16.0
|
||||
*/
|
||||
MAX_ZOOM: -1
|
||||
|
|
|
|||
|
|
@ -7,10 +7,8 @@
|
|||
/**
|
||||
* Filter Types.
|
||||
*
|
||||
* @name Phaser.Textures.FilterMode
|
||||
* @enum {integer}
|
||||
* @namespace Phaser.Textures.FilterMode
|
||||
* @memberof Phaser.Textures
|
||||
* @readonly
|
||||
* @since 3.0.0
|
||||
*/
|
||||
var CONST = {
|
||||
|
|
@ -19,6 +17,8 @@ var CONST = {
|
|||
* Linear filter type.
|
||||
*
|
||||
* @name Phaser.Textures.FilterMode.LINEAR
|
||||
* @type {integer}
|
||||
* @const
|
||||
* @since 3.0.0
|
||||
*/
|
||||
LINEAR: 0,
|
||||
|
|
@ -27,6 +27,8 @@ var CONST = {
|
|||
* Nearest neighbor filter type.
|
||||
*
|
||||
* @name Phaser.Textures.FilterMode.NEAREST
|
||||
* @type {integer}
|
||||
* @const
|
||||
* @since 3.0.0
|
||||
*/
|
||||
NEAREST: 1
|
||||
|
|
|
|||
Loading…
Reference in a new issue