Change Group.* return types from GameObject to any

thomastanck · thomastanck · commit 0fa334ff3ec9 · 2018-05-22T12:05:52.000+08:00
diff --git a/src/gameobjects/group/Group.js b/src/gameobjects/group/Group.js
@@ -260,7 +260,7 @@ var Group = new Class({
      * @param {boolean} [visible=true] - The {@link Phaser.GameObjects.Components.Visible#visible} state of the new Game Object.
      * @param {boolean} [active=true] - The {@link Phaser.GameObjects.GameObject#active} state of the new Game Object.
      *
-     * @return {Phaser.GameObjects.GameObject} The new Game Object.
+     * @return {any} The new Game Object (usually a Sprite, etc.).
      */
     create: function (x, y, key, frame, visible, active)
     {
@@ -306,7 +306,7 @@ var Group = new Class({
      *
      * @param {GroupCreateConfig|GroupCreateConfig[]} config - Creation settings. This can be a single configuration object or an array of such objects, which will be applied in turn.
      *
-     * @return {Phaser.GameObjects.GameObject[]} The newly created Game Objects.
+     * @return {any[]} The newly created Game Objects.
      */
     createMultiple: function (config)
     {
@@ -345,7 +345,7 @@ var Group = new Class({
      *
      * @param {GroupCreateConfig} options - Creation settings.
      *
-     * @return {Phaser.GameObjects.GameObject[]} The newly created Game Objects.
+     * @return {any[]} The newly created Game Objects.
      */
     createFromConfig: function (options)
     {
@@ -719,7 +719,7 @@ var Group = new Class({
      * @param {(string|integer)} [frame=defaultFrame] - A texture frame assigned to a new Game Object (if one is created).
      * @param {boolean} [visible=true] - The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).
      *
-     * @return {?Phaser.GameObjects.GameObject} The first matching group member, or a newly created member, or null.
+     * @return {?any} The first matching group member, or a newly created member, or null.
      */
     getFirst: function (state, createIfNull, x, y, key, frame, visible)
     {
@@ -745,7 +745,7 @@ var Group = new Class({
      * @param {(string|integer)} [frame=defaultFrame] - A texture frame assigned to a new Game Object (if one is created).
      * @param {boolean} [visible=true] - The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).
      *
-     * @return {?Phaser.GameObjects.GameObject} The first matching group member, or a newly created member, or null.
+     * @return {?any} The first matching group member, or a newly created member, or null.
      */
     getFirstNth: function (nth, state, createIfNull, x, y, key, frame, visible)
     {
@@ -770,7 +770,7 @@ var Group = new Class({
      * @param {(string|integer)} [frame=defaultFrame] - A texture frame assigned to a new Game Object (if one is created).
      * @param {boolean} [visible=true] - The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).
      *
-     * @return {?Phaser.GameObjects.GameObject} The first matching group member, or a newly created member, or null.
+     * @return {?any} The first matching group member, or a newly created member, or null.
      */
     getLast: function (state, createIfNull, x, y, key, frame, visible)
     {
@@ -796,7 +796,7 @@ var Group = new Class({
      * @param {(string|integer)} [frame=defaultFrame] - A texture frame assigned to a new Game Object (if one is created).
      * @param {boolean} [visible=true] - The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).
      *
-     * @return {?Phaser.GameObjects.GameObject} The first matching group member, or a newly created member, or null.
+     * @return {?any} The first matching group member, or a newly created member, or null.
      */
     getLastNth: function (nth, state, createIfNull, x, y, key, frame, visible)
     {
@@ -824,7 +824,7 @@ var Group = new Class({
      * @param {(string|integer)} [frame=defaultFrame] - A texture frame assigned to a new Game Object (if one is created).
      * @param {boolean} [visible=true] - The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).
      *
-     * @return {?Phaser.GameObjects.GameObject} The first matching group member, or a newly created member, or null.
+     * @return {?any} The first matching group member, or a newly created member, or null.
      */
     getHandler: function (forwards, nth, state, createIfNull, x, y, key, frame, visible)
     {
@@ -923,7 +923,7 @@ var Group = new Class({
      * @param {(string|integer)} [frame=defaultFrame] - A texture frame assigned to a new Game Object (if one is created).
      * @param {boolean} [visible=true] - The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).
      *
-     * @return {?Phaser.GameObjects.GameObject} The first inactive group member, or a newly created member, or null.
+     * @return {?any} The first inactive group member, or a newly created member, or null.
      */
     get: function (x, y, key, frame, visible)
     {
@@ -947,7 +947,7 @@ var Group = new Class({
      * @param {(string|integer)} [frame=defaultFrame] - A texture frame assigned to a new Game Object (if one is created).
      * @param {boolean} [visible=true] - The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).
      *
-     * @return {Phaser.GameObjects.GameObject} The first active group member, or a newly created member, or null.
+     * @return {any} The first active group member, or a newly created member, or null.
      */
     getFirstAlive: function (createIfNull, x, y, key, frame, visible)
     {
@@ -972,7 +972,7 @@ var Group = new Class({
      * @param {(string|integer)} [frame=defaultFrame] - A texture frame assigned to a new Game Object (if one is created).
      * @param {boolean} [visible=true] - The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).
      *
-     * @return {Phaser.GameObjects.GameObject} The first inactive group member, or a newly created member, or null.
+     * @return {any} The first inactive group member, or a newly created member, or null.
      */
     getFirstDead: function (createIfNull, x, y, key, frame, visible)
     {

Original file line number	Diff line number	Diff line change
`@@ -260,7 +260,7 @@ var Group = new Class({`
`260`	`260`	`* @param {boolean} [visible=true] - The {@link Phaser.GameObjects.Components.Visible#visible} state of the new Game Object.`
`261`	`261`	`* @param {boolean} [active=true] - The {@link Phaser.GameObjects.GameObject#active} state of the new Game Object.`
`262`	`262`	`*`
`263`		`- * @return {Phaser.GameObjects.GameObject} The new Game Object.`
	`263`	`+ * @return {any} The new Game Object (usually a Sprite, etc.).`
`264`	`264`	`*/`
`265`	`265`	`create: function (x, y, key, frame, visible, active)`
`266`	`266`	`{`
`@@ -306,7 +306,7 @@ var Group = new Class({`
`306`	`306`	`*`
`307`	`307`	`* @param {GroupCreateConfig\|GroupCreateConfig[]} config - Creation settings. This can be a single configuration object or an array of such objects, which will be applied in turn.`
`308`	`308`	`*`
`309`		`- * @return {Phaser.GameObjects.GameObject[]} The newly created Game Objects.`
	`309`	`+ * @return {any[]} The newly created Game Objects.`
`310`	`310`	`*/`
`311`	`311`	`createMultiple: function (config)`
`312`	`312`	`{`
`@@ -345,7 +345,7 @@ var Group = new Class({`
`345`	`345`	`*`
`346`	`346`	`* @param {GroupCreateConfig} options - Creation settings.`
`347`	`347`	`*`
`348`		`- * @return {Phaser.GameObjects.GameObject[]} The newly created Game Objects.`
	`348`	`+ * @return {any[]} The newly created Game Objects.`
`349`	`349`	`*/`
`350`	`350`	`createFromConfig: function (options)`
`351`	`351`	`{`
`@@ -719,7 +719,7 @@ var Group = new Class({`
`719`	`719`	`* @param {(string\|integer)} [frame=defaultFrame] - A texture frame assigned to a new Game Object (if one is created).`
`720`	`720`	`* @param {boolean} [visible=true] - The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).`
`721`	`721`	`*`
`722`		`- * @return {?Phaser.GameObjects.GameObject} The first matching group member, or a newly created member, or null.`
	`722`	`+ * @return {?any} The first matching group member, or a newly created member, or null.`
`723`	`723`	`*/`
`724`	`724`	`getFirst: function (state, createIfNull, x, y, key, frame, visible)`
`725`	`725`	`{`
`@@ -745,7 +745,7 @@ var Group = new Class({`
`745`	`745`	`* @param {(string\|integer)} [frame=defaultFrame] - A texture frame assigned to a new Game Object (if one is created).`
`746`	`746`	`* @param {boolean} [visible=true] - The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).`
`747`	`747`	`*`
`748`		`- * @return {?Phaser.GameObjects.GameObject} The first matching group member, or a newly created member, or null.`
	`748`	`+ * @return {?any} The first matching group member, or a newly created member, or null.`
`749`	`749`	`*/`
`750`	`750`	`getFirstNth: function (nth, state, createIfNull, x, y, key, frame, visible)`
`751`	`751`	`{`
`@@ -770,7 +770,7 @@ var Group = new Class({`
`770`	`770`	`* @param {(string\|integer)} [frame=defaultFrame] - A texture frame assigned to a new Game Object (if one is created).`
`771`	`771`	`* @param {boolean} [visible=true] - The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).`
`772`	`772`	`*`
`773`		`- * @return {?Phaser.GameObjects.GameObject} The first matching group member, or a newly created member, or null.`
	`773`	`+ * @return {?any} The first matching group member, or a newly created member, or null.`
`774`	`774`	`*/`
`775`	`775`	`getLast: function (state, createIfNull, x, y, key, frame, visible)`
`776`	`776`	`{`
`@@ -796,7 +796,7 @@ var Group = new Class({`
`796`	`796`	`* @param {(string\|integer)} [frame=defaultFrame] - A texture frame assigned to a new Game Object (if one is created).`
`797`	`797`	`* @param {boolean} [visible=true] - The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).`
`798`	`798`	`*`
`799`		`- * @return {?Phaser.GameObjects.GameObject} The first matching group member, or a newly created member, or null.`
	`799`	`+ * @return {?any} The first matching group member, or a newly created member, or null.`
`800`	`800`	`*/`
`801`	`801`	`getLastNth: function (nth, state, createIfNull, x, y, key, frame, visible)`
`802`	`802`	`{`
`@@ -824,7 +824,7 @@ var Group = new Class({`
`824`	`824`	`* @param {(string\|integer)} [frame=defaultFrame] - A texture frame assigned to a new Game Object (if one is created).`
`825`	`825`	`* @param {boolean} [visible=true] - The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).`
`826`	`826`	`*`
`827`		`- * @return {?Phaser.GameObjects.GameObject} The first matching group member, or a newly created member, or null.`
	`827`	`+ * @return {?any} The first matching group member, or a newly created member, or null.`
`828`	`828`	`*/`
`829`	`829`	`getHandler: function (forwards, nth, state, createIfNull, x, y, key, frame, visible)`
`830`	`830`	`{`
`@@ -923,7 +923,7 @@ var Group = new Class({`
`923`	`923`	`* @param {(string\|integer)} [frame=defaultFrame] - A texture frame assigned to a new Game Object (if one is created).`
`924`	`924`	`* @param {boolean} [visible=true] - The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).`
`925`	`925`	`*`
`926`		`- * @return {?Phaser.GameObjects.GameObject} The first inactive group member, or a newly created member, or null.`
	`926`	`+ * @return {?any} The first inactive group member, or a newly created member, or null.`
`927`	`927`	`*/`
`928`	`928`	`get: function (x, y, key, frame, visible)`
`929`	`929`	`{`
`@@ -947,7 +947,7 @@ var Group = new Class({`
`947`	`947`	`* @param {(string\|integer)} [frame=defaultFrame] - A texture frame assigned to a new Game Object (if one is created).`
`948`	`948`	`* @param {boolean} [visible=true] - The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).`
`949`	`949`	`*`
`950`		`- * @return {Phaser.GameObjects.GameObject} The first active group member, or a newly created member, or null.`
	`950`	`+ * @return {any} The first active group member, or a newly created member, or null.`
`951`	`951`	`*/`
`952`	`952`	`getFirstAlive: function (createIfNull, x, y, key, frame, visible)`
`953`	`953`	`{`
`@@ -972,7 +972,7 @@ var Group = new Class({`
`972`	`972`	`* @param {(string\|integer)} [frame=defaultFrame] - A texture frame assigned to a new Game Object (if one is created).`
`973`	`973`	`* @param {boolean} [visible=true] - The {@link Phaser.GameObjects.Components.Visible#visible} state of a new Game Object (if one is created).`
`974`	`974`	`*`
`975`		`- * @return {Phaser.GameObjects.GameObject} The first inactive group member, or a newly created member, or null.`
	`975`	`+ * @return {any} The first inactive group member, or a newly created member, or null.`
`976`	`976`	`*/`
`977`	`977`	`getFirstDead: function (createIfNull, x, y, key, frame, visible)`
`978`	`978`	`{`