FontBase:getAdvanceX: Difference between revisions

From GiderosMobile
No edit summary
No edit summary
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
__NOTOC__
'''Available since:''' Gideros 2011.6<br/>
<languages />
'''Class:''' [[FontBase]]<br/>
'''<translate>Available since</translate>:''' Gideros 2011.6<br/>
 
'''<translate>Class</translate>:''' [[Special:MyLanguage/FontBase|FontBase]]<br/>
=== Description ===
=== <translate>Description</translate> ===
Returns the width of the first ''size'' characters of ''text''.
<translate><br />
<syntaxhighlight lang="lua">
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 ''getBounds()''. <br />
''getBounds()'' returns a rectangle describing the bounds this string will cover <br />
whereas ''getAdvanceX()'' returns the distance to where the next string should be drawn.<br />
<br /></translate>
<source lang="lua">
(number) = FontBase:getAdvanceX(text,letterSpacing,size)
(number) = FontBase:getAdvanceX(text,letterSpacing,size)
</source>
</syntaxhighlight>
=== <translate>Parameters</translate> ===
 
'''text''': (string) <translate></translate> <br/>
Note that this value is not equal to the 3rd return value (width) of ''getBounds()''.
'''letterSpacing''': (number, default = 0) <translate></translate> <br/>
 
'''size''': (number, optional) <translate></translate> <br/>
''getBounds()'' returns a rectangle describing the bounds this string will cover whereas ''getAdvanceX()'' returns the distance to where the next string should be drawn.
=== <translate>Return values</translate> ===
 
'''<translate>Returns</translate>''' (number) <translate>The width of the first size characters of text.</translate><br/>
=== Parameters ===
'''text''': (string) <br/>
'''letterSpacing''': (number, default = 0) <br/>
'''size''': (number, optional) <br/>
 
=== Return values ===
'''Returns''' (number) the width of the first size characters of text<br/>
 
{{FontBase}}

Latest revision as of 17: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