Difference between revisions of "FontBase:getAdvanceX"

From GiderosMobile
m (Text replacement - "</source>" to "</syntaxhighlight>")
 
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 whereas ''getAdvanceX()'' returns the distance to where the next string should be drawn.
 
''getBounds()'' returns a rectangle describing the bounds this string will cover whereas ''getAdvanceX()'' returns the distance to where the next string should be drawn.
 
<syntaxhighlight lang="lua">
 
(number) = FontBase:getAdvanceX(text,letterSpacing,size)
 
</syntaxhighlight>
 
  
 
=== Parameters ===
 
=== Parameters ===
Line 19: Line 18:
  
 
=== Return values ===
 
=== 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/>
  
 
{{FontBase}}
 
{{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