FontBase:getAdvanceX

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.