GameObject and Loader typedefs

Author: photonstorm

src/gameobjects/pathfollower/PathFollower.js

@@ -12,20 +12,6 @@ var Sprite = require('../sprite/Sprite');
 var TWEEN_CONST = require('../../tweens/tween/const');
 var Vector2 = require('../../math/Vector2');
 
-/**
- * Settings for a PathFollower.
- *
- * @typedef {object} PathConfig
- *
- * @property {number} duration - The duration of the path follow.
- * @property {number} from - The start position of the path follow, between 0 and 1.
- * @property {number} to - The end position of the path follow, between 0 and 1.
- * @property {boolean} [positionOnPath=false] - Whether to position the PathFollower on the Path using its path offset.
- * @property {boolean} [rotateToPath=false] - Should the PathFollower automatically rotate to point in the direction of the Path?
- * @property {number} [rotationOffset=0] - If the PathFollower is rotating to match the Path, this value is added to the rotation value. This allows you to rotate objects to a path but control the angle of the rotation as well.
- * @property {number} [startAt=0] - Current start position of the path follow, between 0 and 1.
- */
-
 /**
  * @classdesc
  * A PathFollower Game Object.
@@ -125,7 +111,7 @@ var PathFollower = new Class({
          * Settings for the PathFollower.
          *
          * @name Phaser.GameObjects.PathFollower#pathConfig
-         * @type {?PathConfig}
+         * @type {?Phaser.GameObjects.PathFollower.Types.PathConfig}
          * @default null
          * @since 3.0.0
          */
