Skip to content

Commit 66e3144

Browse files
committed
Fixed this return types for Phaser.GameObjects.Group
1 parent 494ddf4 commit 66e3144

2 files changed

Lines changed: 60 additions & 60 deletions

File tree

src/gameobjects/group/Group.js

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -521,7 +521,7 @@ var Group = new Class({
521521
* @param {Phaser.GameObjects.GameObject} child - The Game Object to add.
522522
* @param {boolean} [addToScene=false] - Also add the Game Object to the scene.
523523
*
524-
* @return {Phaser.GameObjects.Group} This Group object.
524+
* @return {this} This Group object.
525525
*/
526526
add: function (child, addToScene)
527527
{
@@ -570,7 +570,7 @@ var Group = new Class({
570570
* @param {Phaser.GameObjects.GameObject[]} children - The Game Objects to add.
571571
* @param {boolean} [addToScene=false] - Also add the Game Objects to the scene.
572572
*
573-
* @return {Phaser.GameObjects.Group} This group.
573+
* @return {this} This group.
574574
*/
575575
addMultiple: function (children, addToScene)
576576
{
@@ -599,7 +599,7 @@ var Group = new Class({
599599
* @param {boolean} [removeFromScene=false] - Optionally remove the Group member from the Scene it belongs to.
600600
* @param {boolean} [destroyChild=false] - Optionally call destroy on the removed Group member.
601601
*
602-
* @return {Phaser.GameObjects.Group} This Group object.
602+
* @return {this} This Group object.
603603
*/
604604
remove: function (child, removeFromScene, destroyChild)
605605
{
@@ -653,7 +653,7 @@ var Group = new Class({
653653
* @param {boolean} [removeFromScene=false] - Optionally remove each Group member from the Scene.
654654
* @param {boolean} [destroyChild=false] - Optionally call destroy on the removed Group members.
655655
*
656-
* @return {Phaser.GameObjects.Group} This group.
656+
* @return {this} This group.
657657
*/
658658
clear: function (removeFromScene, destroyChild)
659659
{
@@ -1016,7 +1016,7 @@ var Group = new Class({
10161016
* @param {string} key - The string-based key of the animation to play.
10171017
* @param {string} [startFrame=0] - Optionally start the animation playing from this frame index.
10181018
*
1019-
* @return {Phaser.GameObjects.Group} This Group object.
1019+
* @return {this} This Group object.
10201020
*/
10211021
playAnimation: function (key, startFrame)
10221022
{
@@ -1115,7 +1115,7 @@ var Group = new Class({
11151115
* @param {integer} [index=0] - An optional offset to start searching from within the items array.
11161116
* @param {integer} [direction=1] - The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.
11171117
*
1118-
* @return {Phaser.GameObjects.Group} This Group object.
1118+
* @return {this} This Group object.
11191119
*/
11201120
propertyValueSet: function (key, value, step, index, direction)
11211121
{
@@ -1136,7 +1136,7 @@ var Group = new Class({
11361136
* @param {integer} [index=0] - An optional offset to start searching from within the items array.
11371137
* @param {integer} [direction=1] - The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.
11381138
*
1139-
* @return {Phaser.GameObjects.Group} This Group object.
1139+
* @return {this} This Group object.
11401140
*/
11411141
propertyValueInc: function (key, value, step, index, direction)
11421142
{
@@ -1154,7 +1154,7 @@ var Group = new Class({
11541154
* @param {number} value - The amount to set the property to.
11551155
* @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter.
11561156
*
1157-
* @return {Phaser.GameObjects.Group} This Group object.
1157+
* @return {this} This Group object.
11581158
*/
11591159
setX: function (value, step)
11601160
{
@@ -1172,7 +1172,7 @@ var Group = new Class({
11721172
* @param {number} value - The amount to set the property to.
11731173
* @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter.
11741174
*
1175-
* @return {Phaser.GameObjects.Group} This Group object.
1175+
* @return {this} This Group object.
11761176
*/
11771177
setY: function (value, step)
11781178
{
@@ -1192,7 +1192,7 @@ var Group = new Class({
11921192
* @param {number} [stepX=0] - This is added to the `x` amount, multiplied by the iteration counter.
11931193
* @param {number} [stepY=0] - This is added to the `y` amount, multiplied by the iteration counter.
11941194
*
1195-
* @return {Phaser.GameObjects.Group} This Group object.
1195+
* @return {this} This Group object.
11961196
*/
11971197
setXY: function (x, y, stepX, stepY)
11981198
{
@@ -1210,7 +1210,7 @@ var Group = new Class({
12101210
* @param {number} value - The amount to be added to the `x` property.
12111211
* @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter.
12121212
*
1213-
* @return {Phaser.GameObjects.Group} This Group object.
1213+
* @return {this} This Group object.
12141214
*/
12151215
incX: function (value, step)
12161216
{
@@ -1228,7 +1228,7 @@ var Group = new Class({
12281228
* @param {number} value - The amount to be added to the `y` property.
12291229
* @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter.
12301230
*
1231-
* @return {Phaser.GameObjects.Group} This Group object.
1231+
* @return {this} This Group object.
12321232
*/
12331233
incY: function (value, step)
12341234
{
@@ -1248,7 +1248,7 @@ var Group = new Class({
12481248
* @param {number} [stepX=0] - This is added to the `x` amount, multiplied by the iteration counter.
12491249
* @param {number} [stepY=0] - This is added to the `y` amount, multiplied by the iteration counter.
12501250
*
1251-
* @return {Phaser.GameObjects.Group} This Group object.
1251+
* @return {this} This Group object.
12521252
*/
12531253
incXY: function (x, y, stepX, stepY)
12541254
{
@@ -1270,7 +1270,7 @@ var Group = new Class({
12701270
* @param {number} y - The y coordinate to place the first item in the array at.
12711271
* @param {integer} [direction=0] - The iteration direction. 0 = first to last and 1 = last to first.
12721272
*
1273-
* @return {Phaser.GameObjects.Group} This Group object.
1273+
* @return {this} This Group object.
12741274
*/
12751275
shiftPosition: function (x, y, direction)
12761276
{
@@ -1288,7 +1288,7 @@ var Group = new Class({
12881288
* @param {number} value - The amount to set the angle to, in degrees.
12891289
* @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter.
12901290
*
1291-
* @return {Phaser.GameObjects.Group} This Group object.
1291+
* @return {this} This Group object.
12921292
*/
12931293
angle: function (value, step)
12941294
{
@@ -1306,7 +1306,7 @@ var Group = new Class({
13061306
* @param {number} value - The amount to set the rotation to, in radians.
13071307
* @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter.
13081308
*
1309-
* @return {Phaser.GameObjects.Group} This Group object.
1309+
* @return {this} This Group object.
13101310
*/
13111311
rotate: function (value, step)
13121312
{
@@ -1324,7 +1324,7 @@ var Group = new Class({
13241324
* @param {Phaser.Types.Math.Vector2Like} point - Any object with public `x` and `y` properties.
13251325
* @param {number} angle - The angle to rotate by, in radians.
13261326
*
1327-
* @return {Phaser.GameObjects.Group} This Group object.
1327+
* @return {this} This Group object.
13281328
*/
13291329
rotateAround: function (point, angle)
13301330
{
@@ -1343,7 +1343,7 @@ var Group = new Class({
13431343
* @param {number} angle - The angle to rotate by, in radians.
13441344
* @param {number} distance - The distance from the point of rotation in pixels.
13451345
*
1346-
* @return {Phaser.GameObjects.Group} This Group object.
1346+
* @return {this} This Group object.
13471347
*/
13481348
rotateAroundDistance: function (point, angle, distance)
13491349
{
@@ -1361,7 +1361,7 @@ var Group = new Class({
13611361
* @param {number} value - The amount to set the alpha to.
13621362
* @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter.
13631363
*
1364-
* @return {Phaser.GameObjects.Group} This Group object.
1364+
* @return {this} This Group object.
13651365
*/
13661366
setAlpha: function (value, step)
13671367
{
@@ -1381,7 +1381,7 @@ var Group = new Class({
13811381
* @param {number} [bottomLeft] - The tint to be applied to the bottom-left corner of item.
13821382
* @param {number} [bottomRight] - The tint to be applied to the bottom-right corner of item.
13831383
*
1384-
* @return {Phaser.GameObjects.Group} This Group object.
1384+
* @return {this} This Group object.
13851385
*/
13861386
setTint: function (topLeft, topRight, bottomLeft, bottomRight)
13871387
{
@@ -1401,7 +1401,7 @@ var Group = new Class({
14011401
* @param {number} [stepX=0] - This is added to the `originX` amount, multiplied by the iteration counter.
14021402
* @param {number} [stepY=0] - This is added to the `originY` amount, multiplied by the iteration counter.
14031403
*
1404-
* @return {Phaser.GameObjects.Group} This Group object.
1404+
* @return {this} This Group object.
14051405
*/
14061406
setOrigin: function (originX, originY, stepX, stepY)
14071407
{
@@ -1419,7 +1419,7 @@ var Group = new Class({
14191419
* @param {number} value - The amount to set the property to.
14201420
* @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter.
14211421
*
1422-
* @return {Phaser.GameObjects.Group} This Group object.
1422+
* @return {this} This Group object.
14231423
*/
14241424
scaleX: function (value, step)
14251425
{
@@ -1437,7 +1437,7 @@ var Group = new Class({
14371437
* @param {number} value - The amount to set the property to.
14381438
* @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter.
14391439
*
1440-
* @return {Phaser.GameObjects.Group} This Group object.
1440+
* @return {this} This Group object.
14411441
*/
14421442
scaleY: function (value, step)
14431443
{
@@ -1457,7 +1457,7 @@ var Group = new Class({
14571457
* @param {number} [stepX=0] - This is added to the `scaleX` amount, multiplied by the iteration counter.
14581458
* @param {number} [stepY=0] - This is added to the `scaleY` amount, multiplied by the iteration counter.
14591459
*
1460-
* @return {Phaser.GameObjects.Group} This Group object.
1460+
* @return {this} This Group object.
14611461
*/
14621462
scaleXY: function (scaleX, scaleY, stepX, stepY)
14631463
{
@@ -1475,7 +1475,7 @@ var Group = new Class({
14751475
* @param {number} value - The amount to set the property to.
14761476
* @param {number} [step=0] - This is added to the `value` amount, multiplied by the iteration counter.
14771477
*
1478-
* @return {Phaser.GameObjects.Group} This Group object.
1478+
* @return {this} This Group object.
14791479
*/
14801480
setDepth: function (value, step)
14811481
{
@@ -1492,7 +1492,7 @@ var Group = new Class({
14921492
*
14931493
* @param {number} value - The amount to set the property to.
14941494
*
1495-
* @return {Phaser.GameObjects.Group} This Group object.
1495+
* @return {this} This Group object.
14961496
*/
14971497
setBlendMode: function (value)
14981498
{
@@ -1510,7 +1510,7 @@ var Group = new Class({
15101510
* @param {*} hitArea - Either an input configuration object, or a geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.
15111511
* @param {Phaser.Types.Input.HitAreaCallback} hitAreaCallback - A callback to be invoked when the Game Object is interacted with. If you provide a shape you must also provide a callback.
15121512
*
1513-
* @return {Phaser.GameObjects.Group} This Group object.
1513+
* @return {this} This Group object.
15141514
*/
15151515
setHitArea: function (hitArea, hitAreaCallback)
15161516
{
@@ -1525,7 +1525,7 @@ var Group = new Class({
15251525
* @method Phaser.GameObjects.Group#shuffle
15261526
* @since 3.21.0
15271527
*
1528-
* @return {Phaser.GameObjects.Group} This Group object.
1528+
* @return {this} This Group object.
15291529
*/
15301530
shuffle: function ()
15311531
{
@@ -1577,7 +1577,7 @@ var Group = new Class({
15771577
* @param {integer} [index=0] - An optional offset to start searching from within the items array.
15781578
* @param {integer} [direction=1] - The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning.
15791579
*
1580-
* @return {Phaser.GameObjects.Group} This Group object.
1580+
* @return {this} This Group object.
15811581
*/
15821582
setVisible: function (value, index, direction)
15831583
{
@@ -1592,7 +1592,7 @@ var Group = new Class({
15921592
* @method Phaser.GameObjects.Group#toggleVisible
15931593
* @since 3.0.0
15941594
*
1595-
* @return {Phaser.GameObjects.Group} This Group object.
1595+
* @return {this} This Group object.
15961596
*/
15971597
toggleVisible: function ()
15981598
{

0 commit comments

Comments
 (0)