Fix types on GameObjects

Author: orblazer

src/gameobjects/bitmaptext/dynamic/DynamicBitmapTextCreator.js

@@ -16,7 +16,7 @@ var GetAdvancedValue = require('../../../utils/object/GetAdvancedValue');
  * @property {string} [font=''] - [description]
  * @property {string} [text=''] - [description]
  * @property {(number|false)} [size=false] - [description]
- * @property {string} [align=''] - [description]
+ * @property {string} [align='left'] - [description]
  */
 
 /**

src/gameobjects/blitter/Blitter.js

@@ -99,7 +99,7 @@ var Blitter = new Class({
          * [description]
          *
          * @name Phaser.GameObjects.Blitter#renderList
-         * @type {array}
+         * @type {Phaser.GameObjects.Blitter.Bob[]}
          * @default []
          * @since 3.0.0
          */

src/gameobjects/components/BlendMode.js

@@ -39,7 +39,7 @@ var BlendMode = {
      * are used.
      *
      * @name Phaser.GameObjects.Components.BlendMode#blendMode
-     * @type {(integer|string)}
+     * @type {(Phaser.BlendModes|string)}
      * @since 3.0.0
      */
     blendMode: {
@@ -89,7 +89,7 @@ var BlendMode = {
      * @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|Phaser.BlendModes)} value - The BlendMode value. Either a string or a CONST.
      *
      * @return {Phaser.GameObjects.GameObject} This Game Object instance.
      */

src/gameobjects/components/GetBounds.js

@@ -24,6 +24,8 @@ var GetBounds = {
      * @method Phaser.GameObjects.Components.GetBounds#getCenter
      * @since 3.0.0
      *
+     * @generic {Phaser.Math.Vector2} O - [output,$return]
+     *
      * @param {(Phaser.Math.Vector2|object)} [output] - An object to store the values in. If not provided a new Vector2 will be created.
      *
      * @return {(Phaser.Math.Vector2|object)} The values stored in the output object.
@@ -44,6 +46,8 @@ var GetBounds = {
      * @method Phaser.GameObjects.Components.GetBounds#getTopLeft
      * @since 3.0.0
      *
+     * @generic {Phaser.Math.Vector2} O - [output,$return]
+     *
      * @param {(Phaser.Math.Vector2|object)} [output] - An object to store the values in. If not provided a new Vector2 will be created.
      *
      * @return {(Phaser.Math.Vector2|object)} The values stored in the output object.
@@ -69,6 +73,8 @@ var GetBounds = {
      * @method Phaser.GameObjects.Components.GetBounds#getTopRight
      * @since 3.0.0
      *
+     * @generic {Phaser.Math.Vector2} O - [output,$return]
+     *
      * @param {(Phaser.Math.Vector2|object)} [output] - An object to store the values in. If not provided a new Vector2 will be created.
      *
      * @return {(Phaser.Math.Vector2|object)} The values stored in the output object.
@@ -94,6 +100,8 @@ var GetBounds = {
      * @method Phaser.GameObjects.Components.GetBounds#getBottomLeft
      * @since 3.0.0
      *
+     * @generic {Phaser.Math.Vector2} O - [output,$return]
+     *
      * @param {(Phaser.Math.Vector2|object)} [output] - An object to store the values in. If not provided a new Vector2 will be created.
      *
      * @return {(Phaser.Math.Vector2|object)} The values stored in the output object.
@@ -119,6 +127,8 @@ var GetBounds = {
      * @method Phaser.GameObjects.Components.GetBounds#getBottomRight
      * @since 3.0.0
      *
+     * @generic {Phaser.Math.Vector2} O - [output,$return]
+     *
      * @param {(Phaser.Math.Vector2|object)} [output] - An object to store the values in. If not provided a new Vector2 will be created.
      *
      * @return {(Phaser.Math.Vector2|object)} The values stored in the output object.
@@ -145,6 +155,8 @@ var GetBounds = {
      * @method Phaser.GameObjects.Components.GetBounds#getBounds
      * @since 3.0.0
      *
+     * @generic {Phaser.Math.Vector2} O - [output,$return]
+     *
      * @param {(Phaser.Geom.Rectangle|object)} [output] - An object to store the values in. If not provided a new Rectangle will be created.
      *
      * @return {(Phaser.Geom.Rectangle|object)} The values stored in the output object.

src/gameobjects/components/Origin.js

@@ -9,7 +9,7 @@
  * Values are normalized, given in the range 0 to 1.
  * Display values contain the calculated pixel values.
  * Should be applied as a mixin and not used directly.
- * 
+ *
  * @name Phaser.GameObjects.Components.Origin
  * @since 3.0.0
  */
@@ -18,7 +18,7 @@ var Origin = {
 
     /**
      * A property indicating that a Game Object has this component.
-     * 
+     *
      * @name Phaser.GameObjects.Components.Origin#_originComponent
      * @type {boolean}
      * @private
@@ -32,7 +32,7 @@ var Origin = {
      * The origin maps the relationship between the size and position of the Game Object.
      * The default value is 0.5, meaning all Game Objects are positioned based on their center.
      * Setting the value to 0 means the position now relates to the left of the Game Object.
-     * 
+     *
      * @name Phaser.GameObjects.Components.Origin#originX
      * @type {float}
      * @default 0.5
@@ -45,7 +45,7 @@ var Origin = {
      * The origin maps the relationship between the size and position of the Game Object.
      * The default value is 0.5, meaning all Game Objects are positioned based on their center.
      * Setting the value to 0 means the position now relates to the top of the Game Object.
-     * 
+     *
      * @name Phaser.GameObjects.Components.Origin#originY
      * @type {float}
      * @default 0.5
@@ -61,7 +61,7 @@ var Origin = {
      * The horizontal display origin of this Game Object.
      * The origin is a normalized value between 0 and 1.
      * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.
-     * 
+     *
      * @name Phaser.GameObjects.Components.Origin#displayOriginX
      * @type {float}
      * @since 3.0.0
@@ -85,7 +85,7 @@ var Origin = {
      * The vertical display origin of this Game Object.
      * The origin is a normalized value between 0 and 1.
      * The displayOrigin is a pixel value, based on the size of the Game Object combined with the origin.
-     * 
+     *
      * @name Phaser.GameObjects.Components.Origin#displayOriginY
      * @type {float}
      * @since 3.0.0
@@ -109,13 +109,13 @@ var Origin = {
      * Sets the origin of this Game Object.
      *
      * The values are given in the range 0 to 1.
-     * 
+     *
      * @method Phaser.GameObjects.Components.Origin#setOrigin
      * @since 3.0.0
      *
      * @param {number} [x=0.5] - The horizontal origin value.
-     * @param {number} [y=0.5] - The vertical origin value. If not defined it will be set to the value of `x`.
-     * 
+     * @param {number} [y=x] - The vertical origin value. If not defined it will be set to the value of `x`.
+     *
      * @return {Phaser.GameObjects.GameObject} This Game Object instance.
      */
     setOrigin: function (x, y)
@@ -131,10 +131,10 @@ var Origin = {
 
     /**
      * Sets the origin of this Game Object based on the Pivot values in its Frame.
-     * 
+     *
      * @method Phaser.GameObjects.Components.Origin#setOriginFromFrame
      * @since 3.0.0
-     * 
+     *
      * @return {Phaser.GameObjects.GameObject} This Game Object instance.
      */
     setOriginFromFrame: function ()
@@ -155,13 +155,13 @@ var Origin = {
     /**
      * Sets the display origin of this Game Object.
      * The difference between this and setting the origin is that you can use pixel values for setting the display origin.
-     * 
+     *
      * @method Phaser.GameObjects.Components.Origin#setDisplayOrigin
      * @since 3.0.0
      *
      * @param {number} [x=0] - The horizontal display origin value.
-     * @param {number} [y=0] - The vertical display origin value. If not defined it will be set to the value of `x`.
-     * 
+     * @param {number} [y=x] - The vertical display origin value. If not defined it will be set to the value of `x`.
+     *
      * @return {Phaser.GameObjects.GameObject} This Game Object instance.
      */
     setDisplayOrigin: function (x, y)
@@ -178,10 +178,10 @@ var Origin = {
     /**
      * Updates the Display Origin cached values internally stored on this Game Object.
      * You don't usually call this directly, but it is exposed for edge-cases where you may.
-     * 
+     *
      * @method Phaser.GameObjects.Components.Origin#updateDisplayOrigin
      * @since 3.0.0
-     * 
+     *
      * @return {Phaser.GameObjects.GameObject} This Game Object instance.
      */
     updateDisplayOrigin: function ()

src/gameobjects/components/ScaleMode.js

@@ -8,7 +8,7 @@ var ScaleModes = require('../../renderer/ScaleModes');
 
 /**
  * Provides methods used for getting and setting the scale of a Game Object.
- * 
+ *
  * @name Phaser.GameObjects.Components.ScaleMode
  * @since 3.0.0
  */
@@ -20,9 +20,9 @@ var ScaleMode = {
     /**
      * The Scale Mode being used by this Game Object.
      * Can be either `ScaleModes.LINEAR` or `ScaleModes.NEAREST`.
-     * 
+     *
      * @name Phaser.GameObjects.Components.ScaleMode#scaleMode
-     * @type {integer}
+     * @type {Phaser.ScaleModes}
      * @since 3.0.0
      */
     scaleMode: {
@@ -45,12 +45,12 @@ var ScaleMode = {
     /**
      * Sets the Scale Mode being used by this Game Object.
      * Can be either `ScaleModes.LINEAR` or `ScaleModes.NEAREST`.
-     * 
+     *
      * @method Phaser.GameObjects.Components.ScaleMode#setScaleMode
      * @since 3.0.0
      *
-     * @param {integer} value - The Scale Mode to be used by this Game Object.
-     * 
+     * @param {Phaser.ScaleModes} value - The Scale Mode to be used by this Game Object.
+     *
      * @return {Phaser.GameObjects.GameObject} This Game Object instance.
      */
     setScaleMode: function (value)

src/gameobjects/components/ScrollFactor.js

@@ -6,7 +6,7 @@
 
 /**
  * Provides methods used for getting and setting the Scroll Factor of a Game Object.
- * 
+ *
  * @name Phaser.GameObjects.Components.ScrollFactor
  * @since 3.0.0
  */
@@ -15,16 +15,16 @@ var ScrollFactor = {
 
     /**
      * The horizontal scroll factor of this Game Object.
-     * 
+     *
      * The scroll factor controls the influence of the movement of a Camera upon this Game Object.
      *
      * When a camera scrolls it will change the location at which this Game Object is rendered on-screen.
      * It does not change the Game Objects actual position values.
-     * 
+     *
      * A value of 1 means it will move exactly in sync with a camera.
      * A value of 0 means it will not move at all, even if the camera moves.
      * Other values control the degree to which the camera movement is mapped to this Game Object.
-     * 
+     *
      * @name Phaser.GameObjects.Components.ScrollFactor#scrollFactorX
      * @type {number}
      * @default 1
@@ -34,16 +34,16 @@ var ScrollFactor = {
 
     /**
      * The vertical scroll factor of this Game Object.
-     * 
+     *
      * The scroll factor controls the influence of the movement of a Camera upon this Game Object.
      *
      * When a camera scrolls it will change the location at which this Game Object is rendered on-screen.
      * It does not change the Game Objects actual position values.
-     * 
+     *
      * A value of 1 means it will move exactly in sync with a camera.
      * A value of 0 means it will not move at all, even if the camera moves.
      * Other values control the degree to which the camera movement is mapped to this Game Object.
-     * 
+     *
      * @name Phaser.GameObjects.Components.ScrollFactor#scrollFactorY
      * @type {number}
      * @default 1
@@ -53,22 +53,22 @@ var ScrollFactor = {
 
     /**
      * Sets the scroll factor of this Game Object.
-     * 
+     *
      * The scroll factor controls the influence of the movement of a Camera upon this Game Object.
      *
      * When a camera scrolls it will change the location at which this Game Object is rendered on-screen.
      * It does not change the Game Objects actual position values.
-     * 
+     *
      * A value of 1 means it will move exactly in sync with a camera.
      * A value of 0 means it will not move at all, even if the camera moves.
      * Other values control the degree to which the camera movement is mapped to this Game Object.
-     * 
+     *
      * @method Phaser.GameObjects.Components.ScrollFactor#setScrollFactor
      * @since 3.0.0
      *
      * @param {number} x - The horizontal scroll factor of this Game Object.
-     * @param {number} [y] - The vertical scroll factor of this Game Object. If not set it will use the `x` value.
-     * 
+     * @param {number} [y=x] - The vertical scroll factor of this Game Object. If not set it will use the `x` value.
+     *
      * @return {Phaser.GameObjects.GameObject} This Game Object instance.
      */
     setScrollFactor: function (x, y)

src/gameobjects/components/ToJSON.js

@@ -6,7 +6,7 @@
 
 /**
  * @typedef {object} JSONGameObject
- * @template DATA
+ * @generic {object} DATA - [data]
  *
  * @property {string} name - The name of this Game Object.
  * @property {string} type - A textual representation of this Game Object, i.e. `sprite`.
@@ -27,7 +27,7 @@
  * @property {(integer|string)} blendMode - Sets the Blend Mode being used by this Game Object.
  * @property {string} textureKey - The texture key of this Game Object.
  * @property {string} frameKey - The frame key of this Game Object.
- * @property {DATA} data - The data of this Game Object.
+ * @property {object} data - The data of this Game Object.
  */
 
 //  Default Game Object JSON export

src/gameobjects/group/Group.js

@@ -86,8 +86,8 @@ var Sprite = require('../sprite/Sprite');
  * @since 3.0.0
  *
  * @param {Phaser.Scene} scene - [description]
- * @param {Phaser.GameObjects.GameObject[]} children - [description]
- * @param {GroupConfig} config - [description]
+ * @param {?(Phaser.GameObjects.GameObject[]|GroupConfig)} children - [description]
+ * @param {GroupConfig} [config] - [description]
  */
 var Group = new Class({
 

src/gameobjects/group/GroupCreator.js

@@ -15,7 +15,7 @@ var Group = require('./Group');
  * @method Phaser.GameObjects.GameObjectCreator#group
  * @since 3.0.0
  *
- * @param {object} config - [description]
+ * @param {GroupConfig} config - [description]
  *
  * @return {Phaser.GameObjects.Group} The Game Object that was created.
  */