@@ -145,13 +131,13 @@ var PathFollower = new Class({
     /**
      * Set the Path that this PathFollower should follow.
      *
-     * Optionally accepts {@link PathConfig} settings.
+     * Optionally accepts {@link Phaser.GameObjects.PathFollower.Types.PathConfig} settings.
      *
      * @method Phaser.GameObjects.PathFollower#setPath
      * @since 3.0.0
      *
      * @param {Phaser.Curves.Path} path - The Path this PathFollower is following. It can only follow one Path at a time.
-     * @param {PathConfig} [config] - Settings for the PathFollower.
+     * @param {Phaser.GameObjects.PathFollower.Types.PathConfig} [config] - Settings for the PathFollower.
      *
      * @return {Phaser.GameObjects.PathFollower} This Game Object.
      */
@@ -221,7 +207,7 @@ var PathFollower = new Class({
      * @method Phaser.GameObjects.PathFollower#startFollow
      * @since 3.3.0
      *
-     * @param {(number|PathConfig)} [config={}] - The duration of the follow, or a PathFollower config object.
+     * @param {(number|Phaser.GameObjects.PathFollower.Types.PathConfig)} [config={}] - The duration of the follow, or a PathFollower config object.
      * @param {number} [startAt=0] - Optional start position of the follow, between 0 and 1.
      *
      * @return {Phaser.GameObjects.PathFollower} This Game Object.

src/gameobjects/pathfollower/typedefs/PathConfig.js

@@ -0,0 +1,14 @@
+/**
+ * Settings for a PathFollower.
+ *
+ * @typedef {object} Phaser.GameObjects.PathFollower.Types.PathConfig
+ * @since 3.0.0
+ *
+ * @property {number} duration - The duration of the path follow.
+ * @property {number} from - The start position of the path follow, between 0 and 1.
+ * @property {number} to - The end position of the path follow, between 0 and 1.
+ * @property {boolean} [positionOnPath=false] - Whether to position the PathFollower on the Path using its path offset.
+ * @property {boolean} [rotateToPath=false] - Should the PathFollower automatically rotate to point in the direction of the Path?
+ * @property {number} [rotationOffset=0] - If the PathFollower is rotating to match the Path, this value is added to the rotation value. This allows you to rotate objects to a path but control the angle of the rotation as well.
+ * @property {number} [startAt=0] - Current start position of the path follow, between 0 and 1.
+ */

src/gameobjects/pathfollower/typedefs/index.js

@@ -0,0 +1,9 @@
+/**
+ * @author       Richard Davey <rich@photonstorm.com>
+ * @copyright    2019 Photon Storm Ltd.
+ * @license      {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
+ */
+
+/**
+ * @namespace Phaser.GameObjects.PathFollower.Types
+ */

src/gameobjects/rendertexture/RenderTextureCreator.js

@@ -9,15 +9,6 @@ var GameObjectCreator = require('../GameObjectCreator');
 var GetAdvancedValue = require('../../utils/object/GetAdvancedValue');
 var RenderTexture = require('./RenderTexture');
 
-/**
- * @typedef {object} RenderTextureConfig
- *
- * @property {number} [x=0] - The x coordinate of the RenderTexture's position.
- * @property {number} [y=0] - The y coordinate of the RenderTexture's position.
- * @property {number} [width=32] - The width of the RenderTexture.
- * @property {number} [height=32] - The height of the RenderTexture.
- */
-
 /**
  * Creates a new Render Texture Game Object and returns it.
  *
@@ -26,7 +17,7 @@ var RenderTexture = require('./RenderTexture');
  * @method Phaser.GameObjects.GameObjectCreator#renderTexture
  * @since 3.2.0
  *
- * @param {RenderTextureConfig} config - The configuration object this Game Object will use to create itself.
+ * @param {Phaser.GameObjects.RenderTexture.Types.RenderTextureConfig} config - The configuration object this Game Object will use to create itself.
  * @param {boolean} [addToScene] - Add this Game Object to the Scene after creating it? If set this argument overrides the `add` property in the config object.
  *
  * @return {Phaser.GameObjects.RenderTexture} The Game Object that was created.

src/gameobjects/rendertexture/typedefs/RenderTextureConfig.js

@@ -0,0 +1,9 @@
+/**
+ * @typedef {object} Phaser.GameObjects.RenderTexture.Types.RenderTextureConfig
+ * @since 3.2.0
+ *
+ * @property {number} [x=0] - The x coordinate of the RenderTextures position.
+ * @property {number} [y=0] - The y coordinate of the RenderTextures position.
+ * @property {number} [width=32] - The width of the RenderTexture.
+ * @property {number} [height=32] - The height of the RenderTexture.
+ */

src/gameobjects/rendertexture/typedefs/index.js

@@ -0,0 +1,9 @@
+/**
+ * @author       Richard Davey <rich@photonstorm.com>
+ * @copyright    2019 Photon Storm Ltd.
+ * @license      {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
+ */
+
+/**
+ * @namespace Phaser.GameObjects.RenderTexture.Types
+ */

src/gameobjects/sprite/SpriteCreator.js

@@ -10,14 +10,6 @@ var GameObjectCreator = require('../GameObjectCreator');
 var GetAdvancedValue = require('../../utils/object/GetAdvancedValue');
 var Sprite = require('./Sprite');
 
-/**
- * @typedef {object} SpriteConfig
- * @extends Phaser.GameObjects.Types.GameObjectConfig
- *
- * @property {string} [key] - The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.
- * @property {(number|string)} [frame] - An optional frame from the Texture this Game Object is rendering with.
- */
-
 /**
  * Creates a new Sprite Game Object and returns it.
  *
@@ -26,7 +18,7 @@ var Sprite = require('./Sprite');
  * @method Phaser.GameObjects.GameObjectCreator#sprite
  * @since 3.0.0
  *
- * @param {SpriteConfig} config - The configuration object this Game Object will use to create itself.
+ * @param {Phaser.GameObjects.Sprite.Types.SpriteConfig} config - The configuration object this Game Object will use to create itself.
  * @param {boolean} [addToScene] - Add this Game Object to the Scene after creating it? If set this argument overrides the `add` property in the config object.
  *
  * @return {Phaser.GameObjects.Sprite} The Game Object that was created.

src/gameobjects/sprite/typedefs/SpriteConfig.js

@@ -0,0 +1,8 @@
+/**
+ * @typedef {object} Phaser.GameObjects.Sprite.Types.SpriteConfig
+ * @extends Phaser.GameObjects.Types.GameObjectConfig
+ * @since 3.0.0
+ *
+ * @property {string} [key] - The key of the Texture this Game Object will use to render with, as stored in the Texture Manager.
+ * @property {(number|string)} [frame] - An optional frame from the Texture this Game Object is rendering with.
+ */

src/gameobjects/sprite/typedefs/index.js

@@ -0,0 +1,9 @@
+/**
+ * @author       Richard Davey <rich@photonstorm.com>
+ * @copyright    2019 Photon Storm Ltd.
+ * @license      {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
+ */
+
+/**
+ * @namespace Phaser.GameObjects.Sprite.Types
+ */

src/gameobjects/text/GetTextSize.js

@@ -11,7 +11,7 @@
  * @since 3.0.0
  *
  * @param {Phaser.GameObjects.Text} text - The Text object to calculate the size from.
- * @param {BitmapTextMetrics} size - The Text metrics to use when calculating the size.
+ * @param {Phaser.GameObjects.Text.Types.TextMetrics} size - The Text metrics to use when calculating the size.
  * @param {array} lines - The lines of text to calculate the size from.
  *
  * @return {object} An object containing dimensions of the Text object.