Bitmap Text Types

Author: photonstorm

src/gameobjects/bitmaptext/GetBitmapTextSize.js

@@ -22,7 +22,7 @@
  * @param {boolean} [round] - Whether to round the results to the nearest integer.
  * @param {object} [out] - Optional object to store the results in, to save constant object creation.
  *
- * @return {Phaser.GameObjects.BitmapText.Types.BitmapTextSize} The calculated position, width and height of the BitmapText.
+ * @return {Phaser.Types.GameObjects.BitmapText.BitmapTextSize} The calculated position, width and height of the BitmapText.
  */
 var GetBitmapTextSize = function (src, round, out)
 {

src/gameobjects/bitmaptext/ParseRetroFont.js

@@ -14,7 +14,7 @@ var GetValue = require('../../utils/object/GetValue');
  * @since 3.0.0
  *
  * @param {Phaser.Scene} scene - A reference to the Phaser Scene.
- * @param {Phaser.GameObjects.BitmapText.Types.RetroFontConfig} config - The font configuration object.
+ * @param {Phaser.Types.GameObjects.BitmapText.RetroFontConfig} config - The font configuration object.
  *
  * @return {object} A parsed Bitmap Font data entry for the Bitmap Font cache.
  */

src/gameobjects/bitmaptext/ParseXMLBitmapFont.js

@@ -33,7 +33,7 @@ function getValue (node, attribute)
  * @param {integer} [ySpacing=0] - The y-axis spacing to add to the line height.
  * @param {Phaser.Textures.Frame} [frame] - The texture frame to take into account while parsing.
  *
- * @return {Phaser.GameObjects.BitmapText.Types.BitmapFontData} The parsed Bitmap Font data.
+ * @return {Phaser.Types.GameObjects.BitmapText.BitmapFontData} The parsed Bitmap Font data.
  */
 var ParseXMLBitmapFont = function (xml, xSpacing, ySpacing, frame)
 {

src/gameobjects/bitmaptext/dynamic/DynamicBitmapText.js

@@ -110,7 +110,7 @@ var DynamicBitmapText = new Class({
          * A callback that alters how each character of the Bitmap Text is rendered.
          *
          * @name Phaser.GameObjects.DynamicBitmapText#displayCallback
-         * @type {Phaser.GameObjects.BitmapText.Types.DisplayCallback}
+         * @type {Phaser.Types.GameObjects.BitmapText.DisplayCallback}
          * @since 3.0.0
          */
         this.displayCallback;
@@ -124,7 +124,7 @@ var DynamicBitmapText = new Class({
          * should shallow copy it, as it's updated and re-used for every glyph in the text.
          *
          * @name Phaser.GameObjects.DynamicBitmapText#callbackData
-         * @type {Phaser.GameObjects.BitmapText.Types.DisplayCallbackConfig}
+         * @type {Phaser.Types.GameObjects.BitmapText.DisplayCallbackConfig}
          * @since 3.11.0
          */
         this.callbackData = {
@@ -168,7 +168,7 @@ var DynamicBitmapText = new Class({
     /**
      * Set a callback that alters how each character of the Bitmap Text is rendered.
      *
-     * The callback receives a {@link Phaser.GameObjects.BitmapText.Types.DisplayCallbackConfig} object that contains information about the character that's
+     * The callback receives a {@link Phaser.Types.GameObjects.BitmapText.DisplayCallbackConfig} object that contains information about the character that's
      * about to be rendered.
      *
      * It should return an object with `x`, `y`, `scale` and `rotation` properties that will be used instead of the
@@ -177,7 +177,7 @@ var DynamicBitmapText = new Class({
      * @method Phaser.GameObjects.DynamicBitmapText#setDisplayCallback
      * @since 3.0.0
      *
-     * @param {Phaser.GameObjects.BitmapText.Types.DisplayCallback} callback - The display callback to set.
+     * @param {Phaser.Types.GameObjects.BitmapText.DisplayCallback} callback - The display callback to set.
      *
      * @return {Phaser.GameObjects.DynamicBitmapText} This Game Object.
      */

src/gameobjects/bitmaptext/dynamic/DynamicBitmapTextCreator.js

@@ -17,7 +17,7 @@ var GetAdvancedValue = require('../../../utils/object/GetAdvancedValue');
  * @method Phaser.GameObjects.GameObjectCreator#dynamicBitmapText
  * @since 3.0.0
  *²
- * @param {Phaser.GameObjects.BitmapText.Types.BitmapTextConfig} config - The configuration object this Game Object will use to create itself.
+ * @param {Phaser.Types.GameObjects.BitmapText.BitmapTextConfig} 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.DynamicBitmapText} The Game Object that was created.

src/gameobjects/bitmaptext/static/BitmapText.js

@@ -105,7 +105,7 @@ var BitmapText = new Class({
          * The data of the Bitmap Font used by this Bitmap Text.
          *
          * @name Phaser.GameObjects.BitmapText#fontData
-         * @type {Phaser.GameObjects.BitmapText.Types.BitmapFontData}
+         * @type {Phaser.Types.GameObjects.BitmapText.BitmapFontData}
          * @readonly
          * @since 3.0.0
          */
@@ -167,7 +167,7 @@ var BitmapText = new Class({
          * An object that describes the size of this Bitmap Text.
          *
          * @name Phaser.GameObjects.BitmapText#_bounds
-         * @type {Phaser.GameObjects.BitmapText.Types.BitmapTextSize}
+         * @type {Phaser.Types.GameObjects.BitmapText.BitmapTextSize}
          * @private
          * @since 3.0.0
          */
@@ -340,7 +340,7 @@ var BitmapText = new Class({
      *
      * @param {boolean} [round] - Whether to round the results to the nearest integer.
      *
-     * @return {Phaser.GameObjects.BitmapText.Types.BitmapTextSize} An object that describes the size of this Bitmap Text.
+     * @return {Phaser.Types.GameObjects.BitmapText.BitmapTextSize} An object that describes the size of this Bitmap Text.
      */
     getTextBounds: function (round)
     {
@@ -546,7 +546,7 @@ var BitmapText = new Class({
      * @method Phaser.GameObjects.BitmapText#toJSON
      * @since 3.0.0
      *
-     * @return {Phaser.GameObjects.BitmapText.Types.JSONBitmapText} A JSON representation of this Bitmap Text.
+     * @return {Phaser.Types.GameObjects.BitmapText.JSONBitmapText} A JSON representation of this Bitmap Text.
      */
     toJSON: function ()
     {
@@ -629,7 +629,7 @@ BitmapText.ParseFromAtlas = ParseFromAtlas;
  * @param {integer} [ySpacing=0] - The y-axis spacing to add to the line height.
  * @param {Phaser.Textures.Frame} [frame] - The texture frame to take into account while parsing.
  *
- * @return {Phaser.GameObjects.BitmapText.Types.BitmapFontData} The parsed Bitmap Font data.
+ * @return {Phaser.Types.GameObjects.BitmapText.BitmapFontData} The parsed Bitmap Font data.
  */
 BitmapText.ParseXMLBitmapFont = ParseXMLBitmapFont;
 

src/gameobjects/bitmaptext/static/BitmapTextCreator.js

@@ -18,7 +18,7 @@ var GetValue = require('../../../utils/object/GetValue');
  * @method Phaser.GameObjects.GameObjectCreator#bitmapText
  * @since 3.0.0
  *
- * @param {Phaser.GameObjects.BitmapText.Types.BitmapTextConfig} config - The configuration object this Game Object will use to create itself.
+ * @param {Phaser.Types.GameObjects.BitmapText.BitmapTextConfig} 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.BitmapText} The Game Object that was created.

src/gameobjects/bitmaptext/typedefs/BitmapFontCharacterData.js

@@ -3,7 +3,7 @@
  *
  * Describes the character's position, size, offset and kerning.
  *
- * @typedef {object} Phaser.GameObjects.BitmapText.Types.BitmapFontCharacterData
+ * @typedef {object} Phaser.Types.GameObjects.BitmapText.BitmapFontCharacterData
  * @since 3.0.0
  *
  * @property {number} x - The x position of the character.

src/gameobjects/bitmaptext/typedefs/BitmapFontData.js

@@ -1,12 +1,12 @@
 /**
  * Bitmap Font data that can be used by a BitmapText Game Object.
  *
- * @typedef {object} Phaser.GameObjects.BitmapText.Types.BitmapFontData
+ * @typedef {object} Phaser.Types.GameObjects.BitmapText.BitmapFontData
  * @since 3.0.0
  *
  * @property {string} font - The name of the font.
  * @property {number} size - The size of the font.
  * @property {number} lineHeight - The line height of the font.
  * @property {boolean} retroFont - Whether this font is a retro font (monospace).
- * @property {Object.<number, Phaser.GameObjects.BitmapText.Types.BitmapFontCharacterData>} chars - The character data of the font, keyed by character code. Each character datum includes a position, size, offset and more.
+ * @property {Object.<number, Phaser.Types.GameObjects.BitmapText.BitmapFontCharacterData>} chars - The character data of the font, keyed by character code. Each character datum includes a position, size, offset and more.
  */

src/gameobjects/bitmaptext/typedefs/BitmapTextConfig.js

@@ -1,5 +1,5 @@
 /**
- * @typedef {object} Phaser.GameObjects.BitmapText.Types.BitmapTextConfig
+ * @typedef {object} Phaser.Types.GameObjects.BitmapText.BitmapTextConfig
  * @extends Phaser.GameObjects.Types.GameObjectConfig
  * @since 3.0.0
  *