Scaleform Studio Lua API Reference: scaleform.TextFormat object reference
scaleform.TextFormat object reference
Description
Used for formatting of text.
Constructors and accessors 
Other related reference items
Related help topics
Functions
Parameters
Returns
self : |
The text format currently considered. |
integer? |
The alpha value [0-255]. The ? notation indicates that this type is optional: there may be zero or one instances of it. |
Parameters
Returns
self : |
The text format currently considered. |
boolean? |
Returns true if the text is boldface and false otherwise. The ? notation indicates that this type is optional: there may be zero or one instances of it. |
Parameters
Returns
self : |
The text format to clear. |
| This function does not return any values. |
Parameters
Returns
self : |
The text format currently considered. |
|
The color of the text. The ? notation indicates that this type is optional: there may be zero or one instances of it. |
Parameters
Returns
init : |
An existing text format table to initialize with. The ? notation indicates that this type is optional: there may be zero or one instances of it. |
|
The newly created text format. |
Parameters
Returns
self : |
The text format currently considered. |
string? |
The font name. The ? notation indicates that this type is optional: there may be zero or one instances of it. |
Parameters
Returns
self : |
The text format currently considered. |
number? |
The font size. The ? notation indicates that this type is optional: there may be zero or one instances of it. |
Parameters
Returns
self : |
The text format currently considered. |
boolean? |
Returns true if the text is italicized and false otherwise. The ? notation indicates that this type is optional: there may be zero or one instances of it. |
Parameters
Returns
self : |
The text format currently considered. |
boolean? |
Returns true if the kerning is enabled and false otherwise. The ? notation indicates that this type is optional: there may be zero or one instances of it. |
Parameters
Returns
self : |
The text format currently considered. |
number? |
The letter spacing applied to the text. The ? notation indicates that this type is optional: there may be zero or one instances of it. |
Parameters
Returns
self : |
The text format currently considered. | |
alpha : | integer? |
The alpha value to apply [0-255]. The ? notation indicates that this type is optional: there may be zero or one instances of it. |
| This function does not return any values. |
Parameters
Returns
self : |
The text format currently considered. | |
bold : | boolean? |
A flag to set the text as boldface. The ? notation indicates that this type is optional: there may be zero or one instances of it. |
| This function does not return any values. |
Parameters
Returns
self : |
The text format currently considered. | |
color : |
The color to apply to the text. The ? notation indicates that this type is optional: there may be zero or one instances of it. |
| This function does not return any values. |
Parameters
Returns
self : |
The text format to apply. | |
fontName : | string? |
Name of the font. The ? notation indicates that this type is optional: there may be zero or one instances of it. |
fontNameSz : | integer? |
The font size. The ? notation indicates that this type is optional: there may be zero or one instances of it. |
| This function does not return any values. |
Parameters
Returns
self : |
The text format currently considered. | |
fontSize : | number? |
The font size. The ? notation indicates that this type is optional: there may be zero or one instances of it. |
| This function does not return any values. |
Parameters
Returns
self : |
The text format currently considered. | |
italic : | boolean? |
A flag to set the text in italics. The ? notation indicates that this type is optional: there may be zero or one instances of it. |
| This function does not return any values. |
Parameters
Returns
self : |
The text format currently considered. | |
kerning : | boolean? |
A flag to enable kerning. The ? notation indicates that this type is optional: there may be zero or one instances of it. |
| This function does not return any values. |
Parameters
Returns
self : |
The text format currently considered. | |
letterSpacing : | number? |
The letter space to apply. The ? notation indicates that this type is optional: there may be zero or one instances of it. |
| This function does not return any values. |
Parameters
Returns
self : |
The text format currently considered. | |
underline : | boolean? |
A flag to set the text as underlined. The ? notation indicates that this type is optional: there may be zero or one instances of it. |
| This function does not return any values. |
Parameters
Returns
self : |
The text format currently considered. | |
url : | string? |
The target url for the text. The ? notation indicates that this type is optional: there may be zero or one instances of it. |
| This function does not return any values. |
Parameters
Returns
self : |
The text format currently considered. |
boolean? |
Returns true if the text is underlined and false otherwise. The ? notation indicates that this type is optional: there may be zero or one instances of it. |
scaleform.TextComponent.default_formats (self) : scaleform.TextFormat, scaleform.ParagraphFormatReturns the default format applied within the text.
scaleform.TextComponent.text_format (self, startPos, endPos) : scaleform.TextFormatReturns the format of the text.
scaleform.TextFormat.create (init) : scaleform.TextFormatCreates a text format for the text.
scaleform.TextComponent.set_default_formats (self, txtFmt, pFmt) Sets the default format within the text.
scaleform.TextComponent.set_text_format (self, fmt, startPos, endPos) Sets the format of the text.
scaleform.TextFormat.alpha (self) : integer?Returns the alpha value of the color in the text.
self : scaleform.TextFormatThe text format currently considered.
integer?The ? notation indicates that this type is optional: there may be zero or one instances of it.
scaleform.TextFormatUsed for formatting of text. A strictly integral numeric value, with no decimal component.
scaleform.TextFormat.bold (self) : boolean?Specified whether the text in the text format is boldface.
self : scaleform.TextFormatThe text format currently considered.
boolean?The ? notation indicates that this type is optional: there may be zero or one instances of it.
true or false. scaleform.TextFormat.clear (self) Clears the format applied on the text.
self : scaleform.TextFormatThe text format to clear.
scaleform.TextFormat.color (self) : scaleform.Color?Returns the color applied to the text.
self : scaleform.TextFormatThe text format currently considered.
scaleform.Color?The color of the text.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
scaleform.Color{ alpha : integer, blue : integer, green : integer, red : integer, }
init : scaleform.TextFormat?An existing text format table to initialize with.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
scaleform.TextFormatThe newly created text format.
scaleform.TextFormat.font_name (self) : string?Returns the name of font applied to the text.
self : scaleform.TextFormatThe text format currently considered.
string?The ? notation indicates that this type is optional: there may be zero or one instances of it.
A string of characters. scaleform.TextFormat.font_size (self) : number?Returns the font size of the text.
self : scaleform.TextFormatThe text format currently considered.
number?The ? notation indicates that this type is optional: there may be zero or one instances of it.
A numeric value. scaleform.TextFormat.italic (self) : boolean?Specifies whether the text in the text format is italicized.
self : scaleform.TextFormatThe text format currently considered.
boolean?The ? notation indicates that this type is optional: there may be zero or one instances of it.
scaleform.TextFormat.kerning (self) : boolean?Specifies whether kerning adjustment is enabled for the text.
self : scaleform.TextFormatThe text format currently considered.
boolean?The ? notation indicates that this type is optional: there may be zero or one instances of it.
scaleform.TextFormat.letter_spacing (self) : number?Returns the letter spacing applied to the text.
self : scaleform.TextFormatThe text format currently considered.
number?The ? notation indicates that this type is optional: there may be zero or one instances of it.
scaleform.TextFormat.set_alpha (self, alpha) Sets the alpha value of the color in the text.
self : scaleform.TextFormatThe text format currently considered.
alpha : integer?The alpha value to apply [0-255].
The ? notation indicates that this type is optional: there may be zero or one instances of it.
scaleform.TextFormat.set_bold (self, bold) Sets the text in the text format as boldface.
self : scaleform.TextFormatThe text format currently considered.
bold : boolean?A flag to set the text as boldface.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
scaleform.TextFormat.set_color (self, color) Sets the color for the text.
self : scaleform.TextFormatThe text format currently considered.
color : scaleform.Color?The color to apply to the text.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
scaleform.TextFormat.set_font_name (self, fontName, fontNameSz) Sets a font to the text.
self : scaleform.TextFormatThe text format to apply.
fontName : string?Name of the font.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
fontNameSz : integer?The font size.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
scaleform.TextFormat.set_font_size (self, fontSize) Sets the font size of the text.
self : scaleform.TextFormatThe text format currently considered.
fontSize : number?The font size.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
scaleform.TextFormat.set_italic (self, italic) Sets the text in the text format in italics.
self : scaleform.TextFormatThe text format currently considered.
italic : boolean?A flag to set the text in italics.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
scaleform.TextFormat.set_kerning (self, kerning) Enables kerning adjustment for the text.
self : scaleform.TextFormatThe text format currently considered.
kerning : boolean?A flag to enable kerning.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
scaleform.TextFormat.set_letter_spacing (self, letterSpacing) Applies letter spacing to the text.
self : scaleform.TextFormatThe text format currently considered.
letterSpacing : number?The letter space to apply.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
scaleform.TextFormat.set_underline (self, underline) Sets the text in the text format as underlined.
self : scaleform.TextFormatThe text format currently considered.
underline : boolean?A flag to set the text as underlined.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
scaleform.TextFormat.set_url (self, url) Sets the url for the text.
self : scaleform.TextFormatThe text format currently considered.
url : string?The target url for the text.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
scaleform.TextFormat.underline (self) : boolean?Specifies whether the text in the text format is underlined.
self : scaleform.TextFormatThe text format currently considered.
boolean?The ? notation indicates that this type is optional: there may be zero or one instances of it.
scaleform.TextFormat.url (self) : string?Returns the hyperlink set for the text in the text format.
self : scaleform.TextFormatThe text format currently considered.
string?The ? notation indicates that this type is optional: there may be zero or one instances of it.
self : scaleform.TextComponentThe text component whose property is set.
scaleform.TextFormatThe text format applied.
scaleform.ParagraphFormatThe paragraph format applied.
self : scaleform.TextComponentThe text component whose property is set.
startPos : integer?The start position of the text.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
endPos : integer?The end position of the text.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
scaleform.TextFormatCurrently set text value in HTML format.
self : scaleform.TextComponentThe text component whose property is set.
txtFmt : scaleform.TextFormatThe text format to apply.
pFmt : scaleform.ParagraphFormatThe paragraph format to apply.
self : scaleform.TextComponentThe text component whose property is set.
fmt : scaleform.TextFormatThe format of the text.
startPos : integer?The start position of the text.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
endPos : integer?The end position of the text.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
scaleform.TextComponentRepresent the text field.
scaleform.ParagraphFormatUsed for formatting of paragraphs. Indicates a table.
This documentation uses the term table to mean an anonymous, temporary Lua table that contains named data values. You typically use these tables to pass data or settings to a function, or to hold data returned by a function.Indicates an object.
This documentation uses the term object to mean a named Lua table or userdata value that maintains a state. Some object types may have multiple instances existing at the same time, each with its own state; these objects typically have creation functions or accessors that you must call in order to get an instance. Some object types have only one instance, which you always access through the object's name.Indicates a named variable within a namespace, object or table; or an element within an enumeration.Indicates a code sample.Indicates an enumeration.
This documentation uses the term enumeration to mean a named Lua table that contains only a set of constant values. These values typically identify a predefined set of options for some setting or behavior. You might pass an enumeration value to a function, or test the value returned by a function against the items in the enumeration to see which option is currently set.Indicates a named variable within a namespace or object that has a pre-set constant value.Indicates a category: a semantic grouping of related API elements.Indicates a namespace.
This documentation uses the term namespace to mean a named Lua table that exists in only one single instance, intended as a container for an interface of related objects, functions and data variables.Indicates an output value returned by a function.Indicates a named function within a namespace or object.Indicates an input parameter for a function.