Difference between revisions of "FontBase:getAdvanceX"
From GiderosMobile
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
'''<translate>Available since</translate>:''' Gideros 2011.6<br/> | '''<translate>Available since</translate>:''' Gideros 2011.6<br/> | ||
| + | '''<translate>Class</translate>:''' [[Special:MyLanguage/FontBase|FontBase]]<br/> | ||
=== <translate>Description</translate> === | === <translate>Description</translate> === | ||
<translate><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 /></translate> | <br /></translate> | ||
<source lang="lua"> | <source lang="lua"> | ||
Revision as of 09:27, 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.
