Fixed this return types for Phaser.GameObjects.Container

Author: JasonHK

src/gameobjects/container/Container.js

@@ -347,7 +347,7 @@ var Container = new Class({
      *
      * @param {boolean} [value=true] - The exclusive state of this Container.
      *
-     * @return {Phaser.GameObjects.Container} This Container.
+     * @return {this} This Container.
      */
     setExclusive: function (value)
     {
@@ -508,7 +508,7 @@ var Container = new Class({
      *
      * @param {Phaser.GameObjects.GameObject|Phaser.GameObjects.GameObject[]} child - The Game Object, or array of Game Objects, to add to the Container.
      *
-     * @return {Phaser.GameObjects.Container} This Container instance.
+     * @return {this} This Container instance.
      */
     add: function (child)
     {
@@ -530,7 +530,7 @@ var Container = new Class({
      * @param {Phaser.GameObjects.GameObject|Phaser.GameObjects.GameObject[]} child - The Game Object, or array of Game Objects, to add to the Container.
      * @param {integer} [index=0] - The position to insert the Game Object/s at.
      *
-     * @return {Phaser.GameObjects.Container} This Container instance.
+     * @return {this} This Container instance.
      */
     addAt: function (child, index)
     {
@@ -579,7 +579,7 @@ var Container = new Class({
      * @param {string} property - The property to lexically sort by.
      * @param {function} [handler] - Provide your own custom handler function. Will receive 2 children which it should compare and return a boolean.
      *
-     * @return {Phaser.GameObjects.Container} This Container instance.
+     * @return {this} This Container instance.
      */
     sort: function (property, handler)
     {
@@ -721,7 +721,7 @@ var Container = new Class({
      * @param {Phaser.GameObjects.GameObject} child1 - The first Game Object to swap.
      * @param {Phaser.GameObjects.GameObject} child2 - The second Game Object to swap.
      *
-     * @return {Phaser.GameObjects.Container} This Container instance.
+     * @return {this} This Container instance.
      */
     swap: function (child1, child2)
     {
@@ -744,7 +744,7 @@ var Container = new Class({
      * @param {Phaser.GameObjects.GameObject} child - The Game Object to move.
      * @param {integer} index - The new position of the Game Object in this Container.
      *
-     * @return {Phaser.GameObjects.Container} This Container instance.
+     * @return {this} This Container instance.
      */
     moveTo: function (child, index)
     {
@@ -766,7 +766,7 @@ var Container = new Class({
      * @param {Phaser.GameObjects.GameObject|Phaser.GameObjects.GameObject[]} child - The Game Object, or array of Game Objects, to be removed from the Container.
      * @param {boolean} [destroyChild=false] - Optionally call `destroy` on each child successfully removed from this Container.
      *
-     * @return {Phaser.GameObjects.Container} This Container instance.
+     * @return {this} This Container instance.
      */
     remove: function (child, destroyChild)
     {
@@ -799,7 +799,7 @@ var Container = new Class({
      * @param {integer} index - The index of the Game Object to be removed.
      * @param {boolean} [destroyChild=false] - Optionally call `destroy` on the Game Object if successfully removed from this Container.
      *
-     * @return {Phaser.GameObjects.Container} This Container instance.
+     * @return {this} This Container instance.
      */
     removeAt: function (index, destroyChild)
     {
@@ -825,7 +825,7 @@ var Container = new Class({
      * @param {integer} [endIndex=Container.length] - An optional end index to search up to (but not included)
      * @param {boolean} [destroyChild=false] - Optionally call `destroy` on each Game Object successfully removed from this Container.
      *
-     * @return {Phaser.GameObjects.Container} This Container instance.
+     * @return {this} This Container instance.
      */
     removeBetween: function (startIndex, endIndex, destroyChild)
     {
@@ -852,7 +852,7 @@ var Container = new Class({
      *
      * @param {boolean} [destroyChild=false] - Optionally call `destroy` on each Game Object successfully removed from this Container.
      *
-     * @return {Phaser.GameObjects.Container} This Container instance.
+     * @return {this} This Container instance.
      */
     removeAll: function (destroyChild)
     {
@@ -878,7 +878,7 @@ var Container = new Class({
      *
      * @param {Phaser.GameObjects.GameObject} child - The Game Object to bring to the top of the Container.
      *
-     * @return {Phaser.GameObjects.Container} This Container instance.
+     * @return {this} This Container instance.
      */
     bringToTop: function (child)
     {
@@ -896,7 +896,7 @@ var Container = new Class({
      *
      * @param {Phaser.GameObjects.GameObject} child - The Game Object to send to the bottom of the Container.
      *
-     * @return {Phaser.GameObjects.Container} This Container instance.
+     * @return {this} This Container instance.
      */
     sendToBack: function (child)
     {
@@ -913,7 +913,7 @@ var Container = new Class({
      *
      * @param {Phaser.GameObjects.GameObject} child - The Game Object to be moved in the Container.
      *
-     * @return {Phaser.GameObjects.Container} This Container instance.
+     * @return {this} This Container instance.
      */
     moveUp: function (child)
     {
@@ -930,7 +930,7 @@ var Container = new Class({
      *
      * @param {Phaser.GameObjects.GameObject} child - The Game Object to be moved in the Container.
      *
-     * @return {Phaser.GameObjects.Container} This Container instance.
+     * @return {this} This Container instance.
      */
     moveDown: function (child)
     {
@@ -945,7 +945,7 @@ var Container = new Class({
      * @method Phaser.GameObjects.Container#reverse
      * @since 3.4.0
      *
-     * @return {Phaser.GameObjects.Container} This Container instance.
+     * @return {this} This Container instance.
      */
     reverse: function ()
     {
@@ -960,7 +960,7 @@ var Container = new Class({
      * @method Phaser.GameObjects.Container#shuffle
      * @since 3.4.0
      *
-     * @return {Phaser.GameObjects.Container} This Container instance.
+     * @return {this} This Container instance.
      */
     shuffle: function ()
     {
@@ -980,7 +980,7 @@ var Container = new Class({
      * @param {Phaser.GameObjects.GameObject} newChild - The Game Object to be added to this Container.
      * @param {boolean} [destroyChild=false] - Optionally call `destroy` on the Game Object if successfully removed from this Container.
      *
-     * @return {Phaser.GameObjects.Container} This Container instance.
+     * @return {this} This Container instance.
      */
     replace: function (oldChild, newChild, destroyChild)
     {
@@ -1032,7 +1032,7 @@ var Container = new Class({
      * @param {integer} [startIndex=0] - An optional start index to search from.
      * @param {integer} [endIndex=Container.length] - An optional end index to search up to (but not included)
      *
-     * @return {Phaser.GameObjects.Container} This Container instance.
+     * @return {this} This Container instance.
      */
     setAll: function (property, value, startIndex, endIndex)
     {
@@ -1065,7 +1065,7 @@ var Container = new Class({
      * @param {object} [context] - Value to use as `this` when executing callback.
      * @param {...*} [args] - Additional arguments that will be passed to the callback, after the child.
      *
-     * @return {Phaser.GameObjects.Container} This Container instance.
+     * @return {this} This Container instance.
      */
     each: function (callback, context)
     {
@@ -1102,7 +1102,7 @@ var Container = new Class({
      * @param {object} [context] - Value to use as `this` when executing callback.
      * @param {...*} [args] - Additional arguments that will be passed to the callback, after the child.
      *
-     * @return {Phaser.GameObjects.Container} This Container instance.
+     * @return {this} This Container instance.
      */
     iterate: function (callback, context)
     {

types/phaser.d.ts

@@ -12329,7 +12329,7 @@ declare namespace Phaser {
              * display list, but are being replicated where-ever this Container is.
              * @param value The exclusive state of this Container. Default true.
              */
-            setExclusive(value?: boolean): Phaser.GameObjects.Container;
+            setExclusive(value?: boolean): this;
 
             /**
              * Gets the bounds of this Container. It works by iterating all children of the Container,
@@ -12368,7 +12368,7 @@ declare namespace Phaser {
              * Each Game Object must be unique within the Container.
              * @param child The Game Object, or array of Game Objects, to add to the Container.
              */
-            add(child: Phaser.GameObjects.GameObject | Phaser.GameObjects.GameObject[]): Phaser.GameObjects.Container;
+            add(child: Phaser.GameObjects.GameObject | Phaser.GameObjects.GameObject[]): this;
 
             /**
              * Adds the given Game Object, or array of Game Objects, to this Container at the specified position.
@@ -12379,7 +12379,7 @@ declare namespace Phaser {
              * @param child The Game Object, or array of Game Objects, to add to the Container.
              * @param index The position to insert the Game Object/s at. Default 0.
              */
-            addAt(child: Phaser.GameObjects.GameObject | Phaser.GameObjects.GameObject[], index?: integer): Phaser.GameObjects.Container;
+            addAt(child: Phaser.GameObjects.GameObject | Phaser.GameObjects.GameObject[], index?: integer): this;
 
             /**
              * Returns the Game Object at the given position in this Container.
@@ -12399,7 +12399,7 @@ declare namespace Phaser {
              * @param property The property to lexically sort by.
              * @param handler Provide your own custom handler function. Will receive 2 children which it should compare and return a boolean.
              */
-            sort(property: string, handler?: Function): Phaser.GameObjects.Container;
+            sort(property: string, handler?: Function): this;
 
             /**
              * Searches for the first instance of a child with its `name` property matching the given argument.
@@ -12472,7 +12472,7 @@ declare namespace Phaser {
              * @param child1 The first Game Object to swap.
              * @param child2 The second Game Object to swap.
              */
-            swap(child1: Phaser.GameObjects.GameObject, child2: Phaser.GameObjects.GameObject): Phaser.GameObjects.Container;
+            swap(child1: Phaser.GameObjects.GameObject, child2: Phaser.GameObjects.GameObject): this;
 
             /**
              * Moves a Game Object to a new position within this Container.
@@ -12484,7 +12484,7 @@ declare namespace Phaser {
              * @param child The Game Object to move.
              * @param index The new position of the Game Object in this Container.
              */
-            moveTo(child: Phaser.GameObjects.GameObject, index: integer): Phaser.GameObjects.Container;
+            moveTo(child: Phaser.GameObjects.GameObject, index: integer): this;
 
             /**
              * Removes the given Game Object, or array of Game Objects, from this Container.
@@ -12495,7 +12495,7 @@ declare namespace Phaser {
              * @param child The Game Object, or array of Game Objects, to be removed from the Container.
              * @param destroyChild Optionally call `destroy` on each child successfully removed from this Container. Default false.
              */
-            remove(child: Phaser.GameObjects.GameObject | Phaser.GameObjects.GameObject[], destroyChild?: boolean): Phaser.GameObjects.Container;
+            remove(child: Phaser.GameObjects.GameObject | Phaser.GameObjects.GameObject[], destroyChild?: boolean): this;
 
             /**
              * Removes the Game Object at the given position in this Container.
@@ -12504,7 +12504,7 @@ declare namespace Phaser {
              * @param index The index of the Game Object to be removed.
              * @param destroyChild Optionally call `destroy` on the Game Object if successfully removed from this Container. Default false.
              */
-            removeAt(index: integer, destroyChild?: boolean): Phaser.GameObjects.Container;
+            removeAt(index: integer, destroyChild?: boolean): this;
 
             /**
              * Removes the Game Objects between the given positions in this Container.
@@ -12514,51 +12514,51 @@ declare namespace Phaser {
              * @param endIndex An optional end index to search up to (but not included) Default Container.length.
              * @param destroyChild Optionally call `destroy` on each Game Object successfully removed from this Container. Default false.
              */
-            removeBetween(startIndex?: integer, endIndex?: integer, destroyChild?: boolean): Phaser.GameObjects.Container;
+            removeBetween(startIndex?: integer, endIndex?: integer, destroyChild?: boolean): this;
 
             /**
              * Removes all Game Objects from this Container.
              * 
              * You can also optionally call `destroy` on each Game Object that is removed from the Container.
              * @param destroyChild Optionally call `destroy` on each Game Object successfully removed from this Container. Default false.
              */
-            removeAll(destroyChild?: boolean): Phaser.GameObjects.Container;
+            removeAll(destroyChild?: boolean): this;
 
             /**
              * Brings the given Game Object to the top of this Container.
              * This will cause it to render on-top of any other objects in the Container.
              * @param child The Game Object to bring to the top of the Container.
              */
-            bringToTop(child: Phaser.GameObjects.GameObject): Phaser.GameObjects.Container;
+            bringToTop(child: Phaser.GameObjects.GameObject): this;
 
             /**
              * Sends the given Game Object to the bottom of this Container.
              * This will cause it to render below any other objects in the Container.
              * @param child The Game Object to send to the bottom of the Container.
              */
-            sendToBack(child: Phaser.GameObjects.GameObject): Phaser.GameObjects.Container;
+            sendToBack(child: Phaser.GameObjects.GameObject): this;
 
             /**
              * Moves the given Game Object up one place in this Container, unless it's already at the top.
              * @param child The Game Object to be moved in the Container.
              */
-            moveUp(child: Phaser.GameObjects.GameObject): Phaser.GameObjects.Container;
+            moveUp(child: Phaser.GameObjects.GameObject): this;
 
             /**
              * Moves the given Game Object down one place in this Container, unless it's already at the bottom.
              * @param child The Game Object to be moved in the Container.
              */
-            moveDown(child: Phaser.GameObjects.GameObject): Phaser.GameObjects.Container;
+            moveDown(child: Phaser.GameObjects.GameObject): this;
 
             /**
              * Reverses the order of all Game Objects in this Container.
              */
-            reverse(): Phaser.GameObjects.Container;
+            reverse(): this;
 
             /**
              * Shuffles the all Game Objects in this Container using the Fisher-Yates implementation.
              */
-            shuffle(): Phaser.GameObjects.Container;
+            shuffle(): this;
 
             /**
              * Replaces a Game Object in this Container with the new Game Object.
@@ -12567,7 +12567,7 @@ declare namespace Phaser {
              * @param newChild The Game Object to be added to this Container.
              * @param destroyChild Optionally call `destroy` on the Game Object if successfully removed from this Container. Default false.
              */
-            replace(oldChild: Phaser.GameObjects.GameObject, newChild: Phaser.GameObjects.GameObject, destroyChild?: boolean): Phaser.GameObjects.Container;
+            replace(oldChild: Phaser.GameObjects.GameObject, newChild: Phaser.GameObjects.GameObject, destroyChild?: boolean): this;
 
             /**
              * Returns `true` if the given Game Object is a direct child of this Container.
@@ -12588,7 +12588,7 @@ declare namespace Phaser {
              * @param startIndex An optional start index to search from. Default 0.
              * @param endIndex An optional end index to search up to (but not included) Default Container.length.
              */
-            setAll(property: string, value: any, startIndex?: integer, endIndex?: integer): Phaser.GameObjects.Container;
+            setAll(property: string, value: any, startIndex?: integer, endIndex?: integer): this;
 
             /**
              * Passes all Game Objects in this Container to the given callback.
@@ -12602,7 +12602,7 @@ declare namespace Phaser {
              * @param context Value to use as `this` when executing callback.
              * @param args Additional arguments that will be passed to the callback, after the child.
              */
-            each(callback: Function, context?: object, ...args: any[]): Phaser.GameObjects.Container;
+            each(callback: Function, context?: object, ...args: any[]): this;
 
             /**
              * Passes all Game Objects in this Container to the given callback.
@@ -12613,7 +12613,7 @@ declare namespace Phaser {
              * @param context Value to use as `this` when executing callback.
              * @param args Additional arguments that will be passed to the callback, after the child.
              */
-            iterate(callback: Function, context?: object, ...args: any[]): Phaser.GameObjects.Container;
+            iterate(callback: Function, context?: object, ...args: any[]): this;
 
             /**
              * Sets the scroll factor of this Container and optionally all of its children.