Difference between revisions of "FontBase:getAdvanceX"

From GiderosMobile
Line 11: Line 11:
 
(number) = FontBase:getAdvanceX(text,letterSpacing,size)
 
(number) = FontBase:getAdvanceX(text,letterSpacing,size)
 
</source>
 
</source>
'''text''': (string)  ''''''<br/>
+
=== Parameters ===
'''letterSpacing''': (number, default = 0)  ''''''<br/>
+
'''text''': (string)  <br/>
'''size''': (number, optional)  ''''''<br/>
+
'''letterSpacing''': (number, default = 0)  <br/>
 +
'''size''': (number, optional)  <br/>
 +
=== Return values ===
 
'''Returns''' (number) The width of the first size characters of text.<br/>
 
'''Returns''' (number) The width of the first size characters of text.<br/>

Revision as of 10:44, 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.