Fix multiple types on GameObjects

Author: orblazer

src/gameobjects/bitmaptext/GetBitmapTextSize.js

@@ -10,8 +10,8 @@
  * @function GetBitmapTextSize
  * @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)
@@ -23,7 +23,7 @@ var GetBitmapTextSize = function (src, round)
     var by = Number.MAX_VALUE;
     var bw = 0;
     var bh = 0;
-    
+
     var chars = src.fontData.chars;
     var lineHeight = src.fontData.lineHeight;
 
@@ -92,7 +92,7 @@ var GetBitmapTextSize = function (src, round)
         {
             bw = gw;
         }
-        
+
         if (bh < gh)
         {
             bh = gh;

src/gameobjects/bitmaptext/dynamic/DynamicBitmapText.js

@@ -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.
      */

src/gameobjects/bitmaptext/dynamic/DynamicBitmapTextFactory.js

@@ -18,9 +18,9 @@ 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.
  */
 GameObjectFactory.register('dynamicBitmapText', function (x, y, font, text, size)
@@ -29,9 +29,9 @@ GameObjectFactory.register('dynamicBitmapText', function (x, y, font, text, size
 });
 
 //  When registering a factory function 'this' refers to the GameObjectFactory context.
-//  
+//
 //  There are several properties available to use:
-//  
+//
 //  this.scene - a reference to the Scene that owns the GameObjectFactory
 //  this.displayList - a reference to the Display List the Scene owns
 //  this.updateList - a reference to the Update List the Scene owns

src/gameobjects/bitmaptext/static/BitmapText.js

@@ -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.
      */

src/gameobjects/bitmaptext/static/BitmapTextFactory.js

@@ -18,9 +18,9 @@ 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.
  */
 GameObjectFactory.register('bitmapText', function (x, y, font, text, size)
@@ -29,9 +29,9 @@ GameObjectFactory.register('bitmapText', function (x, y, font, text, size)
 });
 
 //  When registering a factory function 'this' refers to the GameObjectFactory context.
-//  
+//
 //  There are several properties available to use:
-//  
+//
 //  this.scene - a reference to the Scene that owns the GameObjectFactory
 //  this.displayList - a reference to the Display List the Scene owns
 //  this.updateList - a reference to the Update List the Scene owns

src/gameobjects/blitter/Blitter.js

@@ -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.
      *

src/gameobjects/blitter/BlitterFactory.js

@@ -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.
  */

src/gameobjects/blitter/Bob.js

@@ -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;

src/gameobjects/components/Animation.js

@@ -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)
     {

src/gameobjects/components/BlendMode.js

@@ -9,7 +9,7 @@ var BlendModes = require('../../renderer/BlendModes');
 /**
  * Provides methods used for setting the blend mode of a Game Object.
  * Should be applied as a mixin and not used directly.
- * 
+ *
  * @name Phaser.GameObjects.Components.BlendMode
  * @since 3.0.0
  */
@@ -20,11 +20,11 @@ var BlendMode = {
 
     /**
      * Sets the Blend Mode being used by this Game Object.
-     * 
+     *
      * This can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)
-     * 
+     *
      * Under WebGL only the following Blend Modes are available:
-     * 
+     *
      * * ADD
      * * MULTIPLY
      * * SCREEN
@@ -37,9 +37,9 @@ var BlendMode = {
      * on support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these
      * reasons try to be careful about the construction of your Scene and the frequency of which blend modes
      * are used.
-     * 
+     *
      * @name Phaser.GameObjects.Components.BlendMode#blendMode
-     * @type {integer|string}
+     * @type {(integer|string)}
      * @since 3.0.0
      */
     blendMode: {
@@ -68,11 +68,11 @@ var BlendMode = {
 
     /**
      * Sets the Blend Mode being used by this Game Object.
-     * 
+     *
      * This can be a const, such as `Phaser.BlendModes.SCREEN`, or an integer, such as 4 (for Overlay)
-     * 
+     *
      * Under WebGL only the following Blend Modes are available:
-     * 
+     *
      * * ADD
      * * MULTIPLY
      * * SCREEN
@@ -85,12 +85,12 @@ var BlendMode = {
      * on support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these
      * reasons try to be careful about the construction of your Scene and the frequency of which blend modes
      * are used.
-     * 
+     *
      * @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.
      */
     setBlendMode: function (value)