Difference between revisions of "FontBase:getAdvanceX"
From GiderosMobile
| Line 2: | Line 2: | ||
'''Available since:''' Gideros 2011.6<br/> | '''Available since:''' Gideros 2011.6<br/> | ||
=== Description === | === Description === | ||
| − | <br /> | + | <translate><br /> |
| − | Returns the width of the first | + | 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 | + | 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 /> | |
| − | whereas | + | whereas [[[getAdvanceX()]]] returns the distance to where the next string should be drawn.<br /> |
| − | <br /> | + | <br /></translate> |
<source lang="lua"> | <source lang="lua"> | ||
(number) = FontBase:getAdvanceX(text,letterSpacing,size) | (number) = FontBase:getAdvanceX(text,letterSpacing,size) | ||
</source> | </source> | ||
=== Parameters === | === Parameters === | ||
| − | '''text''': (string) | + | '''text''': (string) <translate></translate> <br/> |
| − | '''letterSpacing''': (number, default = 0) | + | '''letterSpacing''': (number, default = 0) <translate></translate> <br/> |
| − | '''size''': (number, optional) | + | '''size''': (number, optional) <translate></translate> <br/> |
=== Return values === | === Return values === | ||
| − | '''Returns''' (number) The width of the first size characters of text.<br/> | + | '''Returns''' (number) <translate>The width of the first size characters of text.</translate><br/> |
Revision as of 14:33, 23 August 2018
Available since: Gideros 2011.6
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.
