FontBase:getAdvanceX: Difference between revisions

From GiderosMobile
No edit summary
No edit summary
Line 4: Line 4:
=== <translate>Description</translate> ===
=== <translate>Description</translate> ===
<translate><br />
<translate><br />
Returns the width of the first `size` characters of `text`. <br />
Returns the width of the first ''size'' characters of ''text''. <br />
Note that this value is not equal to the 3rd return value (width) of `getBounds()`. <br />
Note that this value is not equal to the 3rd return value (width) of ''getBounds()''. <br />
`getBounds()` returns a rectangle describing the bounds this string will cover <br />
''getBounds()'' returns a rectangle describing the bounds this string will cover <br />
whereas `getAdvanceX()` returns the distance to where the next string should be drawn.<br />
whereas ''getAdvanceX()'' returns the distance to where the next string should be drawn.<br />
<br /></translate>
<br /></translate>
<source lang="lua">
<source lang="lua">

Revision as of 08:37, 24 August 2018

Available since: Gideros 2011.6
Class: FontBase

Description


Returns the width of the first size characters of text.
Note that this value is not equal to the 3rd return value (width) of getBounds().
getBounds() returns a rectangle describing the bounds this string will cover
whereas getAdvanceX() returns the distance to where the next string should be drawn.

(number) = FontBase:getAdvanceX(text,letterSpacing,size)

Parameters

text: (string)
letterSpacing: (number, default = 0)
size: (number, optional)

Return values

Returns (number) The width of the first size characters of text.