Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2025-02-16 22:18:29 +00:00
Code Issues Projects Releases Packages Wiki Activity

Fixed incorrect jsdocs #6309

Browse source
This commit is contained in:
Richard Davey 2022-12-09 15:59:02 +00:00
parent 784f04cf61
commit a41247e2d9
1 changed files with 11 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
src/gameobjects/bitmaptext/static/BitmapText.js
View file

@ -393,24 +393,26 @@ var BitmapText = new Class({
return this;
},
/**
* The line spacing value.
* This value is added to the font height to calculate the overall line height.
* Only has an effect if this Text object contains multiple lines of text.
* Sets the line spacing value. This value is added to the font height to
* calculate the overall line height.
*
* Spacing can be a negative or positive number.
*
* @name Phaser.GameObjects.BitmapText#setLineSpacing
* @type {number}
* Only has an effect if this BitmapText object contains multiple lines of text.
*
* @method Phaser.GameObjects.BitmapText#setLineSpacing
* @since 3.60.0
*
* @param {number} [spacing=0] - The amount of space to add between each line in multi-line text.
*
* @return {this} This BitmapText Object.
*/
setLineSpacing: function (spacing)
{
if (spacing === undefined) { spacing = 0; }
this._lineSpacing = spacing;
this._dirty = true;
this.lineSpacing = spacing;
return this;
},