From 8ae958037ec2ae97a555c6315d5311862d4ccb54 Mon Sep 17 00:00:00 2001 From: Richard Davey Date: Wed, 7 Feb 2018 02:46:11 +0000 Subject: [PATCH] Added jsdocs --- src/gameobjects/text/GetTextSize.js | 3 + src/gameobjects/text/MeasureText.js | 5 +- src/gameobjects/text/TextStyle.js | 475 +++++++++++++++++++++++++++- src/gameobjects/text/static/Text.js | 145 ++++----- src/gameobjects/tilemap/Tile.js | 44 +-- 5 files changed, 559 insertions(+), 113 deletions(-) diff --git a/src/gameobjects/text/GetTextSize.js b/src/gameobjects/text/GetTextSize.js index 183cca518..11fe7efdc 100644 --- a/src/gameobjects/text/GetTextSize.js +++ b/src/gameobjects/text/GetTextSize.js @@ -1,3 +1,6 @@ +/** + * Returns an object containing dimensions of the Text object. + */ var GetTextSize = function (text, size, lines) { diff --git a/src/gameobjects/text/MeasureText.js b/src/gameobjects/text/MeasureText.js index 5818f29d0..c6bab8b54 100644 --- a/src/gameobjects/text/MeasureText.js +++ b/src/gameobjects/text/MeasureText.js @@ -1,8 +1,9 @@ var CanvasPool = require('../../display/canvas/CanvasPool'); /** -* Calculates the ascent, descent and fontSize of a given font style. -*/ + * Calculates the ascent, descent and fontSize of a given font style. + */ + var MeasureText = function (textStyle) { // @property {HTMLCanvasElement} canvas - The canvas element that the text is rendered. diff --git a/src/gameobjects/text/TextStyle.js b/src/gameobjects/text/TextStyle.js index 290b64dd5..ea68b6bf3 100644 --- a/src/gameobjects/text/TextStyle.js +++ b/src/gameobjects/text/TextStyle.js @@ -21,8 +21,8 @@ var propertyMap = { shadowFill: [ 'shadow.fill', false ], align: [ 'align', 'left' ], maxLines: [ 'maxLines', 0 ], - fixedWidth: [ 'fixedWidth', false ], - fixedHeight: [ 'fixedHeight', false ], + fixedWidth: [ 'fixedWidth', 0 ], + fixedHeight: [ 'fixedHeight', 0 ], rtl: [ 'rtl', false ], testString: [ 'testString', '|MÉqgy' ], wordWrapWidth: [ 'wordWrap.width', null ], @@ -31,34 +31,228 @@ var propertyMap = { wordWrapUseAdvanced: [ 'wordWrap.useAdvancedWrap', false ] }; +/** + * [description] + * + * @class TextStyle + * @memberOf Phaser.GameObjects.Components + * @constructor + * @since 3.0.0 + * + * @param {Phaser.GameObjects.Text} text - The Text object that this TextStyle is styling. + * @param {object} style - [description] + */ var TextStyle = new Class({ initialize: function TextStyle (text, style) { + /** + * The Text object that this TextStyle is styling. + * + * @name Phaser.GameObjects.Components.TextStyle#parent + * @type {Phaser.GameObjects.Text} + * @since 3.0.0 + */ this.parent = text; + /** + * [description] + * + * @name Phaser.GameObjects.Components.TextStyle#fontFamily + * @type {string} + * @default 'Courier' + * @since 3.0.0 + */ this.fontFamily; + + /** + * [description] + * + * @name Phaser.GameObjects.Components.TextStyle#fontSize + * @type {string} + * @default '16px' + * @since 3.0.0 + */ this.fontSize; + + /** + * [description] + * + * @name Phaser.GameObjects.Components.TextStyle#fontStyle + * @type {string} + * @since 3.0.0 + */ this.fontStyle; + + /** + * [description] + * + * @name Phaser.GameObjects.Components.TextStyle#backgroundColor + * @type {string} + * @since 3.0.0 + */ this.backgroundColor; + + /** + * [description] + * + * @name Phaser.GameObjects.Components.TextStyle#color + * @type {string} + * @default '#fff' + * @since 3.0.0 + */ this.color; + + /** + * [description] + * + * @name Phaser.GameObjects.Components.TextStyle#stroke + * @type {string} + * @default '#fff' + * @since 3.0.0 + */ this.stroke; + + /** + * [description] + * + * @name Phaser.GameObjects.Components.TextStyle#strokeThickness + * @type {number} + * @default 0 + * @since 3.0.0 + */ this.strokeThickness; + + /** + * [description] + * + * @name Phaser.GameObjects.Components.TextStyle#shadowOffsetX + * @type {number} + * @default 0 + * @since 3.0.0 + */ this.shadowOffsetX; + + /** + * [description] + * + * @name Phaser.GameObjects.Components.TextStyle#shadowOffsetY + * @type {number} + * @default 0 + * @since 3.0.0 + */ this.shadowOffsetY; + + /** + * [description] + * + * @name Phaser.GameObjects.Components.TextStyle#shadowColor + * @type {string} + * @default '#000' + * @since 3.0.0 + */ this.shadowColor; + + /** + * [description] + * + * @name Phaser.GameObjects.Components.TextStyle#shadowBlur + * @type {number} + * @default 0 + * @since 3.0.0 + */ this.shadowBlur; + + /** + * [description] + * + * @name Phaser.GameObjects.Components.TextStyle#shadowStroke + * @type {boolean} + * @default false + * @since 3.0.0 + */ this.shadowStroke; + + /** + * [description] + * + * @name Phaser.GameObjects.Components.TextStyle#shadowFill + * @type {boolean} + * @default false + * @since 3.0.0 + */ this.shadowFill; + + /** + * [description] + * + * @name Phaser.GameObjects.Components.TextStyle#align + * @type {string} + * @default 'left' + * @since 3.0.0 + */ this.align; + + /** + * [description] + * + * @name Phaser.GameObjects.Components.TextStyle#maxLines + * @type {integer} + * @default 0 + * @since 3.0.0 + */ this.maxLines; + + /** + * [description] + * + * @name Phaser.GameObjects.Components.TextStyle#fixedWidth + * @type {number} + * @default 0 + * @since 3.0.0 + */ this.fixedWidth; + + /** + * [description] + * + * @name Phaser.GameObjects.Components.TextStyle#fixedHeight + * @type {number} + * @default 0 + * @since 3.0.0 + */ this.fixedHeight; + + /** + * [description] + * + * @name Phaser.GameObjects.Components.TextStyle#rtl + * @type {boolean} + * @default false + * @since 3.0.0 + */ this.rtl; + + /** + * [description] + * + * @name Phaser.GameObjects.Components.TextStyle#testString + * @type {string} + * @default '|MÉqgy' + * @since 3.0.0 + */ this.testString; + /** + * [description] + * + * @name Phaser.GameObjects.Components.TextStyle#_font + * @type {string} + * @private + * @since 3.0.0 + */ this._font; // Set to defaults + user style @@ -82,6 +276,17 @@ var TextStyle = new Class({ } }, + /** + * [description] + * + * @method Phaser.GameObjects.Components.TextStyle#setStyle + * @since 3.0.0 + * + * @param {[type]} style - [description] + * @param {[type]} updateText - [description] + * + * @return {Phaser.GameObjects.Components.TextStyle This TextStyle component. + */ setStyle: function (style, updateText) { if (updateText === undefined) { updateText = true; } @@ -133,11 +338,29 @@ var TextStyle = new Class({ return this; }, + /** + * [description] + * + * @method Phaser.GameObjects.Components.TextStyle#syncFont + * @since 3.0.0 + * + * @param {[type]} canvas - [description] + * @param {[type]} context - [description] + */ syncFont: function (canvas, context) { context.font = this._font; }, + /** + * [description] + * + * @method Phaser.GameObjects.Components.TextStyle#syncStyle + * @since 3.0.0 + * + * @param {[type]} canvas - [description] + * @param {[type]} context - [description] + */ syncStyle: function (canvas, context) { context.textBaseline = 'alphabetic'; @@ -150,6 +373,15 @@ var TextStyle = new Class({ context.lineJoin = 'round'; }, + /** + * [description] + * + * @method Phaser.GameObjects.Components.TextStyle#syncShadow + * @since 3.0.0 + * + * @param {[type]} context - [description] + * @param {[type]} enabled - [description] + */ syncShadow: function (context, enabled) { if (enabled) @@ -168,6 +400,16 @@ var TextStyle = new Class({ } }, + /** + * [description] + * + * @method Phaser.GameObjects.Components.TextStyle#update + * @since 3.0.0 + * + * @param {boolean} recalculateMetrics - [description] + * + * @return {Phaser.GameObjects.Text} The parent Text object. + */ update: function (recalculateMetrics) { if (recalculateMetrics) @@ -180,7 +422,16 @@ var TextStyle = new Class({ return this.parent.updateText(); }, - // Allows you to set them all in a single object + /** + * [description] + * + * @method Phaser.GameObjects.Components.TextStyle#setFont + * @since 3.0.0 + * + * @param {string|object} font - [description] + * + * @return {Phaser.GameObjects.Text} The parent Text object. + */ setFont: function (font) { if (typeof font === 'string') @@ -199,6 +450,16 @@ var TextStyle = new Class({ return this.update(true); }, + /** + * [description] + * + * @method Phaser.GameObjects.Components.TextStyle#setFontFamily + * @since 3.0.0 + * + * @param {[type]} family - [description] + * + * @return {Phaser.GameObjects.Text} The parent Text object. + */ setFontFamily: function (family) { this.fontFamily = family; @@ -206,6 +467,16 @@ var TextStyle = new Class({ return this.update(true); }, + /** + * [description] + * + * @method Phaser.GameObjects.Components.TextStyle#setFontStyle + * @since 3.0.0 + * + * @param {[type]} style - [description] + * + * @return {Phaser.GameObjects.Text} The parent Text object. + */ setFontStyle: function (style) { this.fontStyle = style; @@ -213,6 +484,16 @@ var TextStyle = new Class({ return this.update(true); }, + /** + * [description] + * + * @method Phaser.GameObjects.Components.TextStyle#setFontSize + * @since 3.0.0 + * + * @param {[type]} size - [description] + * + * @return {Phaser.GameObjects.Text} The parent Text object. + */ setFontSize: function (size) { if (typeof size === 'number') @@ -225,6 +506,16 @@ var TextStyle = new Class({ return this.update(true); }, + /** + * [description] + * + * @method Phaser.GameObjects.Components.TextStyle#setTestString + * @since 3.0.0 + * + * @param {[type]} string - [description] + * + * @return {Phaser.GameObjects.Text} The parent Text object. + */ setTestString: function (string) { this.testString = string; @@ -232,6 +523,17 @@ var TextStyle = new Class({ return this.update(true); }, + /** + * [description] + * + * @method Phaser.GameObjects.Components.TextStyle#setFixedSize + * @since 3.0.0 + * + * @param {number} width - [description] + * @param {number} height - [description] + * + * @return {Phaser.GameObjects.Text} The parent Text object. + */ setFixedSize: function (width, height) { this.fixedWidth = width; @@ -250,6 +552,16 @@ var TextStyle = new Class({ return this.update(false); }, + /** + * [description] + * + * @method Phaser.GameObjects.Components.TextStyle#setBackgroundColor + * @since 3.0.0 + * + * @param {string color - [description] + * + * @return {Phaser.GameObjects.Text} The parent Text object. + */ setBackgroundColor: function (color) { this.backgroundColor = color; @@ -257,6 +569,16 @@ var TextStyle = new Class({ return this.update(false); }, + /** + * [description] + * + * @method Phaser.GameObjects.Components.TextStyle#setFill + * @since 3.0.0 + * + * @param {string} color - [description] + * + * @return {Phaser.GameObjects.Text} The parent Text object. + */ setFill: function (color) { this.color = color; @@ -264,6 +586,16 @@ var TextStyle = new Class({ return this.update(false); }, + /** + * [description] + * + * @method Phaser.GameObjects.Components.TextStyle#setColor + * @since 3.0.0 + * + * @param {string} color - [description] + * + * @return {Phaser.GameObjects.Text} The parent Text object. + */ setColor: function (color) { this.color = color; @@ -271,6 +603,17 @@ var TextStyle = new Class({ return this.update(false); }, + /** + * [description] + * + * @method Phaser.GameObjects.Components.TextStyle#setStroke + * @since 3.0.0 + * + * @param {string} color - [description] + * @param {number} thickness - [description] + * + * @return {Phaser.GameObjects.Text} The parent Text object. + */ setStroke: function (color, thickness) { if (color === undefined) @@ -289,6 +632,21 @@ var TextStyle = new Class({ return this.update(true); }, + /** + * [description] + * + * @method Phaser.GameObjects.Components.TextStyle#setShadow + * @since 3.0.0 + * + * @param {number} [x=0] - [description] + * @param {number} [y=0] - [description] + * @param {string} [color='#000'] - [description] + * @param {number} [blur=0] - [description] + * @param {boolean} [shadowStroke=false] - [description] + * @param {boolean} [shadowFill=true] - [description] + * + * @return {Phaser.GameObjects.Text} The parent Text object. + */ setShadow: function (x, y, color, blur, shadowStroke, shadowFill) { if (x === undefined) { x = 0; } @@ -308,6 +666,17 @@ var TextStyle = new Class({ return this.update(false); }, + /** + * [description] + * + * @method Phaser.GameObjects.Components.TextStyle#setShadowOffset + * @since 3.0.0 + * + * @param {number} [x=0] - [description] + * @param {number} [y=0] - [description] + * + * @return {Phaser.GameObjects.Text} The parent Text object. + */ setShadowOffset: function (x, y) { if (x === undefined) { x = 0; } @@ -319,6 +688,16 @@ var TextStyle = new Class({ return this.update(false); }, + /** + * [description] + * + * @method Phaser.GameObjects.Components.TextStyle#setShadowColor + * @since 3.0.0 + * + * @param {string} [color='#000'] - [description] + * + * @return {Phaser.GameObjects.Text} The parent Text object. + */ setShadowColor: function (color) { if (color === undefined) { color = '#000'; } @@ -328,6 +707,16 @@ var TextStyle = new Class({ return this.update(false); }, + /** + * [description] + * + * @method Phaser.GameObjects.Components.TextStyle#setShadowBlur + * @since 3.0.0 + * + * @param {number} [blur=0] - [description] + * + * @return {Phaser.GameObjects.Text} The parent Text object. + */ setShadowBlur: function (blur) { if (blur === undefined) { blur = 0; } @@ -337,6 +726,16 @@ var TextStyle = new Class({ return this.update(false); }, + /** + * [description] + * + * @method Phaser.GameObjects.Components.TextStyle#setShadowStroke + * @since 3.0.0 + * + * @param {boolean} enabled - [description] + * + * @return {Phaser.GameObjects.Text} The parent Text object. + */ setShadowStroke: function (enabled) { this.shadowStroke = enabled; @@ -344,6 +743,16 @@ var TextStyle = new Class({ return this.update(false); }, + /** + * [description] + * + * @method Phaser.GameObjects.Components.TextStyle#setShadowFill + * @since 3.0.0 + * + * @param {boolean} enabled - [description] + * + * @return {Phaser.GameObjects.Text} The parent Text object. + */ setShadowFill: function (enabled) { this.shadowFill = enabled; @@ -352,15 +761,17 @@ var TextStyle = new Class({ }, /** - * Set the width (in pixels) to use for wrapping lines. Pass in null to remove wrapping by - * width. + * Set the width (in pixels) to use for wrapping lines. Pass in null to remove wrapping by width. * - * @param {number|null} width - The maximum width of a line in pixels. Set to null to remove - * wrapping. + * @method Phaser.GameObjects.Components.TextStyle#setWordWrapWidth + * @since 3.0.0 + * + * @param {number} width - The maximum width of a line in pixels. Set to null to remove wrapping. * @param {boolean} [useAdvancedWrap=false] - Whether or not to use the advanced wrapping * algorithm. If true, spaces are collapsed and whitespace is trimmed from lines. If false, * spaces and whitespace are left as is. - * @return {this} + * + * @return {Phaser.GameObjects.Text} The parent Text object. */ setWordWrapWidth: function (width, useAdvancedWrap) { @@ -375,12 +786,16 @@ var TextStyle = new Class({ /** * Set a custom callback for wrapping lines. Pass in null to remove wrapping by callback. * + * @method Phaser.GameObjects.Components.TextStyle#setWordWrapCallback + * @since 3.0.0 + * * @param {function} callback - A custom function that will be responsible for wrapping the * text. It will receive two arguments: text (the string to wrap), textObject (this Text * instance). It should return the wrapped lines either as an array of lines or as a string with * newline characters in place to indicate where breaks should happen. * @param {object} [scope=null] - The scope that will be applied when the callback is invoked. - * @return {this} + * + * @return {Phaser.GameObjects.Text} The parent Text object. */ setWordWrapCallback: function (callback, scope) { @@ -392,6 +807,16 @@ var TextStyle = new Class({ return this.update(false); }, + /** + * [description] + * + * @method Phaser.GameObjects.Components.TextStyle#setAlign + * @since 3.0.0 + * + * @param {string} align - [description] + * + * @return {Phaser.GameObjects.Text} The parent Text object. + */ setAlign: function (align) { if (align === undefined) { align = 'left'; } @@ -401,6 +826,16 @@ var TextStyle = new Class({ return this.update(false); }, + /** + * [description] + * + * @method Phaser.GameObjects.Components.TextStyle#setMaxLines + * @since 3.0.0 + * + * @param {integer} [max=0] - [description] + * + * @return {Phaser.GameObjects.Text} The parent Text object. + */ setMaxLines: function (max) { if (max === undefined) { max = 0; } @@ -410,6 +845,14 @@ var TextStyle = new Class({ return this.update(false); }, + /** + * [description] + * + * @method Phaser.GameObjects.Components.TextStyle#getTextMetrics + * @since 3.0.0 + * + * @return {object} [description] + */ getTextMetrics: function () { var metrics = this.metrics; @@ -421,6 +864,14 @@ var TextStyle = new Class({ }; }, + /** + * [description] + * + * @method Phaser.GameObjects.Components.TextStyle#toJSON + * @since 3.0.0 + * + * @return {object} [description] + */ toJSON: function () { var output = {}; @@ -435,6 +886,12 @@ var TextStyle = new Class({ return output; }, + /** + * [description] + * + * @method Phaser.GameObjects.Components.TextStyle#destroy + * @since 3.0.0 + */ destroy: function () { this.parent = undefined; diff --git a/src/gameobjects/text/static/Text.js b/src/gameobjects/text/static/Text.js index 2e5bdcb5a..fe03d08c6 100644 --- a/src/gameobjects/text/static/Text.js +++ b/src/gameobjects/text/static/Text.js @@ -512,7 +512,7 @@ var Text = new Class({ * * @param {object} style - [description] * - * @return {Phaser.GameObjects.Components.TextStyle} The TextStyle component. + * @return {Phaser.GameObjects.Text} This Text object. */ setStyle: function (style) { @@ -525,9 +525,9 @@ var Text = new Class({ * @method Phaser.GameObjects.Text#setFont * @since 3.0.0 * - * @param {[type]} font - [description] + * @param {string} font - [description] * - * @return {Phaser.GameObjects.Components.TextStyle} The TextStyle component. + * @return {Phaser.GameObjects.Text} This Text object. */ setFont: function (font) { @@ -540,9 +540,9 @@ var Text = new Class({ * @method Phaser.GameObjects.Text#setFontFamily * @since 3.0.0 * - * @param {[type]} family - [description] + * @param {string} family - [description] * - * @return {Phaser.GameObjects.Components.TextStyle} The TextStyle component. + * @return {Phaser.GameObjects.Text} This Text object. */ setFontFamily: function (family) { @@ -557,7 +557,7 @@ var Text = new Class({ * * @param {number} size - [description] * - * @return {Phaser.GameObjects.Components.TextStyle} The TextStyle component. + * @return {Phaser.GameObjects.Text} This Text object. */ setFontSize: function (size) { @@ -570,9 +570,9 @@ var Text = new Class({ * @method Phaser.GameObjects.Text#setFontStyle * @since 3.0.0 * - * @param {[type]} style - [description] + * @param {string} style - [description] * - * @return {[type]} [description] + * @return {Phaser.GameObjects.Text} This Text object. */ setFontStyle: function (style) { @@ -585,10 +585,10 @@ var Text = new Class({ * @method Phaser.GameObjects.Text#setFixedSize * @since 3.0.0 * - * @param {[type]} width - [description] - * @param {[type]} height - [description] + * @param {number} width - [description] + * @param {number} height - [description] * - * @return {[type]} [description] + * @return {Phaser.GameObjects.Text} This Text object. */ setFixedSize: function (width, height) { @@ -601,9 +601,9 @@ var Text = new Class({ * @method Phaser.GameObjects.Text#setBackgroundColor * @since 3.0.0 * - * @param {[type]} color - [description] + * @param {string} color - [description] * - * @return {[type]} [description] + * @return {Phaser.GameObjects.Text} This Text object. */ setBackgroundColor: function (color) { @@ -616,9 +616,9 @@ var Text = new Class({ * @method Phaser.GameObjects.Text#setFill * @since 3.0.0 * - * @param {[type]} color - [description] + * @param {string} color - [description] * - * @return {[type]} [description] + * @return {Phaser.GameObjects.Text} This Text object. */ setFill: function (color) { @@ -631,9 +631,9 @@ var Text = new Class({ * @method Phaser.GameObjects.Text#setColor * @since 3.0.0 * - * @param {[type]} color - [description] + * @param {string} color - [description] * - * @return {[type]} [description] + * @return {Phaser.GameObjects.Text} This Text object. */ setColor: function (color) { @@ -646,10 +646,10 @@ var Text = new Class({ * @method Phaser.GameObjects.Text#setStroke * @since 3.0.0 * - * @param {[type]} color - [description] - * @param {[type]} thickness - [description] + * @param {string} color - [description] + * @param {number} thickness - [description] * - * @return {[type]} [description] + * @return {Phaser.GameObjects.Text} This Text object. */ setStroke: function (color, thickness) { @@ -662,14 +662,14 @@ var Text = new Class({ * @method Phaser.GameObjects.Text#setShadow * @since 3.0.0 * - * @param {[type]} x - [description] - * @param {[type]} y - [description] - * @param {[type]} color - [description] - * @param {[type]} blur - [description] - * @param {[type]} shadowStroke - [description] - * @param {[type]} shadowFill - [description] + * @param {number} x - [description] + * @param {number} y - [description] + * @param {string} color - [description] + * @param {number} blur - [description] + * @param {boolean} shadowStroke - [description] + * @param {boolean} shadowFill - [description] * - * @return {[type]} [description] + * @return {Phaser.GameObjects.Text} This Text object. */ setShadow: function (x, y, color, blur, shadowStroke, shadowFill) { @@ -682,10 +682,10 @@ var Text = new Class({ * @method Phaser.GameObjects.Text#setShadowOffset * @since 3.0.0 * - * @param {[type]} x - [description] - * @param {[type]} y - [description] + * @param {number} x - [description] + * @param {number} y - [description] * - * @return {[type]} [description] + * @return {Phaser.GameObjects.Text} This Text object. */ setShadowOffset: function (x, y) { @@ -698,9 +698,9 @@ var Text = new Class({ * @method Phaser.GameObjects.Text#setShadowColor * @since 3.0.0 * - * @param {[type]} color - [description] + * @param {string} color - [description] * - * @return {[type]} [description] + * @return {Phaser.GameObjects.Text} This Text object. */ setShadowColor: function (color) { @@ -713,9 +713,9 @@ var Text = new Class({ * @method Phaser.GameObjects.Text#setShadowBlur * @since 3.0.0 * - * @param {[type]} blur - [description] + * @param {number} blur - [description] * - * @return {[type]} [description] + * @return {Phaser.GameObjects.Text} This Text object. */ setShadowBlur: function (blur) { @@ -728,9 +728,9 @@ var Text = new Class({ * @method Phaser.GameObjects.Text#setShadowStroke * @since 3.0.0 * - * @param {[type]} enabled - [description] + * @param {boolean} enabled - [description] * - * @return {[type]} [description] + * @return {Phaser.GameObjects.Text} This Text object. */ setShadowStroke: function (enabled) { @@ -743,9 +743,9 @@ var Text = new Class({ * @method Phaser.GameObjects.Text#setShadowFill * @since 3.0.0 * - * @param {[type]} enabled - [description] + * @param {boolean} enabled - [description] * - * @return {[type]} [description] + * @return {Phaser.GameObjects.Text} This Text object. */ setShadowFill: function (enabled) { @@ -753,26 +753,17 @@ var Text = new Class({ }, /** - * Set the width (in pixels) to use for wrapping lines. Pass in null to remove wrapping by - * width. - * - * @param {number|null} width - The maximum width of a line in pixels. Set to null to remove - * wrapping. - * @param {boolean} [useAdvancedWrap=false] - Whether or not to use the advanced wrapping - * algorithm. If true, spaces are collapsed and whitespace is trimmed from lines. If false, - * spaces and whitespace are left as is. - * @return {this} - */ - /** - * [description] + * Set the width (in pixels) to use for wrapping lines. Pass in null to remove wrapping by width. * * @method Phaser.GameObjects.Text#setWordWrapWidth * @since 3.0.0 * - * @param {[type]} width - [description] - * @param {[type]} useAdvancedWrap - [description] + * @param {number|null} width - The maximum width of a line in pixels. Set to null to remove wrapping. + * @param {boolean} [useAdvancedWrap=false] - Whether or not to use the advanced wrapping + * algorithm. If true, spaces are collapsed and whitespace is trimmed from lines. If false, + * spaces and whitespace are left as is. * - * @return {[type]} [description] + * @return {Phaser.GameObjects.Text} This Text object. */ setWordWrapWidth: function (width, useAdvancedWrap) { @@ -782,23 +773,16 @@ var Text = new Class({ /** * Set a custom callback for wrapping lines. Pass in null to remove wrapping by callback. * + * @method Phaser.GameObjects.Text#setWordWrapCallback + * @since 3.0.0 + * * @param {function} callback - A custom function that will be responsible for wrapping the * text. It will receive two arguments: text (the string to wrap), textObject (this Text * instance). It should return the wrapped lines either as an array of lines or as a string with * newline characters in place to indicate where breaks should happen. * @param {object} [scope=null] - The scope that will be applied when the callback is invoked. - * @return {this} - */ - /** - * [description] * - * @method Phaser.GameObjects.Text#setWordWrapCallback - * @since 3.0.0 - * - * @param {[type]} callback - [description] - * @param {[type]} scope - [description] - * - * @return {[type]} [description] + * @return {Phaser.GameObjects.Text} This Text object. */ setWordWrapCallback: function (callback, scope) { @@ -811,29 +795,28 @@ var Text = new Class({ * @method Phaser.GameObjects.Text#setAlign * @since 3.0.0 * - * @param {[type]} align - [description] + * @param {string} align - [description] * - * @return {[type]} [description] + * @return {Phaser.GameObjects.Text} This Text object. */ setAlign: function (align) { return this.style.setAlign(align); }, - // 'left' can be an object - // if only 'left' and 'top' are given they are treated as 'x' and 'y' /** - * [description] + * 'left' can be an object. + * If only 'left' and 'top' are given they are treated as 'x' and 'y' * * @method Phaser.GameObjects.Text#setPadding * @since 3.0.0 * - * @param {[type]} left - [description] - * @param {[type]} top - [description] - * @param {[type]} right - [description] - * @param {[type]} bottom - [description] + * @param {number|object} left - [description] + * @param {number} top - [description] + * @param {number} right - [description] + * @param {number} bottom - [description] * - * @return {[type]} [description] + * @return {Phaser.GameObjects.Text} This Text object. */ setPadding: function (left, top, right, bottom) { @@ -890,9 +873,9 @@ var Text = new Class({ * @method Phaser.GameObjects.Text#setMaxLines * @since 3.0.0 * - * @param {[type]} max - [description] + * @param {integer} [max=0] - [description] * - * @return {[type]} [description] + * @return {Phaser.GameObjects.Text} This Text object. */ setMaxLines: function (max) { @@ -905,7 +888,7 @@ var Text = new Class({ * @method Phaser.GameObjects.Text#updateText * @since 3.0.0 * - * @return {[type]} [description] + * @return {Phaser.GameObjects.Text} This Text object. */ updateText: function () { @@ -933,12 +916,12 @@ var Text = new Class({ var w = textSize.width + padding.left + padding.right; var h = textSize.height + padding.top + padding.bottom; - if (!style.fixedWidth) + if (style.fixedWidth === 0) { this.width = w; } - if (!style.fixedHeight) + if (style.fixedHeight === 0) { this.height = h; } @@ -1038,7 +1021,7 @@ var Text = new Class({ * @method Phaser.GameObjects.Text#getTextMetrics * @since 3.0.0 * - * @return {[type]} [description] + * @return {object} [description] */ getTextMetrics: function () { @@ -1051,7 +1034,7 @@ var Text = new Class({ * @method Phaser.GameObjects.Text#toJSON * @since 3.0.0 * - * @return {[type]} [description] + * @return {object} [description] */ toJSON: function () { diff --git a/src/gameobjects/tilemap/Tile.js b/src/gameobjects/tilemap/Tile.js index e45202ccf..6d347333a 100644 --- a/src/gameobjects/tilemap/Tile.js +++ b/src/gameobjects/tilemap/Tile.js @@ -2,6 +2,29 @@ var Class = require('../../utils/Class'); var Components = require('../components'); var Rectangle = require('../../geom/rectangle'); +/** + * A Tile is a representation of a single tile within the Tilemap. This is a lightweight data + * representation, so it's position information is stored without factoring in scroll, layer + * scale or layer position. + * + * @class Tile + * @memberOf Phaser.GameObjects.Tilemaps + * @constructor + * @since 3.0.0 + * + * @param {LayerData} layer - The LayerData object in the Tilemap that this tile belongs to. + * @param {integer} index - The unique index of this tile within the map. + * @param {integer} x - The x coordinate of this tile in tile coordinates. + * @param {integer} y - The y coordinate of this tile in tile coordinates. + * @param {integer} width - Width of the tile in pixels. + * @param {integer} height - Height of the tile in pixels. + * @param {integer} baseWidth - The base width a tile in the map (in pixels). Tiled maps support + * multiple tileset sizes within one map, but they are still placed at intervals of the base + * tile width. + * @param {integer} baseHeight - The base height of the tile in pixels (in pixels). Tiled maps + * support multiple tileset sizes within one map, but they are still placed at intervals of the + * base tile height. + */ var Tile = new Class({ Mixins: [ @@ -12,27 +35,6 @@ var Tile = new Class({ initialize: - /** - * A Tile is a representation of a single tile within the Tilemap. This is a lightweight data - * representation, so it's position information is stored without factoring in scroll, layer - * scale or layer position. - * - * @class Tile - * @constructor - * - * @param {LayerData} layer - The LayerData object in the Tilemap that this tile belongs to. - * @param {integer} index - The unique index of this tile within the map. - * @param {integer} x - The x coordinate of this tile in tile coordinates. - * @param {integer} y - The y coordinate of this tile in tile coordinates. - * @param {integer} width - Width of the tile in pixels. - * @param {integer} height - Height of the tile in pixels. - * @param {integer} baseWidth - The base width a tile in the map (in pixels). Tiled maps support - * multiple tileset sizes within one map, but they are still placed at intervals of the base - * tile width. - * @param {integer} baseHeight - The base height of the tile in pixels (in pixels). Tiled maps - * support multiple tileset sizes within one map, but they are still placed at intervals of the - * base tile height. - */ function Tile (layer, index, x, y, width, height, baseWidth, baseHeight) { /**