mirror of
https://github.com/photonstorm/phaser
synced 2024-11-29 16:10:56 +00:00
Merge pull request #3432 from orblazer/fix-types
Fix nullable and multiple types
This commit is contained in:
commit
31bf979eb2
213 changed files with 740 additions and 742 deletions
|
@ -17,7 +17,7 @@ var PropertyValueInc = require('./PropertyValueInc');
|
|||
* @function Phaser.Actions.Angle
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {array|Phaser.GameObjects.GameObject[]} items - The array of items to be updated by this action.
|
||||
* @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.
|
||||
* @param {number} value - The amount to be added to the `angle` property.
|
||||
* @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter.
|
||||
* @param {integer} [index=0] - An optional offset to start searching from within the items array.
|
||||
|
|
|
@ -16,7 +16,7 @@
|
|||
* @function Phaser.Actions.Call
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {array|Phaser.GameObjects.GameObject[]} items - The array of items to be updated by this action.
|
||||
* @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.
|
||||
* @param {CallCallback} callback - The callback to be invoked. It will be passed just one argument: the item from the array.
|
||||
* @param {object} context - The scope in which the callback will be invoked.
|
||||
*
|
||||
|
|
|
@ -14,7 +14,7 @@
|
|||
* @function Phaser.Actions.GetFirst
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {array|Phaser.GameObjects.GameObject[]} items - The array of items to be searched by this action.
|
||||
* @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be searched by this action.
|
||||
* @param {object} compare - The comparison object. Each property in this object will be checked against the items of the array.
|
||||
* @param {integer} [index=0] - An optional offset to start searching from within the items array.
|
||||
*
|
||||
|
|
|
@ -14,7 +14,7 @@
|
|||
* @function Phaser.Actions.GetLast
|
||||
* @since 3.3.0
|
||||
*
|
||||
* @param {array|Phaser.GameObjects.GameObject[]} items - The array of items to be searched by this action.
|
||||
* @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be searched by this action.
|
||||
* @param {object} compare - The comparison object. Each property in this object will be checked against the items of the array.
|
||||
* @param {integer} [index=0] - An optional offset to start searching from within the items array.
|
||||
*
|
||||
|
|
|
@ -33,7 +33,7 @@ var tempZone = new Zone({ sys: { queueDepthSort: NOOP }}, 0, 0, 1, 1);
|
|||
* @function Phaser.Actions.GridAlign
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {array|Phaser.GameObjects.GameObject[]} items - The array of items to be updated by this action.
|
||||
* @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.
|
||||
* @param {GridAlignConfig} options - The GridAlign Configuration object.
|
||||
*
|
||||
* @return {array} The array of objects that were passed to this Action.
|
||||
|
|
|
@ -17,7 +17,7 @@ var PropertyValueInc = require('./PropertyValueInc');
|
|||
* @function Phaser.Actions.IncAlpha
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {array|Phaser.GameObjects.GameObject[]} items - The array of items to be updated by this action.
|
||||
* @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.
|
||||
* @param {number} value - The amount to be added to the `alpha` property.
|
||||
* @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter.
|
||||
* @param {integer} [index=0] - An optional offset to start searching from within the items array.
|
||||
|
|
|
@ -17,7 +17,7 @@ var PropertyValueInc = require('./PropertyValueInc');
|
|||
* @function Phaser.Actions.IncX
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {array|Phaser.GameObjects.GameObject[]} items - The array of items to be updated by this action.
|
||||
* @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.
|
||||
* @param {number} value - The amount to be added to the `x` property.
|
||||
* @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter.
|
||||
* @param {integer} [index=0] - An optional offset to start searching from within the items array.
|
||||
|
|
|
@ -17,9 +17,9 @@ var PropertyValueInc = require('./PropertyValueInc');
|
|||
* @function Phaser.Actions.IncXY
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {array|Phaser.GameObjects.GameObject[]} items - The array of items to be updated by this action.
|
||||
* @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.
|
||||
* @param {number} x - The amount to be added to the `x` property.
|
||||
* @param {number} [y] - The amount to be added to the `y` property. If `undefined` or `null` it uses the `x` value.
|
||||
* @param {number} [y=x] - The amount to be added to the `y` property. If `undefined` or `null` it uses the `x` value.
|
||||
* @param {number} [stepX=0] - This is added to the `x` amount, multiplied by the iteration counter.
|
||||
* @param {number} [stepY=0] - This is added to the `y` amount, multiplied by the iteration counter.
|
||||
* @param {integer} [index=0] - An optional offset to start searching from within the items array.
|
||||
|
|
|
@ -17,7 +17,7 @@ var PropertyValueInc = require('./PropertyValueInc');
|
|||
* @function Phaser.Actions.IncY
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {array|Phaser.GameObjects.GameObject[]} items - The array of items to be updated by this action.
|
||||
* @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.
|
||||
* @param {number} value - The amount to be added to the `y` property.
|
||||
* @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter.
|
||||
* @param {integer} [index=0] - An optional offset to start searching from within the items array.
|
||||
|
|
|
@ -10,7 +10,7 @@
|
|||
* @function Phaser.Actions.PlaceOnCircle
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {array} items - An array of Game Objects. The contents of this array are updated by this Action.
|
||||
* @param {(array|Phaser.GameObjects.GameObject[])} items - An array of Game Objects. The contents of this array are updated by this Action.
|
||||
* @param {Phaser.Geom.Circle} circle - [description]
|
||||
* @param {number} [startAngle=0] - [description]
|
||||
* @param {number} [endAngle=6.28] - [description]
|
||||
|
|
|
@ -10,7 +10,7 @@
|
|||
* @function Phaser.Actions.PlaceOnEllipse
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {array} items - An array of Game Objects. The contents of this array are updated by this Action.
|
||||
* @param {(array|Phaser.GameObjects.GameObject[])} items - An array of Game Objects. The contents of this array are updated by this Action.
|
||||
* @param {Phaser.Geom.Ellipse} ellipse - [description]
|
||||
* @param {number} [startAngle=0] - [description]
|
||||
* @param {number} [endAngle=6.28] - [description]
|
||||
|
|
|
@ -12,7 +12,7 @@ var GetPoints = require('../geom/line/GetPoints');
|
|||
* @function Phaser.Actions.PlaceOnLine
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {array} items - An array of Game Objects. The contents of this array are updated by this Action.
|
||||
* @param {(array|Phaser.GameObjects.GameObject[])} items - An array of Game Objects. The contents of this array are updated by this Action.
|
||||
* @param {Phaser.Geom.Line} line - [description]
|
||||
*
|
||||
* @return {array} The array of Game Objects that was passed to this Action.
|
||||
|
|
|
@ -20,7 +20,7 @@ var RotateRight = require('../utils/array/RotateRight');
|
|||
* @function Phaser.Actions.PlaceOnRectangle
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {array} items - An array of Game Objects. The contents of this array are updated by this Action.
|
||||
* @param {(array|Phaser.GameObjects.GameObject[])} items - An array of Game Objects. The contents of this array are updated by this Action.
|
||||
* @param {Phaser.Geom.Rectangle} rect - [description]
|
||||
* @param {integer} [shift=1] - [description]
|
||||
*
|
||||
|
|
|
@ -13,7 +13,7 @@ var BresenhamPoints = require('../geom/line/BresenhamPoints');
|
|||
* @function Phaser.Actions.PlaceOnTriangle
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {array} items - An array of Game Objects. The contents of this array are updated by this Action.
|
||||
* @param {(array|Phaser.GameObjects.GameObject[])} items - An array of Game Objects. The contents of this array are updated by this Action.
|
||||
* @param {Phaser.Geom.Triangle} triangle - [description]
|
||||
* @param {number} [stepRate=1] - [description]
|
||||
*
|
||||
|
|
|
@ -10,9 +10,9 @@
|
|||
* @function Phaser.Actions.PlayAnimation
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {array} items - An array of Game Objects. The contents of this array are updated by this Action.
|
||||
* @param {(array|Phaser.GameObjects.GameObject[])} items - An array of Game Objects. The contents of this array are updated by this Action.
|
||||
* @param {string} key - [description]
|
||||
* @param {string|integer} [startFrame] - [description]
|
||||
* @param {(string|integer)} [startFrame] - [description]
|
||||
*
|
||||
* @return {array} The array of Game Objects that was passed to this Action.
|
||||
*/
|
||||
|
|
|
@ -15,7 +15,7 @@
|
|||
* @function Phaser.Actions.PropertyValueInc
|
||||
* @since 3.3.0
|
||||
*
|
||||
* @param {array|Phaser.GameObjects.GameObject[]} items - The array of items to be updated by this action.
|
||||
* @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.
|
||||
* @param {string} key - The property to be updated.
|
||||
* @param {number} value - The amount to be added to the property.
|
||||
* @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter.
|
||||
|
|
|
@ -15,7 +15,7 @@
|
|||
* @function Phaser.Actions.PropertyValueSet
|
||||
* @since 3.3.0
|
||||
*
|
||||
* @param {array|Phaser.GameObjects.GameObject[]} items - The array of items to be updated by this action.
|
||||
* @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.
|
||||
* @param {string} key - The property to be updated.
|
||||
* @param {number} value - The amount to set the property to.
|
||||
* @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter.
|
||||
|
|
|
@ -12,7 +12,7 @@ var Random = require('../geom/circle/Random');
|
|||
* @function Phaser.Actions.RandomCircle
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {array} items - An array of Game Objects. The contents of this array are updated by this Action.
|
||||
* @param {(array|Phaser.GameObjects.GameObject[])} items - An array of Game Objects. The contents of this array are updated by this Action.
|
||||
* @param {Phaser.Geom.Circle} circle - [description]
|
||||
*
|
||||
* @return {array} The array of Game Objects that was passed to this Action.
|
||||
|
|
|
@ -12,7 +12,7 @@ var Random = require('../geom/ellipse/Random');
|
|||
* @function Phaser.Actions.RandomEllipse
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {array} items - An array of Game Objects. The contents of this array are updated by this Action.
|
||||
* @param {(array|Phaser.GameObjects.GameObject[])} items - An array of Game Objects. The contents of this array are updated by this Action.
|
||||
* @param {Phaser.Geom.Ellipse} ellipse - [description]
|
||||
*
|
||||
* @return {array} The array of Game Objects that was passed to this Action.
|
||||
|
|
|
@ -12,7 +12,7 @@ var Random = require('../geom/line/Random');
|
|||
* @function Phaser.Actions.RandomLine
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {array} items - An array of Game Objects. The contents of this array are updated by this Action.
|
||||
* @param {(array|Phaser.GameObjects.GameObject[])} items - An array of Game Objects. The contents of this array are updated by this Action.
|
||||
* @param {Phaser.Geom.Line} line - [description]
|
||||
*
|
||||
* @return {array} The array of Game Objects that was passed to this Action.
|
||||
|
|
|
@ -12,7 +12,7 @@ var Random = require('../geom/rectangle/Random');
|
|||
* @function Phaser.Actions.RandomRectangle
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {array} items - An array of Game Objects. The contents of this array are updated by this Action.
|
||||
* @param {(array|Phaser.GameObjects.GameObject[])} items - An array of Game Objects. The contents of this array are updated by this Action.
|
||||
* @param {Phaser.Geom.Rectangle} rect - [description]
|
||||
*
|
||||
* @return {array} The array of Game Objects that was passed to this Action.
|
||||
|
|
|
@ -12,7 +12,7 @@ var Random = require('../geom/triangle/Random');
|
|||
* @function Phaser.Actions.RandomTriangle
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {array} items - An array of Game Objects. The contents of this array are updated by this Action.
|
||||
* @param {(array|Phaser.GameObjects.GameObject[])} items - An array of Game Objects. The contents of this array are updated by this Action.
|
||||
* @param {Phaser.Geom.Triangle} triangle - [description]
|
||||
*
|
||||
* @return {array} The array of Game Objects that was passed to this Action.
|
||||
|
|
|
@ -17,7 +17,7 @@ var PropertyValueInc = require('./PropertyValueInc');
|
|||
* @function Phaser.Actions.Rotate
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {array|Phaser.GameObjects.GameObject[]} items - The array of items to be updated by this action.
|
||||
* @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.
|
||||
* @param {number} value - The amount to be added to the `rotation` property (in radians).
|
||||
* @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter.
|
||||
* @param {integer} [index=0] - An optional offset to start searching from within the items array.
|
||||
|
|
|
@ -13,7 +13,7 @@ var DistanceBetween = require('../math/distance/DistanceBetween');
|
|||
* @function Phaser.Actions.RotateAround
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {array} items - An array of Game Objects. The contents of this array are updated by this Action.
|
||||
* @param {(array|Phaser.GameObjects.GameObject[])} items - An array of Game Objects. The contents of this array are updated by this Action.
|
||||
* @param {object} point - Any object with public `x` and `y` properties.
|
||||
* @param {number} angle - The angle to rotate by, in radians.
|
||||
*
|
||||
|
|
|
@ -12,7 +12,7 @@ var MathRotateAroundDistance = require('../math/RotateAroundDistance');
|
|||
* @function Phaser.Actions.RotateAroundDistance
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {array} items - An array of Game Objects. The contents of this array are updated by this Action.
|
||||
* @param {(array|Phaser.GameObjects.GameObject[])} items - An array of Game Objects. The contents of this array are updated by this Action.
|
||||
* @param {object} point - Any object with public `x` and `y` properties.
|
||||
* @param {number} angle - The angle to rotate by, in radians.
|
||||
* @param {number} distance - The distance from the point of rotation in pixels.
|
||||
|
|
|
@ -17,7 +17,7 @@ var PropertyValueInc = require('./PropertyValueInc');
|
|||
* @function Phaser.Actions.ScaleX
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {array|Phaser.GameObjects.GameObject[]} items - The array of items to be updated by this action.
|
||||
* @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.
|
||||
* @param {number} value - The amount to be added to the `scaleX` property.
|
||||
* @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter.
|
||||
* @param {integer} [index=0] - An optional offset to start searching from within the items array.
|
||||
|
|
|
@ -17,7 +17,7 @@ var PropertyValueInc = require('./PropertyValueInc');
|
|||
* @function Phaser.Actions.ScaleXY
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {array|Phaser.GameObjects.GameObject[]} items - The array of items to be updated by this action.
|
||||
* @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.
|
||||
* @param {number} scaleX - The amount to be added to the `scaleX` property.
|
||||
* @param {number} [scaleY] - The amount to be added to the `scaleY` property. If `undefined` or `null` it uses the `scaleX` value.
|
||||
* @param {number} [stepX=0] - This is added to the `scaleX` amount, multiplied by the iteration counter.
|
||||
|
|
|
@ -17,7 +17,7 @@ var PropertyValueInc = require('./PropertyValueInc');
|
|||
* @function Phaser.Actions.ScaleY
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {array|Phaser.GameObjects.GameObject[]} items - The array of items to be updated by this action.
|
||||
* @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.
|
||||
* @param {number} value - The amount to be added to the `scaleY` property.
|
||||
* @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter.
|
||||
* @param {integer} [index=0] - An optional offset to start searching from within the items array.
|
||||
|
|
|
@ -17,7 +17,7 @@ var PropertyValueSet = require('./PropertyValueSet');
|
|||
* @function Phaser.Actions.SetAlpha
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {array|Phaser.GameObjects.GameObject[]} items - The array of items to be updated by this action.
|
||||
* @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.
|
||||
* @param {number} value - The amount to set the property to.
|
||||
* @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter.
|
||||
* @param {integer} [index=0] - An optional offset to start searching from within the items array.
|
||||
|
|
|
@ -17,7 +17,7 @@ var PropertyValueSet = require('./PropertyValueSet');
|
|||
* @function Phaser.Actions.SetBlendMode
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {array|Phaser.GameObjects.GameObject[]} items - The array of items to be updated by this action.
|
||||
* @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.
|
||||
* @param {number} value - The amount to set the property to.
|
||||
* @param {integer} [index=0] - An optional offset to start searching from within the items array.
|
||||
* @param {integer} [direction=1] - The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.
|
||||
|
|
|
@ -17,7 +17,7 @@ var PropertyValueSet = require('./PropertyValueSet');
|
|||
* @function Phaser.Actions.SetDepth
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {array|Phaser.GameObjects.GameObject[]} items - The array of items to be updated by this action.
|
||||
* @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.
|
||||
* @param {number} value - The amount to set the property to.
|
||||
* @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter.
|
||||
* @param {integer} [index=0] - An optional offset to start searching from within the items array.
|
||||
|
|
|
@ -10,7 +10,7 @@
|
|||
* @function Phaser.Actions.SetHitArea
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {array} items - An array of Game Objects. The contents of this array are updated by this Action.
|
||||
* @param {(array|Phaser.GameObjects.GameObject[])} items - An array of Game Objects. The contents of this array are updated by this Action.
|
||||
* @param {any} hitArea - [description]
|
||||
* @param {HitAreaCallback} hitAreaCallback - [description]
|
||||
*
|
||||
|
|
|
@ -17,7 +17,7 @@ var PropertyValueSet = require('./PropertyValueSet');
|
|||
* @function Phaser.Actions.SetOrigin
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {array|Phaser.GameObjects.GameObject[]} items - The array of items to be updated by this action.
|
||||
* @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.
|
||||
* @param {number} originX - The amount to set the `originX` property to.
|
||||
* @param {number} [originY] - The amount to set the `originY` property to. If `undefined` or `null` it uses the `originX` value.
|
||||
* @param {number} [stepX=0] - This is added to the `originX` amount, multiplied by the iteration counter.
|
||||
|
|
|
@ -17,7 +17,7 @@ var PropertyValueSet = require('./PropertyValueSet');
|
|||
* @function Phaser.Actions.SetRotation
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {array|Phaser.GameObjects.GameObject[]} items - The array of items to be updated by this action.
|
||||
* @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.
|
||||
* @param {number} value - The amount to set the property to.
|
||||
* @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter.
|
||||
* @param {integer} [index=0] - An optional offset to start searching from within the items array.
|
||||
|
|
|
@ -17,7 +17,7 @@ var PropertyValueSet = require('./PropertyValueSet');
|
|||
* @function Phaser.Actions.SetScale
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {array|Phaser.GameObjects.GameObject[]} items - The array of items to be updated by this action.
|
||||
* @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.
|
||||
* @param {number} scaleX - The amount to set the `scaleX` property to.
|
||||
* @param {number} [scaleY] - The amount to set the `scaleY` property to. If `undefined` or `null` it uses the `scaleX` value.
|
||||
* @param {number} [stepX=0] - This is added to the `scaleX` amount, multiplied by the iteration counter.
|
||||
|
|
|
@ -17,7 +17,7 @@ var PropertyValueSet = require('./PropertyValueSet');
|
|||
* @function Phaser.Actions.SetScaleX
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {array|Phaser.GameObjects.GameObject[]} items - The array of items to be updated by this action.
|
||||
* @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.
|
||||
* @param {number} value - The amount to set the property to.
|
||||
* @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter.
|
||||
* @param {integer} [index=0] - An optional offset to start searching from within the items array.
|
||||
|
|
|
@ -17,7 +17,7 @@ var PropertyValueSet = require('./PropertyValueSet');
|
|||
* @function Phaser.Actions.SetScaleY
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {array|Phaser.GameObjects.GameObject[]} items - The array of items to be updated by this action.
|
||||
* @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.
|
||||
* @param {number} value - The amount to set the property to.
|
||||
* @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter.
|
||||
* @param {integer} [index=0] - An optional offset to start searching from within the items array.
|
||||
|
|
|
@ -10,7 +10,7 @@
|
|||
* @function Phaser.Actions.SetTint
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {array} items - An array of Game Objects. The contents of this array are updated by this Action.
|
||||
* @param {(array|Phaser.GameObjects.GameObject[])} items - An array of Game Objects. The contents of this array are updated by this Action.
|
||||
* @param {number} topLeft - [description]
|
||||
* @param {number} [topRight] - [description]
|
||||
* @param {number} [bottomLeft] - [description]
|
||||
|
|
|
@ -15,7 +15,7 @@ var PropertyValueSet = require('./PropertyValueSet');
|
|||
* @function Phaser.Actions.SetVisible
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {array|Phaser.GameObjects.GameObject[]} items - The array of items to be updated by this action.
|
||||
* @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.
|
||||
* @param {boolean} value - The value to set the property to.
|
||||
* @param {integer} [index=0] - An optional offset to start searching from within the items array.
|
||||
* @param {integer} [direction=1] - The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.
|
||||
|
|
|
@ -17,7 +17,7 @@ var PropertyValueSet = require('./PropertyValueSet');
|
|||
* @function Phaser.Actions.SetX
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {array|Phaser.GameObjects.GameObject[]} items - The array of items to be updated by this action.
|
||||
* @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.
|
||||
* @param {number} value - The amount to set the property to.
|
||||
* @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter.
|
||||
* @param {integer} [index=0] - An optional offset to start searching from within the items array.
|
||||
|
|
|
@ -17,9 +17,9 @@ var PropertyValueSet = require('./PropertyValueSet');
|
|||
* @function Phaser.Actions.SetXY
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {array|Phaser.GameObjects.GameObject[]} items - The array of items to be updated by this action.
|
||||
* @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.
|
||||
* @param {number} x - The amount to set the `x` property to.
|
||||
* @param {number} [y] - The amount to set the `y` property to. If `undefined` or `null` it uses the `x` value.
|
||||
* @param {number} [y=x] - The amount to set the `y` property to. If `undefined` or `null` it uses the `x` value.
|
||||
* @param {number} [stepX=0] - This is added to the `x` amount, multiplied by the iteration counter.
|
||||
* @param {number} [stepY=0] - This is added to the `y` amount, multiplied by the iteration counter.
|
||||
* @param {integer} [index=0] - An optional offset to start searching from within the items array.
|
||||
|
|
|
@ -17,7 +17,7 @@ var PropertyValueSet = require('./PropertyValueSet');
|
|||
* @function Phaser.Actions.SetY
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {array|Phaser.GameObjects.GameObject[]} items - The array of items to be updated by this action.
|
||||
* @param {(array|Phaser.GameObjects.GameObject[])} items - The array of items to be updated by this action.
|
||||
* @param {number} value - The amount to set the property to.
|
||||
* @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter.
|
||||
* @param {integer} [index=0] - An optional offset to start searching from within the items array.
|
||||
|
|
|
@ -6,22 +6,20 @@
|
|||
|
||||
var Vector2 = require('../math/Vector2');
|
||||
|
||||
// Iterate through items changing the position of each element to
|
||||
// be that of the element that came before it in the array (or after it if direction = 1)
|
||||
// The first items position is set to x/y.
|
||||
// The final x/y coords are returned
|
||||
|
||||
/**
|
||||
* [description]
|
||||
* Iterate through items changing the position of each element to
|
||||
* be that of the element that came before it in the array (or after it if direction = 1)
|
||||
* The first items position is set to x/y.
|
||||
* The final x/y coords are returned
|
||||
*
|
||||
* @function Phaser.Actions.ShiftPosition
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {array} items - An array of Game Objects. The contents of this array are updated by this Action.
|
||||
* @param {(array|Phaser.GameObjects.GameObject[])} items - An array of Game Objects. The contents of this array are updated by this Action.
|
||||
* @param {number} x - [description]
|
||||
* @param {number} y - [description]
|
||||
* @param {integer} [direction=0] - [description]
|
||||
* @param {Phaser.Math.Vector2|object} [output] - [description]
|
||||
* @param {(Phaser.Math.Vector2|object)} [output] - [description]
|
||||
*
|
||||
* @return {Phaser.Math.Vector2} The output vector.
|
||||
*/
|
||||
|
|
|
@ -12,7 +12,7 @@ var ArrayShuffle = require('../utils/array/Shuffle');
|
|||
* @function Phaser.Actions.Shuffle
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {array} items - An array of Game Objects. The contents of this array are updated by this Action.
|
||||
* @param {(array|Phaser.GameObjects.GameObject[])} items - An array of Game Objects. The contents of this array are updated by this Action.
|
||||
*
|
||||
* @return {array} The array of Game Objects that was passed to this Action.
|
||||
*/
|
||||
|
|
|
@ -12,7 +12,7 @@ var MathSmoothStep = require('../math/SmoothStep');
|
|||
* @function Phaser.Actions.SmoothStep
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {array} items - An array of Game Objects. The contents of this array are updated by this Action.
|
||||
* @param {(array|Phaser.GameObjects.GameObject[])} items - An array of Game Objects. The contents of this array are updated by this Action.
|
||||
* @param {string} property - [description]
|
||||
* @param {number} min - [description]
|
||||
* @param {number} max - [description]
|
||||
|
|
|
@ -12,7 +12,7 @@ var MathSmootherStep = require('../math/SmootherStep');
|
|||
* @function Phaser.Actions.SmootherStep
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {array} items - An array of Game Objects. The contents of this array are updated by this Action.
|
||||
* @param {(array|Phaser.GameObjects.GameObject[])} items - An array of Game Objects. The contents of this array are updated by this Action.
|
||||
* @param {string} property - [description]
|
||||
* @param {number} min - [description]
|
||||
* @param {number} max - [description]
|
||||
|
|
|
@ -10,11 +10,11 @@
|
|||
* @function Phaser.Actions.Spread
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {array} items - An array of Game Objects. The contents of this array are updated by this Action.
|
||||
* @param {(array|Phaser.GameObjects.GameObject[])} items - An array of Game Objects. The contents of this array are updated by this Action.
|
||||
* @param {string} property - [description]
|
||||
* @param {number} min - [description]
|
||||
* @param {number} max - [description]
|
||||
* @param {number} inc - [description]
|
||||
* @param {number} [inc=false] - [description]
|
||||
*
|
||||
* @return {array} The array of Game Objects that was passed to this Action.
|
||||
*/
|
||||
|
|
|
@ -10,7 +10,7 @@
|
|||
* @function Phaser.Actions.ToggleVisible
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {array} items - An array of Game Objects. The contents of this array are updated by this Action.
|
||||
* @param {(array|Phaser.GameObjects.GameObject[])} items - An array of Game Objects. The contents of this array are updated by this Action.
|
||||
*
|
||||
* @return {array} The array of Game Objects that was passed to this Action.
|
||||
*/
|
||||
|
|
|
@ -11,10 +11,10 @@ var Wrap = require('../math/Wrap');
|
|||
* Wrap each item's coordinates within a rectangle's area.
|
||||
*
|
||||
* @function Phaser.Actions.WrapInRectangle
|
||||
* @since [version]
|
||||
* @since 3.0.0
|
||||
* @see Phaser.Math.Wrap
|
||||
*
|
||||
* @param {array} items - An array of Game Objects. The contents of this array are updated by this Action.
|
||||
* @param {(array|Phaser.GameObjects.GameObject[])} items - An array of Game Objects. The contents of this array are updated by this Action.
|
||||
* @param {Phaser.Geom.Rectangle} rect - The rectangle.
|
||||
* @param {number} [padding=0] - An amount added to each side of the rectangle during the operation.
|
||||
*
|
||||
|
|
|
@ -29,7 +29,7 @@ var GetValue = require('../utils/object/GetValue');
|
|||
* @typedef {object} AnimationFrameConfig
|
||||
*
|
||||
* @property {string} key - [description]
|
||||
* @property {string|number} frame - [description]
|
||||
* @property {(string|number)} frame - [description]
|
||||
* @property {float} [duration=0] - [description]
|
||||
* @property {boolean} [visible] - [description]
|
||||
* @property {function} [onUpdate] - [description]
|
||||
|
@ -350,7 +350,7 @@ var Animation = new Class({
|
|||
* @method Phaser.Animations.Animation#addFrame
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {string|AnimationFrameConfig[]} config - [description]
|
||||
* @param {(string|AnimationFrameConfig[])} config - [description]
|
||||
*
|
||||
* @return {Phaser.Animations.Animation} This Animation object.
|
||||
*/
|
||||
|
@ -368,7 +368,7 @@ var Animation = new Class({
|
|||
* @since 3.0.0
|
||||
*
|
||||
* @param {integer} index - [description]
|
||||
* @param {string|AnimationFrameConfig[]} config - [description]
|
||||
* @param {(string|AnimationFrameConfig[])} config - [description]
|
||||
*
|
||||
* @return {Phaser.Animations.Animation} This Animation object.
|
||||
*/
|
||||
|
@ -478,7 +478,7 @@ var Animation = new Class({
|
|||
* @since 3.0.0
|
||||
*
|
||||
* @param {Phaser.Textures.TextureManager} textureManager - [description]
|
||||
* @param {string|AnimationFrameConfig[]} frames - [description]
|
||||
* @param {(string|AnimationFrameConfig[])} frames - [description]
|
||||
* @param {string} [defaultTextureKey] - [description]
|
||||
*
|
||||
* @return {Phaser.Animations.AnimationFrame[]} [description]
|
||||
|
|
|
@ -10,7 +10,7 @@ var Class = require('../utils/Class');
|
|||
* @typedef {object} JSONAnimationFrame
|
||||
*
|
||||
* @property {string} key - The key of the Texture this AnimationFrame uses.
|
||||
* @property {string|integer} frame - The key of the Frame within the Texture that this AnimationFrame uses.
|
||||
* @property {(string|integer)} frame - The key of the Frame within the Texture that this AnimationFrame uses.
|
||||
* @property {number} duration - Additional time (in ms) that this frame should appear for during playback.
|
||||
*/
|
||||
|
||||
|
@ -30,7 +30,7 @@ var Class = require('../utils/Class');
|
|||
* @since 3.0.0
|
||||
*
|
||||
* @param {string} textureKey - The key of the Texture this AnimationFrame uses.
|
||||
* @param {string|integer} textureFrame - The key of the Frame within the Texture that this AnimationFrame uses.
|
||||
* @param {(string|integer)} textureFrame - The key of the Frame within the Texture that this AnimationFrame uses.
|
||||
* @param {integer} index - The index of this AnimationFrame within the Animation sequence.
|
||||
* @param {Phaser.Textures.Frame} frame - A reference to the Texture Frame this AnimationFrame uses for rendering.
|
||||
*/
|
||||
|
@ -53,7 +53,7 @@ var AnimationFrame = new Class({
|
|||
* The key of the Frame within the Texture that this AnimationFrame uses.
|
||||
*
|
||||
* @name Phaser.Animations.AnimationFrame#textureFrame
|
||||
* @type {string|integer}
|
||||
* @type {(string|integer)}
|
||||
* @since 3.0.0
|
||||
*/
|
||||
this.textureFrame = textureFrame;
|
||||
|
|
|
@ -186,7 +186,7 @@ var AnimationManager = new Class({
|
|||
* @method Phaser.Animations.AnimationManager#fromJSON
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {string|object} data - [description]
|
||||
* @param {(string|object)} data - [description]
|
||||
* @param {boolean} [clearCurrentAnimations=false] - [description]
|
||||
*
|
||||
* @return {Phaser.Animations.Animation[]} An array containing all of the Animation objects that were created as a result of this call.
|
||||
|
@ -394,7 +394,7 @@ var AnimationManager = new Class({
|
|||
*
|
||||
* @param {Phaser.GameObjects.GameObject} child - [description]
|
||||
* @param {string} key - [description]
|
||||
* @param {string|integer} [startFrame] - [description]
|
||||
* @param {(string|integer)} [startFrame] - [description]
|
||||
*
|
||||
* @return {Phaser.GameObjects.GameObject} [description]
|
||||
*/
|
||||
|
|
|
@ -41,7 +41,7 @@ var ValueToColor = require('../display/color/ValueToColor');
|
|||
* @property {string} [path] - [description]
|
||||
* @property {boolean} [enableParallel=true] - [description]
|
||||
* @property {integer} [maxParallelDownloads=4] - [description]
|
||||
* @property {string|undefined} [crossOrigin=undefined] - [description]
|
||||
* @property {(string|undefined)} [crossOrigin=undefined] - [description]
|
||||
* @property {string} [responseType] - [description]
|
||||
* @property {boolean} [async=true] - [description]
|
||||
* @property {string} [user] - [description]
|
||||
|
@ -52,8 +52,8 @@ var ValueToColor = require('../display/color/ValueToColor');
|
|||
/**
|
||||
* @typedef {object} GameConfig
|
||||
*
|
||||
* @property {integer|string} [width=1024] - [description]
|
||||
* @property {integer|string} [height=768] - [description]
|
||||
* @property {(integer|string)} [width=1024] - [description]
|
||||
* @property {(integer|string)} [height=768] - [description]
|
||||
* @property {number} [zoom=1] - [description]
|
||||
* @property {number} [resolution=1] - [description]
|
||||
* @property {number} [type=CONST.AUTO] - [description]
|
||||
|
@ -90,7 +90,7 @@ var ValueToColor = require('../display/color/ValueToColor');
|
|||
* @property {boolean} [preserveDrawingBuffer=false] - [description]
|
||||
* @property {boolean} [failIfMajorPerformanceCaveat=false] - [description]
|
||||
* @property {boolean} [powerPreference='default'] - "high-performance", "low-power" or "default"
|
||||
* @property {string|number} [backgroundColor=0x000000] - [description]
|
||||
* @property {(string|number)} [backgroundColor=0x000000] - [description]
|
||||
* @property {object} [?callbacks] - [description]
|
||||
* @property {BootCallback} [callbacks.preBoot=NOOP] - [description]
|
||||
* @property {BootCallback} [callbacks.postBoot=NOOP] - [description]
|
||||
|
|
|
@ -68,7 +68,7 @@ var Game = new Class({
|
|||
* A reference to either the Canvas or WebGL Renderer that this Game is using.
|
||||
*
|
||||
* @name Phaser.Game#renderer
|
||||
* @type {Phaser.Renderer.Canvas.CanvasRenderer|Phaser.Renderer.WebGL.WebGLRenderer}
|
||||
* @type {(Phaser.Renderer.Canvas.CanvasRenderer|Phaser.Renderer.WebGL.WebGLRenderer)}
|
||||
* @since 3.0.0
|
||||
*/
|
||||
this.renderer = null;
|
||||
|
@ -323,7 +323,7 @@ var Game = new Class({
|
|||
* the Scenes for rendering, but it won't have actually drawn anything yet.
|
||||
*
|
||||
* @event Phaser.Game#prerenderEvent
|
||||
* @param {Phaser.Renderer.CanvasRenderer|Phaser.Renderer.WebGLRenderer} renderer - A reference to the current renderer.
|
||||
* @param {(Phaser.Renderer.CanvasRenderer|Phaser.Renderer.WebGLRenderer)} renderer - A reference to the current renderer.
|
||||
*/
|
||||
|
||||
/**
|
||||
|
@ -333,7 +333,7 @@ var Game = new Class({
|
|||
* Every Scene will have rendered and drawn to the canvas.
|
||||
*
|
||||
* @event Phaser.Game#postrenderEvent
|
||||
* @param {Phaser.Renderer.CanvasRenderer|Phaser.Renderer.WebGLRenderer} renderer - A reference to the current renderer.
|
||||
* @param {(Phaser.Renderer.CanvasRenderer|Phaser.Renderer.WebGLRenderer)} renderer - A reference to the current renderer.
|
||||
*/
|
||||
|
||||
/**
|
||||
|
|
|
@ -874,7 +874,7 @@ var Camera = new Class({
|
|||
*
|
||||
* @param {number} x - [description]
|
||||
* @param {number} y - [description]
|
||||
* @param {object|Phaser.Math.Vector2} output - [description]
|
||||
* @param {(object|Phaser.Math.Vector2)} output - [description]
|
||||
*
|
||||
* @return {Phaser.Math.Vector2} [description]
|
||||
*/
|
||||
|
@ -935,7 +935,7 @@ var Camera = new Class({
|
|||
* @method Phaser.Cameras.Scene2D.Camera#ignore
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {Phaser.GameObjects.GameObject|Phaser.GameObjects.GameObject[]} gameObjectOrArray - [description]
|
||||
* @param {(Phaser.GameObjects.GameObject|Phaser.GameObjects.GameObject[])} gameObjectOrArray - [description]
|
||||
*
|
||||
* @return {Phaser.Cameras.Scene2D.Camera} This Camera instance.
|
||||
*/
|
||||
|
@ -1068,7 +1068,7 @@ var Camera = new Class({
|
|||
* @method Phaser.Cameras.Scene2D.Camera#setBackgroundColor
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {string|number|InputColorObject} color - [description]
|
||||
* @param {(string|number|InputColorObject)} color - [description]
|
||||
*
|
||||
* @return {Phaser.Cameras.Scene2D.Camera} This Camera instance.
|
||||
*/
|
||||
|
@ -1288,7 +1288,7 @@ var Camera = new Class({
|
|||
* @method Phaser.Cameras.Scene2D.Camera#startFollow
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {Phaser.GameObjects.GameObject|object} target - [description]
|
||||
* @param {(Phaser.GameObjects.GameObject|object)} target - [description]
|
||||
* @param {boolean} roundPx - [description]
|
||||
*
|
||||
* @return {Phaser.Cameras.Scene2D.Camera} This Camera instance.
|
||||
|
|
|
@ -236,7 +236,7 @@ var CameraManager = new Class({
|
|||
* @method Phaser.Cameras.Scene2D.CameraManager#fromJSON
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {object|object[]} config - [description]
|
||||
* @param {(object|object[])} config - [description]
|
||||
*
|
||||
* @return {Phaser.Cameras.Scene2D.CameraManager} [description]
|
||||
*/
|
||||
|
@ -375,7 +375,7 @@ var CameraManager = new Class({
|
|||
* @method Phaser.Cameras.Scene2D.CameraManager#render
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {Phaser.Renderer.Canvas.CanvasRenderer|Phaser.Renderer.WebGL.WebGLRenderer} renderer - The Renderer that will render the children to this camera.
|
||||
* @param {(Phaser.Renderer.Canvas.CanvasRenderer|Phaser.Renderer.WebGL.WebGLRenderer)} renderer - The Renderer that will render the children to this camera.
|
||||
* @param {Phaser.GameObjects.GameObject[]} children - An array of renderable Game Objects.
|
||||
* @param {number} interpolation - Interpolation value. Reserved for future use.
|
||||
*/
|
||||
|
|
|
@ -24,7 +24,7 @@ var GetValue = require('../../utils/object/GetValue');
|
|||
* @property {Phaser.Input.Keyboard.Key} [zoomIn] - The Key to be pressed that will zoom the Camera in.
|
||||
* @property {Phaser.Input.Keyboard.Key} [zoomOut] - The Key to be pressed that will zoom the Camera out.
|
||||
* @property {float} [zoomSpeed=0.01] - The speed at which the camera will zoom if the `zoomIn` or `zoomOut` keys are pressed.
|
||||
* @property {float|{x:float,y:float}} [speed=0] - The horizontal and vertical speed the camera will move.
|
||||
* @property {(float|{x:float,y:float})} [speed=0] - The horizontal and vertical speed the camera will move.
|
||||
*/
|
||||
|
||||
/**
|
||||
|
|
|
@ -31,9 +31,9 @@ var GetValue = require('../../utils/object/GetValue');
|
|||
* @property {Phaser.Input.Keyboard.Key} [zoomIn] - The Key to be pressed that will zoom the Camera in.
|
||||
* @property {Phaser.Input.Keyboard.Key} [zoomOut] - The Key to be pressed that will zoom the Camera out.
|
||||
* @property {float} [zoomSpeed=0.01] - The speed at which the camera will zoom if the `zoomIn` or `zoomOut` keys are pressed.
|
||||
* @property {float|{x:float,y:float}} [acceleration=0] - The horizontal and vertical acceleration the camera will move.
|
||||
* @property {float|{x:float,y:float}} [drag=0] - The horizontal and vertical drag applied to the camera when it is moving.
|
||||
* @property {float|{x:float,y:float}} [maxSpeed=0] - The maximum horizontal and vertical speed the camera will move.
|
||||
* @property {(float|{x:float,y:float})} [acceleration=0] - The horizontal and vertical acceleration the camera will move.
|
||||
* @property {(float|{x:float,y:float})} [drag=0] - The horizontal and vertical drag applied to the camera when it is moving.
|
||||
* @property {(float|{x:float,y:float})} [maxSpeed=0] - The maximum horizontal and vertical speed the camera will move.
|
||||
*/
|
||||
|
||||
/**
|
||||
|
|
|
@ -368,7 +368,7 @@ var Camera = new Class({
|
|||
* @param {number} y - [description]
|
||||
* @param {number} z - [description]
|
||||
* @param {string} key - [description]
|
||||
* @param {string|number} frame - [description]
|
||||
* @param {(string|number)} frame - [description]
|
||||
* @param {boolean} [visible=true] - [description]
|
||||
*
|
||||
* @return {Phaser.GameObjects.Sprite3D} [description]
|
||||
|
@ -399,7 +399,7 @@ var Camera = new Class({
|
|||
*
|
||||
* @param {number} quantity - [description]
|
||||
* @param {string} key - [description]
|
||||
* @param {string|number} frame - [description]
|
||||
* @param {(string|number)} frame - [description]
|
||||
* @param {boolean} [visible=true] - [description]
|
||||
*
|
||||
* @return {Phaser.GameObjects.Sprite3D[]} [description]
|
||||
|
@ -435,10 +435,10 @@ var Camera = new Class({
|
|||
* @method Phaser.Cameras.Sprite3D.Camera#createRect
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {number|{x:number,y:number}} size - [description]
|
||||
* @param {number|{x:number,y:number,z:number}} spacing - [description]
|
||||
* @param {(number|{x:number,y:number})} size - [description]
|
||||
* @param {(number|{x:number,y:number,z:number})} spacing - [description]
|
||||
* @param {string} key - [description]
|
||||
* @param {string|number} [frame] - [description]
|
||||
* @param {(string|number)} [frame] - [description]
|
||||
*
|
||||
* @return {Phaser.GameObjects.Sprite3D[]} [description]
|
||||
*/
|
||||
|
@ -595,7 +595,7 @@ var Camera = new Class({
|
|||
* @method Phaser.Cameras.Sprite3D.Camera#translate
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {number|object} x - [description]
|
||||
* @param {(number|object)} x - [description]
|
||||
* @param {number} [y] - [description]
|
||||
* @param {number} [z] - [description]
|
||||
*
|
||||
|
@ -625,7 +625,7 @@ var Camera = new Class({
|
|||
* @method Phaser.Cameras.Sprite3D.Camera#lookAt
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {number|object} x - [description]
|
||||
* @param {(number|object)} x - [description]
|
||||
* @param {number} [y] - [description]
|
||||
* @param {number} [z] - [description]
|
||||
*
|
||||
|
|
|
@ -151,7 +151,7 @@ var CameraManager = new Class({
|
|||
*
|
||||
* @param {string} name - [description]
|
||||
*
|
||||
* @return {Phaser.Cameras.Sprite3D.OrthographicCamera|Phaser.Cameras.Sprite3D.PerspectiveCamera} [description]
|
||||
* @return {(Phaser.Cameras.Sprite3D.OrthographicCamera|Phaser.Cameras.Sprite3D.PerspectiveCamera)} [description]
|
||||
*/
|
||||
getCamera: function (name)
|
||||
{
|
||||
|
@ -172,7 +172,7 @@ var CameraManager = new Class({
|
|||
* @method Phaser.Cameras.Sprite3D.CameraManager#removeCamera
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {Phaser.Cameras.Sprite3D.OrthographicCamera|Phaser.Cameras.Sprite3D.PerspectiveCamera} camera - [description]
|
||||
* @param {(Phaser.Cameras.Sprite3D.OrthographicCamera|Phaser.Cameras.Sprite3D.PerspectiveCamera)} camera - [description]
|
||||
*/
|
||||
removeCamera: function (camera)
|
||||
{
|
||||
|
@ -190,7 +190,7 @@ var CameraManager = new Class({
|
|||
* @method Phaser.Cameras.Sprite3D.CameraManager#removeAll
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @return {Phaser.Cameras.Sprite3D.OrthographicCamera|Phaser.Cameras.Sprite3D.PerspectiveCamera} [description]
|
||||
* @return {(Phaser.Cameras.Sprite3D.OrthographicCamera|Phaser.Cameras.Sprite3D.PerspectiveCamera)} [description]
|
||||
*/
|
||||
removeAll: function ()
|
||||
{
|
||||
|
|
|
@ -21,7 +21,7 @@ var Vector2 = require('../math/Vector2');
|
|||
* @constructor
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {Phaser.Math.Vector2|Phaser.Math.Vector2[]} p0 - Start point, or an array of point pairs.
|
||||
* @param {(Phaser.Math.Vector2|Phaser.Math.Vector2[])} p0 - Start point, or an array of point pairs.
|
||||
* @param {Phaser.Math.Vector2} p1 - Control Point 1.
|
||||
* @param {Phaser.Math.Vector2} p2 - Control Point 2.
|
||||
* @param {Phaser.Math.Vector2} p3 - End Point.
|
||||
|
|
|
@ -19,7 +19,7 @@ var Vector2 = require('../math/Vector2');
|
|||
* @constructor
|
||||
* @since 3.2.0
|
||||
*
|
||||
* @param {Phaser.Math.Vector2|Phaser.Math.Vector2[]} p0 - Start point, or an array of point pairs.
|
||||
* @param {(Phaser.Math.Vector2|Phaser.Math.Vector2[])} p0 - Start point, or an array of point pairs.
|
||||
* @param {Phaser.Math.Vector2} p1 - Control Point 1.
|
||||
* @param {Phaser.Math.Vector2} p2 - Control Point 2.
|
||||
*/
|
||||
|
|
|
@ -235,7 +235,7 @@ var Path = new Class({
|
|||
* @method Phaser.Curves.Path#quadraticBezierTo
|
||||
* @since 3.2.0
|
||||
*
|
||||
* @param {number|Phaser.Math.Vector2[]} x - [description]
|
||||
* @param {(number|Phaser.Math.Vector2[])} x - [description]
|
||||
* @param {number} [y] - [description]
|
||||
* @param {number} [controlX] - [description]
|
||||
* @param {number} [controlY] - [description]
|
||||
|
@ -516,7 +516,7 @@ var Path = new Class({
|
|||
* @param {number} t - [description]
|
||||
* @param {Phaser.Math.Vector2} [out] - [description]
|
||||
*
|
||||
* @return {Phaser.Math.Vector2|null} [description]
|
||||
* @return {?Phaser.Math.Vector2} [description]
|
||||
*/
|
||||
getPoint: function (t, out)
|
||||
{
|
||||
|
@ -671,7 +671,7 @@ var Path = new Class({
|
|||
* @method Phaser.Curves.Path#lineTo
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {number|Phaser.Math.Vector2} x - [description]
|
||||
* @param {(number|Phaser.Math.Vector2)} x - [description]
|
||||
* @param {number} [y] - [description]
|
||||
*
|
||||
* @return {Phaser.Curves.Path} [description]
|
||||
|
|
|
@ -19,7 +19,7 @@ var Smoothing = function ()
|
|||
* @function Phaser.Display.Canvas.Smoothing.getPrefix
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {CanvasRenderingContext2D|WebGLRenderingContext} context - [description]
|
||||
* @param {(CanvasRenderingContext2D|WebGLRenderingContext)} context - [description]
|
||||
*
|
||||
* @return {string} [description]
|
||||
*/
|
||||
|
@ -50,9 +50,9 @@ var Smoothing = function ()
|
|||
* @function Phaser.Display.Canvas.Smoothing.enable
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {CanvasRenderingContext2D|WebGLRenderingContext} context - [description]
|
||||
* @param {(CanvasRenderingContext2D|WebGLRenderingContext)} context - [description]
|
||||
*
|
||||
* @return {CanvasRenderingContext2D|WebGLRenderingContext} [description]
|
||||
* @return {(CanvasRenderingContext2D|WebGLRenderingContext)} [description]
|
||||
*/
|
||||
var enable = function (context)
|
||||
{
|
||||
|
@ -79,9 +79,9 @@ var Smoothing = function ()
|
|||
* @function Phaser.Display.Canvas.Smoothing.disable
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {CanvasRenderingContext2D|WebGLRenderingContext} context - [description]
|
||||
* @param {(CanvasRenderingContext2D|WebGLRenderingContext)} context - [description]
|
||||
*
|
||||
* @return {CanvasRenderingContext2D|WebGLRenderingContext} [description]
|
||||
* @return {(CanvasRenderingContext2D|WebGLRenderingContext)} [description]
|
||||
*/
|
||||
var disable = function (context)
|
||||
{
|
||||
|
@ -105,9 +105,9 @@ var Smoothing = function ()
|
|||
* @function Phaser.Display.Canvas.Smoothing.isEnabled
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {CanvasRenderingContext2D|WebGLRenderingContext} context - [description]
|
||||
* @param {(CanvasRenderingContext2D|WebGLRenderingContext)} context - [description]
|
||||
*
|
||||
* @return {boolean|null} [description]
|
||||
* @return {?boolean} [description]
|
||||
*/
|
||||
var isEnabled = function (context)
|
||||
{
|
||||
|
|
|
@ -16,7 +16,7 @@ var RGBStringToColor = require('./RGBStringToColor');
|
|||
* @function Phaser.Display.Color.ValueToColor
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {string|number|InputColorObject} input - The source color value to convert.
|
||||
* @param {(string|number|InputColorObject)} input - The source color value to convert.
|
||||
*
|
||||
* @return {Phaser.Display.Color} A Color object.
|
||||
*/
|
||||
|
|
|
@ -143,7 +143,7 @@ var BitmapMask = new Class({
|
|||
* @method Phaser.Display.Masks.BitmapMask#preRenderWebGL
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {Phaser.Renderer.Canvas.CanvasRenderer|Phaser.Renderer.WebGL.WebGLRenderer} renderer - [description]
|
||||
* @param {(Phaser.Renderer.Canvas.CanvasRenderer|Phaser.Renderer.WebGL.WebGLRenderer)} renderer - [description]
|
||||
* @param {Phaser.GameObjects.GameObject} maskedObject - [description]
|
||||
* @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to render to.
|
||||
*/
|
||||
|
@ -158,7 +158,7 @@ var BitmapMask = new Class({
|
|||
* @method Phaser.Display.Masks.BitmapMask#postRenderWebGL
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {Phaser.Renderer.Canvas.CanvasRenderer|Phaser.Renderer.WebGL.WebGLRenderer} renderer - [description]
|
||||
* @param {(Phaser.Renderer.Canvas.CanvasRenderer|Phaser.Renderer.WebGL.WebGLRenderer)} renderer - [description]
|
||||
*/
|
||||
postRenderWebGL: function (renderer)
|
||||
{
|
||||
|
@ -171,7 +171,7 @@ var BitmapMask = new Class({
|
|||
* @method Phaser.Display.Masks.BitmapMask#preRenderCanvas
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {Phaser.Renderer.Canvas.CanvasRenderer|Phaser.Renderer.WebGL.WebGLRenderer} renderer - [description]
|
||||
* @param {(Phaser.Renderer.Canvas.CanvasRenderer|Phaser.Renderer.WebGL.WebGLRenderer)} renderer - [description]
|
||||
* @param {Phaser.GameObjects.GameObject} mask - [description]
|
||||
* @param {Phaser.Cameras.Scene2D.Camera} camera - The Camera to render to.
|
||||
*/
|
||||
|
@ -186,7 +186,7 @@ var BitmapMask = new Class({
|
|||
* @method Phaser.Display.Masks.BitmapMask#postRenderCanvas
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {Phaser.Renderer.Canvas.CanvasRenderer|Phaser.Renderer.WebGL.WebGLRenderer} renderer - [description]
|
||||
* @param {(Phaser.Renderer.Canvas.CanvasRenderer|Phaser.Renderer.WebGL.WebGLRenderer)} renderer - [description]
|
||||
*/
|
||||
postRenderCanvas: function ()
|
||||
{
|
||||
|
|
|
@ -53,7 +53,7 @@ var GeometryMask = new Class({
|
|||
* @method Phaser.Display.Masks.GeometryMask#preRenderWebGL
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {Phaser.Renderer.Canvas.CanvasRenderer|Phaser.Renderer.WebGL.WebGLRenderer} renderer - [description]
|
||||
* @param {(Phaser.Renderer.Canvas.CanvasRenderer|Phaser.Renderer.WebGL.WebGLRenderer)} renderer - [description]
|
||||
* @param {Phaser.GameObjects.GameObject} mask - [description]
|
||||
* @param {Phaser.Cameras.Scene2D.Camera} camera - [description]
|
||||
*/
|
||||
|
@ -88,7 +88,7 @@ var GeometryMask = new Class({
|
|||
* @method Phaser.Display.Masks.GeometryMask#postRenderWebGL
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {Phaser.Renderer.Canvas.CanvasRenderer|Phaser.Renderer.WebGL.WebGLRenderer} renderer - [description]
|
||||
* @param {(Phaser.Renderer.Canvas.CanvasRenderer|Phaser.Renderer.WebGL.WebGLRenderer)} renderer - [description]
|
||||
*/
|
||||
postRenderWebGL: function (renderer)
|
||||
{
|
||||
|
@ -105,7 +105,7 @@ var GeometryMask = new Class({
|
|||
* @method Phaser.Display.Masks.GeometryMask#preRenderCanvas
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {Phaser.Renderer.Canvas.CanvasRenderer|Phaser.Renderer.WebGL.WebGLRenderer} renderer - [description]
|
||||
* @param {(Phaser.Renderer.Canvas.CanvasRenderer|Phaser.Renderer.WebGL.WebGLRenderer)} renderer - [description]
|
||||
* @param {Phaser.GameObjects.GameObject} mask - [description]
|
||||
* @param {Phaser.Cameras.Scene2D.Camera} camera - [description]
|
||||
*/
|
||||
|
@ -126,7 +126,7 @@ var GeometryMask = new Class({
|
|||
* @method Phaser.Display.Masks.GeometryMask#postRenderCanvas
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {Phaser.Renderer.Canvas.CanvasRenderer|Phaser.Renderer.WebGL.WebGLRenderer} renderer - [description]
|
||||
* @param {(Phaser.Renderer.Canvas.CanvasRenderer|Phaser.Renderer.WebGL.WebGLRenderer)} renderer - [description]
|
||||
*/
|
||||
postRenderCanvas: function (renderer)
|
||||
{
|
||||
|
|
|
@ -12,7 +12,7 @@
|
|||
* @since 3.0.0
|
||||
*
|
||||
* @param {HTMLElement} element - The element to be added to the DOM. Usually a Canvas object.
|
||||
* @param {string|HTMLElement} [parent] - The parent in which to add the element. Can be a string which is passed to `getElementById` or an actual DOM object.
|
||||
* @param {(string|HTMLElement)} [parent] - The parent in which to add the element. Can be a string which is passed to `getElementById` or an actual DOM object.
|
||||
* @param {boolean} [overflowHidden=true] - [description]
|
||||
*
|
||||
* @return {HTMLElement} The element that was added to the DOM.
|
||||
|
|
|
@ -14,7 +14,7 @@
|
|||
*
|
||||
* @param {string} data - The XML source stored in a string.
|
||||
*
|
||||
* @return {DOMParser|ActiveXObject|null} The parsed XML data, or `null` if the data could not be parsed.
|
||||
* @return {?(DOMParser|ActiveXObject)} The parsed XML data, or `null` if the data could not be parsed.
|
||||
*/
|
||||
var ParseXML = function (data)
|
||||
{
|
||||
|
|
|
@ -76,7 +76,7 @@ var EventEmitter = new Class({
|
|||
* @method EventEmitter#listeners
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {string|symbol} event - The event name.
|
||||
* @param {(string|symbol)} event - The event name.
|
||||
*
|
||||
* @return {array} The registered listeners.
|
||||
*/
|
||||
|
@ -87,7 +87,7 @@ var EventEmitter = new Class({
|
|||
* @method EventEmitter#listenerCount
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {string|symbol} event - The event name.
|
||||
* @param {(string|symbol)} event - The event name.
|
||||
*
|
||||
* @return {number} The number of listeners.
|
||||
*/
|
||||
|
@ -98,7 +98,7 @@ var EventEmitter = new Class({
|
|||
* @method EventEmitter#emit
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {string|symbol} event - The event name.
|
||||
* @param {(string|symbol)} event - The event name.
|
||||
*
|
||||
* @return {boolean} `true` if the event had listeners, else `false`.
|
||||
*/
|
||||
|
@ -109,7 +109,7 @@ var EventEmitter = new Class({
|
|||
* @method EventEmitter#on
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {string|symbol} event - The event name.
|
||||
* @param {(string|symbol)} event - The event name.
|
||||
* @param {function} fn - The listener function.
|
||||
* @param {*} [context=this] - The context to invoke the listener with.
|
||||
*
|
||||
|
@ -122,7 +122,7 @@ var EventEmitter = new Class({
|
|||
* @method EventEmitter#addListener
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {string|symbol} event - The event name.
|
||||
* @param {(string|symbol)} event - The event name.
|
||||
* @param {function} fn - The listener function.
|
||||
* @param {*} [context=this] - The context to invoke the listener with.
|
||||
*
|
||||
|
@ -135,7 +135,7 @@ var EventEmitter = new Class({
|
|||
* @method EventEmitter#once
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {string|symbol} event - The event name.
|
||||
* @param {(string|symbol)} event - The event name.
|
||||
* @param {function} fn - The listener function.
|
||||
* @param {*} [context=this] - The context to invoke the listener with.
|
||||
*
|
||||
|
@ -148,7 +148,7 @@ var EventEmitter = new Class({
|
|||
* @method EventEmitter#removeListener
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {string|symbol} event - The event name.
|
||||
* @param {(string|symbol)} event - The event name.
|
||||
* @param {function} fn - Only remove the listeners that match this function.
|
||||
* @param {*} context - Only remove the listeners that have this context.
|
||||
* @param {boolean} once - Only remove one-time listeners.
|
||||
|
@ -162,7 +162,7 @@ var EventEmitter = new Class({
|
|||
* @method EventEmitter#off
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {string|symbol} event - The event name.
|
||||
* @param {(string|symbol)} event - The event name.
|
||||
* @param {function} fn - Only remove the listeners that match this function.
|
||||
* @param {*} context - Only remove the listeners that have this context.
|
||||
* @param {boolean} once - Only remove one-time listeners.
|
||||
|
@ -176,7 +176,7 @@ var EventEmitter = new Class({
|
|||
* @method EventEmitter#removeAllListeners
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {string|symbol} [event] - The event name.
|
||||
* @param {(string|symbol)} [event] - The event name.
|
||||
*
|
||||
* @return {EventEmitter} `this`.
|
||||
*/
|
||||
|
|
|
@ -11,7 +11,7 @@
|
|||
* @since 3.0.0
|
||||
* @private
|
||||
*
|
||||
* @param {Phaser.GameObjects.DynamicBitmapText|Phaser.GameObjects.BitmapText} src - [description]
|
||||
* @param {(Phaser.GameObjects.DynamicBitmapText|Phaser.GameObjects.BitmapText)} src - [description]
|
||||
* @param {boolean} round - [description]
|
||||
*/
|
||||
var GetBitmapTextSize = function (src, round)
|
||||
|
|
|
@ -49,7 +49,7 @@ var Render = require('./DynamicBitmapTextRender');
|
|||
* @param {number} [x=0] - The x coordinate of this Game Object in world space.
|
||||
* @param {number} [y=0] - The y coordinate of this Game Object in world space.
|
||||
* @param {string} font - [description]
|
||||
* @param {string|string[]} [text] - [description]
|
||||
* @param {(string|string[])} [text] - [description]
|
||||
* @param {number} [size] - [description]
|
||||
*/
|
||||
var DynamicBitmapText = new Class({
|
||||
|
@ -240,7 +240,7 @@ var DynamicBitmapText = new Class({
|
|||
* @method Phaser.GameObjects.DynamicBitmapText#setText
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {string|string[]} value - The string, or array of strings, to be set as the content of this BitmapText.
|
||||
* @param {(string|string[])} value - The string, or array of strings, to be set as the content of this BitmapText.
|
||||
*
|
||||
* @return {Phaser.GameObjects.DynamicBitmapText} This Game Object.
|
||||
*/
|
||||
|
|
|
@ -18,7 +18,7 @@ var GameObjectFactory = require('../../GameObjectFactory');
|
|||
* @param {number} x - The x position of the Game Object.
|
||||
* @param {number} y - The y position of the Game Object.
|
||||
* @param {string} font - [description]
|
||||
* @param {string|string[]} [text] - [description]
|
||||
* @param {(string|string[])} [text] - [description]
|
||||
* @param {number} [size] - [description]
|
||||
*
|
||||
* @return {Phaser.GameObjects.DynamicBitmapText} The Game Object that was created.
|
||||
|
|
|
@ -53,7 +53,7 @@ var Render = require('./BitmapTextRender');
|
|||
* @param {number} [x=0] - The x coordinate of this Game Object in world space.
|
||||
* @param {number} [y=0] - The y coordinate of this Game Object in world space.
|
||||
* @param {string} font - [description]
|
||||
* @param {string|string[]} [text] - [description]
|
||||
* @param {(string|string[])} [text] - [description]
|
||||
* @param {number} [size] - [description]
|
||||
*/
|
||||
var BitmapText = new Class({
|
||||
|
@ -160,7 +160,7 @@ var BitmapText = new Class({
|
|||
* @method Phaser.GameObjects.BitmapText#setText
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {string|string[]} value - The string, or array of strings, to be set as the content of this BitmapText.
|
||||
* @param {(string|string[])} value - The string, or array of strings, to be set as the content of this BitmapText.
|
||||
*
|
||||
* @return {Phaser.GameObjects.BitmapText} This Game Object.
|
||||
*/
|
||||
|
|
|
@ -18,7 +18,7 @@ var GameObjectFactory = require('../../GameObjectFactory');
|
|||
* @param {number} x - The x position of the Game Object.
|
||||
* @param {number} y - The y position of the Game Object.
|
||||
* @param {string} font - [description]
|
||||
* @param {string|string[]} [text] - [description]
|
||||
* @param {(string|string[])} [text] - [description]
|
||||
* @param {number} [size] - [description]
|
||||
*
|
||||
* @return {Phaser.GameObjects.BitmapText} The Game Object that was created.
|
||||
|
|
|
@ -56,7 +56,7 @@ var List = require('../../structs/List');
|
|||
* @param {number} [x=0] - The x coordinate of this Game Object in world space.
|
||||
* @param {number} [y=0] - The y coordinate of this Game Object in world space.
|
||||
* @param {string} [texture='__DEFAULT'] - The key of the texture this Game Object will use for rendering. The Texture must already exist in the Texture Manager.
|
||||
* @param {string|integer} [frame=0] - The Frame of the Texture that this Game Object will use. Only set if the Texture has multiple frames, such as a Texture Atlas or Sprite Sheet.
|
||||
* @param {(string|integer)} [frame=0] - The Frame of the Texture that this Game Object will use. Only set if the Texture has multiple frames, such as a Texture Atlas or Sprite Sheet.
|
||||
*/
|
||||
var Blitter = new Class({
|
||||
|
||||
|
@ -116,7 +116,7 @@ var Blitter = new Class({
|
|||
*
|
||||
* @param {number} x - The x position of the Bob. Bob coordinate are relative to the position of the Blitter object.
|
||||
* @param {number} y - The y position of the Bob. Bob coordinate are relative to the position of the Blitter object.
|
||||
* @param {string|integer|Phaser.Textures.Frame} [frame] - The Frame the Bob will use. It _must_ be part of the Texture the parent Blitter object is using.
|
||||
* @param {(string|integer|Phaser.Textures.Frame)} [frame] - The Frame the Bob will use. It _must_ be part of the Texture the parent Blitter object is using.
|
||||
* @param {boolean} [visible=true] - Should the created Bob render or not?
|
||||
* @param {integer} [index] - The position in the Blitters Display List to add the new Bob at. Defaults to the top of the list.
|
||||
*
|
||||
|
|
|
@ -18,7 +18,7 @@ var GameObjectFactory = require('../GameObjectFactory');
|
|||
* @param {number} x - The x position of the Game Object.
|
||||
* @param {number} y - The y position of the Game Object.
|
||||
* @param {string} key - The key of the Texture the Blitter object will use.
|
||||
* @param {string|integer} [frame] - The default Frame children of the Blitter will use.
|
||||
* @param {(string|integer)} [frame] - The default Frame children of the Blitter will use.
|
||||
*
|
||||
* @return {Phaser.GameObjects.Blitter} The Game Object that was created.
|
||||
*/
|
||||
|
|
|
@ -30,7 +30,7 @@ var Class = require('../../utils/Class');
|
|||
* @param {Phaser.GameObjects.Blitter} blitter - The parent Blitter object is responsible for updating this Bob.
|
||||
* @param {number} x - The horizontal position of this Game Object in the world, relative to the parent Blitter position.
|
||||
* @param {number} y - The vertical position of this Game Object in the world, relative to the parent Blitter position.
|
||||
* @param {string|integer} frame - The Frame this Bob will render with, as defined in the Texture the parent Blitter is using.
|
||||
* @param {(string|integer)} frame - The Frame this Bob will render with, as defined in the Texture the parent Blitter is using.
|
||||
* @param {boolean} visible - Should the Bob render visible or not to start with?
|
||||
*/
|
||||
var Bob = new Class({
|
||||
|
@ -70,7 +70,7 @@ var Bob = new Class({
|
|||
* [description]
|
||||
*
|
||||
* @name Phaser.GameObjects.Blitter.Bob#frame
|
||||
* @type {string|integer}
|
||||
* @type {(string|integer)}
|
||||
* @since 3.0.0
|
||||
*/
|
||||
this.frame = frame;
|
||||
|
|
|
@ -390,7 +390,7 @@ var Animation = new Class({
|
|||
*
|
||||
* @param {boolean} [value] - [description]
|
||||
*
|
||||
* @return {boolean|Phaser.GameObjects.GameObject} [description]
|
||||
* @return {(boolean|Phaser.GameObjects.GameObject)} [description]
|
||||
*/
|
||||
paused: function (value)
|
||||
{
|
||||
|
@ -474,7 +474,7 @@ var Animation = new Class({
|
|||
*
|
||||
* @param {number} [value] - [description]
|
||||
*
|
||||
* @return {number|Phaser.GameObjects.GameObject} [description]
|
||||
* @return {(number|Phaser.GameObjects.GameObject)} [description]
|
||||
*/
|
||||
progress: function (value)
|
||||
{
|
||||
|
@ -534,7 +534,7 @@ var Animation = new Class({
|
|||
*
|
||||
* @param {number} value - [description]
|
||||
*
|
||||
* @return {number|Phaser.GameObjects.GameObject} [description]
|
||||
* @return {(number|Phaser.GameObjects.GameObject)} [description]
|
||||
*/
|
||||
repeat: function (value)
|
||||
{
|
||||
|
@ -562,7 +562,7 @@ var Animation = new Class({
|
|||
*
|
||||
* @param {number} [value] - [description]
|
||||
*
|
||||
* @return {number|Phaser.GameObjects.GameObject} [description]
|
||||
* @return {(number|Phaser.GameObjects.GameObject)} [description]
|
||||
*/
|
||||
repeatDelay: function (value)
|
||||
{
|
||||
|
@ -666,7 +666,7 @@ var Animation = new Class({
|
|||
*
|
||||
* @param {number} [value] - [description]
|
||||
*
|
||||
* @return {number|Phaser.GameObjects.GameObject} [description]
|
||||
* @return {(number|Phaser.GameObjects.GameObject)} [description]
|
||||
*/
|
||||
timeScale: function (value)
|
||||
{
|
||||
|
@ -779,7 +779,7 @@ var Animation = new Class({
|
|||
*
|
||||
* @param {boolean} [value] - [description]
|
||||
*
|
||||
* @return {boolean|Phaser.GameObjects.GameObject} [description]
|
||||
* @return {(boolean|Phaser.GameObjects.GameObject)} [description]
|
||||
*/
|
||||
yoyo: function (value)
|
||||
{
|
||||
|
|
|
@ -39,7 +39,7 @@ var BlendMode = {
|
|||
* are used.
|
||||
*
|
||||
* @name Phaser.GameObjects.Components.BlendMode#blendMode
|
||||
* @type {integer|string}
|
||||
* @type {(integer|string)}
|
||||
* @since 3.0.0
|
||||
*/
|
||||
blendMode: {
|
||||
|
@ -89,7 +89,7 @@ var BlendMode = {
|
|||
* @method Phaser.GameObjects.Components.BlendMode#setBlendMode
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {string|integer} value - The BlendMode value. Either a string or a CONST.
|
||||
* @param {(string|integer)} value - The BlendMode value. Either a string or a CONST.
|
||||
*
|
||||
* @return {Phaser.GameObjects.GameObject} This Game Object instance.
|
||||
*/
|
||||
|
|
|
@ -24,9 +24,9 @@ var GetBounds = {
|
|||
* @method Phaser.GameObjects.Components.GetBounds#getCenter
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {Phaser.Math.Vector2|object} [output] - An object to store the values in. If not provided a new Vector2 will be created.
|
||||
* @param {(Phaser.Math.Vector2|object)} [output] - An object to store the values in. If not provided a new Vector2 will be created.
|
||||
*
|
||||
* @return {Phaser.Math.Vector2|object} The values stored in the output object.
|
||||
* @return {(Phaser.Math.Vector2|object)} The values stored in the output object.
|
||||
*/
|
||||
getCenter: function (output)
|
||||
{
|
||||
|
@ -44,9 +44,9 @@ var GetBounds = {
|
|||
* @method Phaser.GameObjects.Components.GetBounds#getTopLeft
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {Phaser.Math.Vector2|object} [output] - An object to store the values in. If not provided a new Vector2 will be created.
|
||||
* @param {(Phaser.Math.Vector2|object)} [output] - An object to store the values in. If not provided a new Vector2 will be created.
|
||||
*
|
||||
* @return {Phaser.Math.Vector2|object} The values stored in the output object.
|
||||
* @return {(Phaser.Math.Vector2|object)} The values stored in the output object.
|
||||
*/
|
||||
getTopLeft: function (output)
|
||||
{
|
||||
|
@ -69,9 +69,9 @@ var GetBounds = {
|
|||
* @method Phaser.GameObjects.Components.GetBounds#getTopRight
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {Phaser.Math.Vector2|object} [output] - An object to store the values in. If not provided a new Vector2 will be created.
|
||||
* @param {(Phaser.Math.Vector2|object)} [output] - An object to store the values in. If not provided a new Vector2 will be created.
|
||||
*
|
||||
* @return {Phaser.Math.Vector2|object} The values stored in the output object.
|
||||
* @return {(Phaser.Math.Vector2|object)} The values stored in the output object.
|
||||
*/
|
||||
getTopRight: function (output)
|
||||
{
|
||||
|
@ -94,9 +94,9 @@ var GetBounds = {
|
|||
* @method Phaser.GameObjects.Components.GetBounds#getBottomLeft
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {Phaser.Math.Vector2|object} [output] - An object to store the values in. If not provided a new Vector2 will be created.
|
||||
* @param {(Phaser.Math.Vector2|object)} [output] - An object to store the values in. If not provided a new Vector2 will be created.
|
||||
*
|
||||
* @return {Phaser.Math.Vector2|object} The values stored in the output object.
|
||||
* @return {(Phaser.Math.Vector2|object)} The values stored in the output object.
|
||||
*/
|
||||
getBottomLeft: function (output)
|
||||
{
|
||||
|
@ -119,9 +119,9 @@ var GetBounds = {
|
|||
* @method Phaser.GameObjects.Components.GetBounds#getBottomRight
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {Phaser.Math.Vector2|object} [output] - An object to store the values in. If not provided a new Vector2 will be created.
|
||||
* @param {(Phaser.Math.Vector2|object)} [output] - An object to store the values in. If not provided a new Vector2 will be created.
|
||||
*
|
||||
* @return {Phaser.Math.Vector2|object} The values stored in the output object.
|
||||
* @return {(Phaser.Math.Vector2|object)} The values stored in the output object.
|
||||
*/
|
||||
getBottomRight: function (output)
|
||||
{
|
||||
|
@ -145,9 +145,9 @@ var GetBounds = {
|
|||
* @method Phaser.GameObjects.Components.GetBounds#getBounds
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {Phaser.Geom.Rectangle|object} [output] - An object to store the values in. If not provided a new Rectangle will be created.
|
||||
* @param {(Phaser.Geom.Rectangle|object)} [output] - An object to store the values in. If not provided a new Rectangle will be created.
|
||||
*
|
||||
* @return {Phaser.Geom.Rectangle|object} The values stored in the output object.
|
||||
* @return {(Phaser.Geom.Rectangle|object)} The values stored in the output object.
|
||||
*/
|
||||
getBounds: function (output)
|
||||
{
|
||||
|
|
|
@ -43,7 +43,7 @@ var Texture = {
|
|||
* @since 3.0.0
|
||||
*
|
||||
* @param {string} key - The key of the texture to be used, as stored in the Texture Manager.
|
||||
* @param {string|integer} [frame] - The name or index of the frame within the Texture.
|
||||
* @param {(string|integer)} [frame] - The name or index of the frame within the Texture.
|
||||
*
|
||||
* @return {Phaser.GameObjects.GameObject} This Game Object instance.
|
||||
*/
|
||||
|
@ -67,7 +67,7 @@ var Texture = {
|
|||
* @method Phaser.GameObjects.Components.Texture#setFrame
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {string|integer} frame - The name or index of the frame within the Texture.
|
||||
* @param {(string|integer)} frame - The name or index of the frame within the Texture.
|
||||
* @param {boolean} [updateSize=true] - Should this call adjust the size of the Game Object?
|
||||
* @param {boolean} [updateOrigin=true] - Should this call adjust the origin of the Game Object?
|
||||
*
|
||||
|
|
|
@ -23,7 +23,7 @@
|
|||
* @property {float} alpha - The alpha value of the Game Object.
|
||||
* @property {boolean} visible - The visible state of the Game Object.
|
||||
* @property {integer} scaleMode - The Scale Mode being used by this Game Object.
|
||||
* @property {integer|string} blendMode - Sets the Blend Mode being used by this Game Object.
|
||||
* @property {(integer|string)} blendMode - Sets the Blend Mode being used by this Game Object.
|
||||
* @property {string} textureKey - The texture key of this Game Object.
|
||||
* @property {string} frameKey - The frame key of this Game Object.
|
||||
* @property {object} data - The data of this Game Object.
|
||||
|
|
|
@ -227,9 +227,9 @@ var TransformMatrix = new Class({
|
|||
*
|
||||
* @param {number} x - [description]
|
||||
* @param {number} y - [description]
|
||||
* @param {Phaser.Geom.Point|Phaser.Math.Vec2|object} point - [description]
|
||||
* @param {(Phaser.Geom.Point|Phaser.Math.Vector2|object)} point - [description]
|
||||
*
|
||||
* @return {Phaser.Geom.Point|Phaser.Math.Vec2|object} [description]
|
||||
* @return {(Phaser.Geom.Point|Phaser.Math.Vector2|object)} [description]
|
||||
*/
|
||||
transformPoint: function (x, y, point)
|
||||
{
|
||||
|
|
|
@ -477,7 +477,7 @@ var Graphics = new Class({
|
|||
* @method Phaser.GameObjects.Graphics#fillPointShape
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {Phaser.Geom.Point|Phaser.Math.Vector2|object} point - [description]
|
||||
* @param {(Phaser.Geom.Point|Phaser.Math.Vector2|object)} point - [description]
|
||||
* @param {number} [size=1] - [description]
|
||||
*
|
||||
* @return {Phaser.GameObjects.Graphics} This Game Object.
|
||||
|
@ -731,7 +731,7 @@ var Graphics = new Class({
|
|||
* @method Phaser.GameObjects.Graphics#strokePoints
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {array|Phaser.Geom.Point[]} points - [description]
|
||||
* @param {(array|Phaser.Geom.Point[])} points - [description]
|
||||
* @param {boolean} [autoClose=false] - [description]
|
||||
* @param {integer} [endIndex] - [description]
|
||||
*
|
||||
|
@ -767,7 +767,7 @@ var Graphics = new Class({
|
|||
* @method Phaser.GameObjects.Graphics#fillPoints
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {array|Phaser.Geom.Point[]} points - [description]
|
||||
* @param {(array|Phaser.Geom.Point[])} points - [description]
|
||||
* @param {boolean} [autoClose=false] - [description]
|
||||
* @param {integer} [endIndex] - [description]
|
||||
*
|
||||
|
@ -1043,7 +1043,7 @@ var Graphics = new Class({
|
|||
* @method Phaser.GameObjects.Graphics#generateTexture
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {string|HTMLCanvasElement} key - [description]
|
||||
* @param {(string|HTMLCanvasElement)} key - [description]
|
||||
* @param {integer} [width] - [description]
|
||||
* @param {integer} [height] - [description]
|
||||
*
|
||||
|
|
|
@ -108,7 +108,7 @@ var Group = new Class({
|
|||
* [description]
|
||||
*
|
||||
* @name Phaser.GameObjects.Group#defaultFrame
|
||||
* @type {string|integer}
|
||||
* @type {(string|integer)}
|
||||
* @since 3.0.0
|
||||
*/
|
||||
this.defaultFrame = GetFastValue(config, 'defaultFrame', null);
|
||||
|
@ -165,8 +165,8 @@ var Group = new Class({
|
|||
* @param {number} x - The horizontal position of this Game Object in the world.
|
||||
* @param {number} y - The vertical position of this Game Object in the world.
|
||||
* @param {string} texture - The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.
|
||||
* @param {string|integer} [frame] - An optional frame from the Texture this Game Object is rendering with.
|
||||
* @param {string|integer} [frame] - An optional frame from the Texture this Game Object is rendering with.
|
||||
* @param {(string|integer)} [frame] - An optional frame from the Texture this Game Object is rendering with.
|
||||
* @param {(string|integer)} [frame] - An optional frame from the Texture this Game Object is rendering with.
|
||||
* @param {boolean} [visible=true] - The {@link Phaser.GameObjects.Components.Visible#visible} state of this Game Object.
|
||||
* @param {boolean} [active=true] - The {@link Phaser.GameObjects.GameObject#active} state of this Game Object.
|
||||
*
|
||||
|
@ -559,10 +559,10 @@ var Group = new Class({
|
|||
* @param {number} [x] - The horizontal position of this Game Object in the world.
|
||||
* @param {number} [y] - The vertical position of this Game Object in the world.
|
||||
* @param {string} [texture] - The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.
|
||||
* @param {string|integer} [frame] - An optional frame from the Texture this Game Object is rendering with.
|
||||
* @param {(string|integer)} [frame] - An optional frame from the Texture this Game Object is rendering with.
|
||||
* @param {boolean} [visible] - [description]
|
||||
*
|
||||
* @return {Phaser.GameObjects.GameObject|null} [description]
|
||||
* @return {?Phaser.GameObjects.GameObject} [description]
|
||||
*/
|
||||
getFirst: function (state, createIfNull, x, y, key, frame, visible)
|
||||
{
|
||||
|
@ -613,7 +613,7 @@ var Group = new Class({
|
|||
* @param {number} x - The horizontal position of this Game Object in the world.
|
||||
* @param {number} y - The vertical position of this Game Object in the world.
|
||||
* @param {string} texture - The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.
|
||||
* @param {string|integer} [frame] - An optional frame from the Texture this Game Object is rendering with.
|
||||
* @param {(string|integer)} [frame] - An optional frame from the Texture this Game Object is rendering with.
|
||||
* @param {boolean} visible - [description]
|
||||
*
|
||||
* @return {Phaser.GameObjects.GameObject} [description]
|
||||
|
@ -633,7 +633,7 @@ var Group = new Class({
|
|||
* @param {number} x - The horizontal position of this Game Object in the world.
|
||||
* @param {number} y - The vertical position of this Game Object in the world.
|
||||
* @param {string} texture - The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.
|
||||
* @param {string|integer} [frame] - An optional frame from the Texture this Game Object is rendering with.
|
||||
* @param {(string|integer)} [frame] - An optional frame from the Texture this Game Object is rendering with.
|
||||
* @param {boolean} visible - [description]
|
||||
*
|
||||
* @return {Phaser.GameObjects.GameObject} [description]
|
||||
|
@ -653,7 +653,7 @@ var Group = new Class({
|
|||
* @param {number} x - The horizontal position of this Game Object in the world.
|
||||
* @param {number} y - The vertical position of this Game Object in the world.
|
||||
* @param {string} texture - The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.
|
||||
* @param {string|integer} [frame] - An optional frame from the Texture this Game Object is rendering with.
|
||||
* @param {(string|integer)} [frame] - An optional frame from the Texture this Game Object is rendering with.
|
||||
* @param {boolean} visible - [description]
|
||||
*
|
||||
* @return {Phaser.GameObjects.GameObject} [description]
|
||||
|
|
|
@ -15,7 +15,7 @@ var GameObjectFactory = require('../GameObjectFactory');
|
|||
* @method Phaser.GameObjects.GameObjectFactory#group
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {array|object} children - [description]
|
||||
* @param {(array|object)} children - [description]
|
||||
* @param {object} [config] - [description]
|
||||
*
|
||||
* @return {Phaser.GameObjects.Group} The Game Object that was created.
|
||||
|
|
|
@ -43,7 +43,7 @@ var ImageRender = require('./ImageRender');
|
|||
* @param {number} x - The horizontal position of this Game Object in the world.
|
||||
* @param {number} y - The vertical position of this Game Object in the world.
|
||||
* @param {string} texture - The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.
|
||||
* @param {string|integer} [frame] - An optional frame from the Texture this Game Object is rendering with.
|
||||
* @param {(string|integer)} [frame] - An optional frame from the Texture this Game Object is rendering with.
|
||||
*/
|
||||
var Image = new Class({
|
||||
|
||||
|
|
|
@ -18,7 +18,7 @@ var GameObjectFactory = require('../GameObjectFactory');
|
|||
* @param {number} x - The horizontal position of this Game Object in the world.
|
||||
* @param {number} y - The vertical position of this Game Object in the world.
|
||||
* @param {string} texture - The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.
|
||||
* @param {string|integer} [frame] - An optional frame from the Texture this Game Object is rendering with.
|
||||
* @param {(string|integer)} [frame] - An optional frame from the Texture this Game Object is rendering with.
|
||||
*
|
||||
* @return {Phaser.GameObjects.Image} The Game Object that was created.
|
||||
*/
|
||||
|
|
|
@ -42,7 +42,7 @@ var MeshRender = require('./MeshRender');
|
|||
* @param {array} colors - An array containing the color data for this Mesh.
|
||||
* @param {array} alphas - An array containing the alpha data for this Mesh.
|
||||
* @param {string} texture - The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.
|
||||
* @param {string|integer} [frame] - An optional frame from the Texture this Game Object is rendering with.
|
||||
* @param {(string|integer)} [frame] - An optional frame from the Texture this Game Object is rendering with.
|
||||
*/
|
||||
var Mesh = new Class({
|
||||
|
||||
|
|
|
@ -23,7 +23,7 @@ var GameObjectFactory = require('../GameObjectFactory');
|
|||
* @param {array} colors - An array containing the color data for this Mesh.
|
||||
* @param {array} alphas - An array containing the alpha data for this Mesh.
|
||||
* @param {string} texture - The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.
|
||||
* @param {string|integer} [frame] - An optional frame from the Texture this Game Object is rendering with.
|
||||
* @param {(string|integer)} [frame] - An optional frame from the Texture this Game Object is rendering with.
|
||||
*
|
||||
* @return {Phaser.GameObjects.Mesh} The Game Object that was created.
|
||||
*/
|
||||
|
|
|
@ -16,7 +16,7 @@ var GetFastValue = require('../../utils/object/GetFastValue');
|
|||
* @constructor
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {number|object} [x=0] - The x coordinate of the Gravity Well, in world space.
|
||||
* @param {(number|object)} [x=0] - The x coordinate of the Gravity Well, in world space.
|
||||
* @param {number} [y=0] - The y coordinate of the Gravity Well, in world space.
|
||||
* @param {number} [power=0] - The power of the Gravity Well.
|
||||
* @param {number} [epsilon=100] - [description]
|
||||
|
|
|
@ -973,7 +973,7 @@ var ParticleEmitter = new Class({
|
|||
* @method Phaser.GameObjects.Particles.ParticleEmitter#setFrame
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {array|string|integer|object} frames - [description]
|
||||
* @param {(array|string|integer|object)} frames - [description]
|
||||
* @param {boolean} [pickRandom=true] - [description]
|
||||
* @param {integer} [quantity=1] - [description]
|
||||
*
|
||||
|
@ -1068,7 +1068,7 @@ var ParticleEmitter = new Class({
|
|||
* @method Phaser.GameObjects.Particles.ParticleEmitter#setBounds
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {number|object} x - [description]
|
||||
* @param {(number|object)} x - [description]
|
||||
* @param {number} y - [description]
|
||||
* @param {number} width - [description]
|
||||
* @param {number} height - [description]
|
||||
|
|
|
@ -28,7 +28,7 @@ var Render = require('./ParticleManagerRender');
|
|||
*
|
||||
* @param {Phaser.Scene} scene - [description]
|
||||
* @param {string} texture - [description]
|
||||
* @param {string|integer} frame - [description]
|
||||
* @param {(string|integer)} frame - [description]
|
||||
* @param {Phaser.GameObjects.Particles.ParticleEmitter[]} emitters - [description]
|
||||
*/
|
||||
var ParticleEmitterManager = new Class({
|
||||
|
@ -152,7 +152,7 @@ var ParticleEmitterManager = new Class({
|
|||
* @since 3.0.0
|
||||
*
|
||||
* @param {string} key - The key of the texture to be used, as stored in the Texture Manager.
|
||||
* @param {string|integer} [frame] - The name or index of the frame within the Texture.
|
||||
* @param {(string|integer)} [frame] - The name or index of the frame within the Texture.
|
||||
*
|
||||
* @return {Phaser.GameObjects.Particles.ParticleEmitterManager} This Game Object.
|
||||
*/
|
||||
|
@ -173,7 +173,7 @@ var ParticleEmitterManager = new Class({
|
|||
* @method Phaser.GameObjects.Particles.ParticleEmitterManager#setFrame
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {string|integer} [frame] - The name or index of the frame within the Texture.
|
||||
* @param {(string|integer)} [frame] - The name or index of the frame within the Texture.
|
||||
*
|
||||
* @return {Phaser.GameObjects.Particles.ParticleEmitterManager} This Game Object.
|
||||
*/
|
||||
|
@ -194,7 +194,7 @@ var ParticleEmitterManager = new Class({
|
|||
* @method Phaser.GameObjects.Particles.ParticleEmitterManager#setEmitterFrames
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param {Phaser.Textures.Frame|Phaser.Textures.Frame[]} frames - [description]
|
||||
* @param {(Phaser.Textures.Frame|Phaser.Textures.Frame[])} frames - [description]
|
||||
* @param {Phaser.GameObjects.Particles.ParticleEmitter} emitter - [description]
|
||||
*
|
||||
* @return {Phaser.GameObjects.Particles.ParticleEmitterManager} This Game Object.
|
||||
|
|
|
@ -16,7 +16,7 @@ var ParticleEmitterManager = require('./ParticleEmitterManager');
|
|||
* @since 3.0.0
|
||||
*
|
||||
* @param {string} texture - The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.
|
||||
* @param {string|integer|object} [frame] - [description]
|
||||
* @param {(string|integer|object)} [frame] - [description]
|
||||
* @param {object} [emitters] - [description]
|
||||
*
|
||||
* @return {Phaser.GameObjects.Particles.ParticleEmitterManager} The Game Object that was created.
|
||||
|
|
|
@ -36,7 +36,7 @@ var Vector2 = require('../../math/Vector2');
|
|||
* @param {number} x - The horizontal position of this Game Object in the world.
|
||||
* @param {number} y - The vertical position of this Game Object in the world.
|
||||
* @param {string} texture - The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.
|
||||
* @param {string|integer} [frame] - An optional frame from the Texture this Game Object is rendering with.
|
||||
* @param {(string|integer)} [frame] - An optional frame from the Texture this Game Object is rendering with.
|
||||
*/
|
||||
var PathFollower = new Class({
|
||||
|
||||
|
|
|
@ -19,7 +19,7 @@ var PathFollower = require('./PathFollower');
|
|||
* @param {number} x - The horizontal position of this Game Object in the world.
|
||||
* @param {number} y - The vertical position of this Game Object in the world.
|
||||
* @param {string} texture - The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.
|
||||
* @param {string|integer} [frame] - An optional frame from the Texture this Game Object is rendering with.
|
||||
* @param {(string|integer)} [frame] - An optional frame from the Texture this Game Object is rendering with.
|
||||
*
|
||||
* @return {Phaser.GameObjects.PathFollower} The Game Object that was created.
|
||||
*/
|
||||
|
|
|
@ -28,7 +28,7 @@ var Mesh = require('../mesh/Mesh');
|
|||
* @param {number} x - The horizontal position of this Game Object in the world.
|
||||
* @param {number} y - The vertical position of this Game Object in the world.
|
||||
* @param {string} texture - The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.
|
||||
* @param {string|integer} [frame] - An optional frame from the Texture this Game Object is rendering with.
|
||||
* @param {(string|integer)} [frame] - An optional frame from the Texture this Game Object is rendering with.
|
||||
*/
|
||||
var Quad = new Class({
|
||||
|
||||
|
|
|
@ -19,7 +19,7 @@ var GameObjectFactory = require('../GameObjectFactory');
|
|||
* @param {number} x - The horizontal position of this Game Object in the world.
|
||||
* @param {number} y - The vertical position of this Game Object in the world.
|
||||
* @param {string} texture - The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.
|
||||
* @param {string|integer} [frame] - An optional frame from the Texture this Game Object is rendering with.
|
||||
* @param {(string|integer)} [frame] - An optional frame from the Texture this Game Object is rendering with.
|
||||
*
|
||||
* @return {Phaser.GameObjects.Quad} The Game Object that was created.
|
||||
*/
|
||||
|
|
|
@ -183,7 +183,7 @@ var RenderTexture = new Class({
|
|||
* @since 3.2.0
|
||||
*
|
||||
* @param {string} texture - The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.
|
||||
* @param {string|integer} [frame] - An optional frame from the Texture this Game Object is rendering with.
|
||||
* @param {(string|integer)} [frame] - An optional frame from the Texture this Game Object is rendering with.
|
||||
* @param {number} x - The x position to draw the frame at.
|
||||
* @param {number} y - The y position to draw the frame at.
|
||||
*
|
||||
|
|
Some files were not shown because too many files have changed in this diff Show more
Loading…
Reference in a new issue