Scaleform Studio Lua API Reference: scaleform.ParagraphFormat object reference
scaleform.ParagraphFormat object reference
Description
Used for formatting of paragraphs.
Constructors and accessors 
Other related reference items
Related help topics
Functions
Parameters
Returns
self : |
The paragraph format currently considered. |
|
The alignment type of the paragraph. The ? notation indicates that this type is optional: there may be zero or one instances of it. |
Parameters
Returns
self : |
The paragraph format currently considered. |
number? |
Returns the block indent amount The ? notation indicates that this type is optional: there may be zero or one instances of it. |
Parameters
Returns
self : |
The paragraph format currently considered. |
boolean? |
Returns true if text is part of bulleted list and false otherwise. The ? notation indicates that this type is optional: there may be zero or one instances of it. |
Parameters
Returns
self : |
The paragraph format to clear. |
| This function does not return any values. |
Parameters
Returns
init : |
An paragraph format to initialize to. The ? notation indicates that this type is optional: there may be zero or one instances of it. |
|
The newly created paragraph format. |
Parameters
Returns
self : |
The paragraph format currently considered. |
number? |
The indent amount The ? notation indicates that this type is optional: there may be zero or one instances of it. |
Parameters
Returns
self : |
The paragraph format currently considered. |
number? |
Returns the leading value. The ? notation indicates that this type is optional: there may be zero or one instances of it. |
Parameters
Returns
self : |
The paragraph format currently considered. |
number? |
The left margin. The ? notation indicates that this type is optional: there may be zero or one instances of it. |
Parameters
Returns
self : |
The paragraph format currently considered. |
number? |
The right margin. The ? notation indicates that this type is optional: there may be zero or one instances of it. |
Parameters
Returns
self : |
The paragraph format currently considered. | |
alignType : |
The alignment type of the paragraph, scaleform.AlignModes. 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 paragraph format currently considered. | |
value : | number? |
the block indentation value. 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 paragraph format currently considered. | |
bullet : | boolean? |
A flag to set text as part of bulleted list. 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 paragraph format currently considered. | |
value : | number? |
The indentation value. 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 paragraph format currently considered. | |
leading : | number? |
The leading value. 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 paragraph format currently considered. | |
value : | number? |
The left margin. The ? notation indicates that this type is optional: there may be zero or one instances of it. |
| This function does not return any values. |
scaleform.ParagraphFormat.create (init) : scaleform.ParagraphFormatCreates a paragraph format for the text.
scaleform.TextComponent.default_formats (self) : scaleform.TextFormat, scaleform.ParagraphFormatReturns the default format applied within the text.
scaleform.TextComponent.paragraph_format (self, startPos, endPos) : scaleform.ParagraphFormatReturns the paragraph format used within the text component.
scaleform.TextComponent.set_default_formats (self, txtFmt, pFmt) Sets the default format within the text.
scaleform.TextComponent.set_paragraph_format (self, fmt, startPos, endPos) Sets the paragraph format within the text.
scaleform.ParagraphFormat.alignment (self) : scaleform.AlignModes?Gets the alignment type of the paragraph text.
self : scaleform.ParagraphFormatThe paragraph format currently considered.
scaleform.AlignModes?The alignment type of the paragraph.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
scaleform.ParagraphFormatUsed for formatting of paragraphs.
scaleform.AlignModesThe alignment types for paragraph formatting.
scaleform.ParagraphFormat.block_indent (self) : number?Get the block indent amount.
self : scaleform.ParagraphFormatThe paragraph 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.ParagraphFormat.bullet (self) : boolean?Checks if the text is part of bulleted list.
self : scaleform.ParagraphFormatThe paragraph 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.ParagraphFormat.clear (self) Clears the format applied on the paragraph.
self : scaleform.ParagraphFormatThe paragraph format to clear.
init : scaleform.ParagraphFormat?An paragraph format to initialize to.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
scaleform.ParagraphFormatThe newly created paragraph format.
scaleform.ParagraphFormat.indent (self) : number?Gets the first line indent amount.
self : scaleform.ParagraphFormatThe paragraph format currently considered.
number?The ? notation indicates that this type is optional: there may be zero or one instances of it.
scaleform.ParagraphFormat.leading (self) : number?Returns the leading value set for the text.
self : scaleform.ParagraphFormatThe paragraph format currently considered.
number?The ? notation indicates that this type is optional: there may be zero or one instances of it.
scaleform.ParagraphFormat.left_margin (self) : number?Returns the left margin of the paragraph.
self : scaleform.ParagraphFormatThe paragraph format currently considered.
number?The ? notation indicates that this type is optional: there may be zero or one instances of it.
scaleform.ParagraphFormat.right_margin (self) : number?Returns the right margin of the paragraph.
self : scaleform.ParagraphFormatThe paragraph format currently considered.
number?The ? notation indicates that this type is optional: there may be zero or one instances of it.
scaleform.ParagraphFormat.set_alignment (self, alignType) Sets the alignment type of the paragraph text.
self : scaleform.ParagraphFormatThe paragraph format currently considered.
alignType : scaleform.AlignModes?The alignment type of the paragraph, scaleform.AlignModes.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
scaleform.ParagraphFormat.set_block_indent (self, value) Sets block indentation to an entire block of text.
self : scaleform.ParagraphFormatThe paragraph format currently considered.
value : number?the block indentation value.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
scaleform.ParagraphFormat.set_bullet (self, bullet) Sets the text in the paragraph to be part of bulleted list.
self : scaleform.ParagraphFormatThe paragraph format currently considered.
bullet : boolean?A flag to set text as part of bulleted list.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
scaleform.ParagraphFormat.set_indent (self, value) Sets indentation from the left margin to the first character in the paragraph.
self : scaleform.ParagraphFormatThe paragraph format currently considered.
value : number?The indentation value.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
scaleform.ParagraphFormat.set_leading (self, leading) Sets leading value to indicate the amount of vertical space between lines.
self : scaleform.ParagraphFormatThe paragraph format currently considered.
leading : number?The leading value.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
scaleform.ParagraphFormat.set_left_margin (self, value) Sets the left margin of the paragraph.
self : scaleform.ParagraphFormatThe paragraph format currently considered.
value : number?The left margin.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
scaleform.ParagraphFormat.set_right_margin (self, value) Sets the right margin of the paragraph.
self : scaleform.ParagraphFormatThe paragraph format currently considered.
value : number?The right margin.
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.ParagraphFormatThe paragraph format set within the text component.
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.ParagraphFormatThe format to apply to 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.TextFormatUsed for formatting of text. A strictly integral numeric value, with no decimal component.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.