Difference between revisions of "FontBase:getAdvanceX"
From GiderosMobile
(Created page with "__NOTOC__ '''Available since:''' Gideros 2011.6<br/> === Description === <br /> Returns the width of the first `size` characters of `text`. <br /> Note that this value is not...") |
|||
| (15 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | |||
'''Available since:''' Gideros 2011.6<br/> | '''Available since:''' Gideros 2011.6<br/> | ||
| + | '''Class:''' [[FontBase]]<br/> | ||
| + | |||
=== Description === | === Description === | ||
| − | + | Returns the width of the first ''size'' characters of ''text''. | |
| − | Returns the width of the first | + | <syntaxhighlight lang="lua"> |
| − | Note that this value is not equal to the 3rd return value (width) of | + | (number) = FontBase:getAdvanceX(text,letterSpacing,size) |
| − | + | </syntaxhighlight> | |
| − | whereas | + | |
| − | + | 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. | |
| − | + | ||
| − | '''text | + | === Parameters === |
| − | '''letterSpacing | + | '''text''': (string) <br/> |
| − | '''size | + | '''letterSpacing''': (number, default = 0) <br/> |
| − | '''Returns''' (number) | + | '''size''': (number, optional) <br/> |
| + | |||
| + | === Return values === | ||
| + | '''Returns''' (number) the width of the first size characters of text<br/> | ||
| + | |||
| + | {{FontBase}} | ||
Latest revision as of 19: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
