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

Fixed some JSDocs resulting from #4850

Browse source
This commit is contained in:
Richard Davey 2019-11-19 11:23:19 +00:00
parent 4606f0b443
commit b95a6a45bd
1 changed files with 12 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
src/gameobjects/group/Group.js
View file

@ -1242,7 +1242,7 @@ var Group = new Class({
* @method Phaser.GameObjects.Group#angle * @method Phaser.GameObjects.Group#angle
* @since 3.21.0 * @since 3.21.0
* *
* @param {number} value - The amount to set the property to. * @param {number} value - The amount to set the angle to, in degrees.
* @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter. * @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter.
* *
* @return {Phaser.GameObjects.Group} This Group object. * @return {Phaser.GameObjects.Group} This Group object.
@ -1260,7 +1260,7 @@ var Group = new Class({
* @method Phaser.GameObjects.Group#rotate * @method Phaser.GameObjects.Group#rotate
* @since 3.21.0 * @since 3.21.0
* *
* @param {number} value - The amount to set the property to. * @param {number} value - The amount to set the rotation to, in radians.
* @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter. * @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter.
* *
* @return {Phaser.GameObjects.Group} This Group object. * @return {Phaser.GameObjects.Group} This Group object.
@ -1278,7 +1278,7 @@ var Group = new Class({
* @method Phaser.GameObjects.Group#rotateAround * @method Phaser.GameObjects.Group#rotateAround
* @since 3.21.0 * @since 3.21.0
* *
* @param {object} point - Any object with public `x` and `y` properties. * @param {Phaser.Types.Math.Vector2Like} point - Any object with public `x` and `y` properties.
* @param {number} angle - The angle to rotate by, in radians. * @param {number} angle - The angle to rotate by, in radians.
* *
* @return {Phaser.GameObjects.Group} This Group object. * @return {Phaser.GameObjects.Group} This Group object.
@ -1296,7 +1296,7 @@ var Group = new Class({
* @method Phaser.GameObjects.Group#rotateAroundDistance * @method Phaser.GameObjects.Group#rotateAroundDistance
* @since 3.21.0 * @since 3.21.0
* *
* @param {object} point - Any object with public `x` and `y` properties. * @param {Phaser.Types.Math.Vector2Like} point - Any object with public `x` and `y` properties.
* @param {number} angle - The angle to rotate by, in radians. * @param {number} angle - The angle to rotate by, in radians.
* @param {number} distance - The distance from the point of rotation in pixels. * @param {number} distance - The distance from the point of rotation in pixels.
* *
@ -1312,10 +1312,10 @@ var Group = new Class({
/** /**
* Sets the alpha of each group member. * Sets the alpha of each group member.
* *
* @method Phaser.GameObjects.Group#scaleX * @method Phaser.GameObjects.Group#setAlpha
* @since 3.21.0 * @since 3.21.0
* *
* @param {number} value - The amount to set the property to. * @param {number} value - The amount to set the alpha to.
* @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter. * @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter.
* *
* @return {Phaser.GameObjects.Group} This Group object. * @return {Phaser.GameObjects.Group} This Group object.
@ -1530,13 +1530,15 @@ var Group = new Class({
* @method Phaser.GameObjects.Group#setVisible * @method Phaser.GameObjects.Group#setVisible
* @since 3.21.0 * @since 3.21.0
* *
* @param {number} value - The value to set the property to. * @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.
* *
* @return {Phaser.GameObjects.Group} This Group object. * @return {Phaser.GameObjects.Group} This Group object.
*/ */
setVisible: function (value) setVisible: function (value, index, direction)
{ {
Actions.SetVisible(this.children.entries, value); Actions.SetVisible(this.children.entries, value, index, direction);
return this; return this;
}, },