Difference between revisions of "FontBase:getAdvanceX"
From GiderosMobile
| (4 intermediate revisions by 2 users not shown) | |||
| Line 4: | Line 4: | ||
=== Description === | === Description === | ||
Returns the width of the first ''size'' characters of ''text''. | Returns the width of the first ''size'' characters of ''text''. | ||
| + | <syntaxhighlight lang="lua"> | ||
| + | (number) = FontBase:getAdvanceX(text,letterSpacing,size) | ||
| + | </syntaxhighlight> | ||
Note that this value is not equal to the 3rd return value (width) of ''getBounds()''. | 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 | + | ''getBounds()'' returns a rectangle describing the bounds this string will cover whereas ''getAdvanceX()'' returns the distance to where the next string should be drawn. |
| − | whereas ''getAdvanceX()'' returns the distance to where the next string should be drawn. | ||
| − | |||
| − | |||
| − | |||
| − | |||
=== Parameters === | === Parameters === | ||
| Line 20: | Line 18: | ||
=== Return values === | === Return values === | ||
| − | '''Returns''' (number) | + | '''Returns''' (number) the width of the first size characters of text<br/> |
| − | |||
| − | |||
| − | |||
| − | <br/> | ||
| − | {{ | + | {{FontBase}} |
| − | |||
Latest revision as of 18:12, 17 November 2023
Available since: Gideros 2011.6
Class: FontBase
Description
Returns the width of the first size characters of text.
(number) = FontBase:getAdvanceX(text,letterSpacing,size)
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.
Parameters
text: (string)
letterSpacing: (number, default = 0)
size: (number, optional)
Return values
Returns (number) the width of the first size characters of text
