Scaleform Studio Lua API Reference: scaleform.TextComponent object reference

scaleform.TextComponent object reference
Functions
expand all | collapse all

Description

Represent the text field.

Functions

Parameters

self :

scaleform.TextComponent

The text component whose property is set.

Returns

boolean

Returns true if the selection is shown even when not focused and false otherwise.

Parameters

self :

scaleform.TextComponent

The text component whose property is set.

Returns

scaleform.TextAAModes

The anti-aliasing mode of the text component.

Parameters

self :

scaleform.TextComponent

The text component whose size is automatically set.

Returns

boolean

Returns true if the text is auto-sized by x axis and false otherwise.

Parameters

self :

scaleform.TextComponent

The text component whose size is automatically set.

Returns

boolean

Returns true if the text is auto-sized by y axis and false otherwise.

Parameters

self :

scaleform.TextComponent

The text component whose background color is set.

Returns

scaleform.Color

Currently set background color of the text.

If alpha is 0, then background is turned off.

Parameters

self :

scaleform.TextComponent

The text component whose property is set.

Returns

boolean

Returns true if bidirectional text is supported and false otherwise.

Parameters

self :

scaleform.TextComponent

The text component whose color is set.

Returns

scaleform.Color

The border color set around the text.

Parameters

self :

scaleform.TextComponent

The text component whose scroll value is set.

Returns

integer

Returns the index of bottommost line.

Parameters

owner :

scaleform.Actor

The owner actor of the component.

Returns

scaleform.TextComponent

The newly created text component.

Parameters

self :

scaleform.TextComponent

The text component whose property is set.

Returns

scaleform.TextFormat

The text format applied.

scaleform.ParagraphFormat

The paragraph format applied.

Parameters

self :

scaleform.TextComponent

The text component whose property is set.

Returns

boolean

Returns true if the text is editable and false otherwise.

Parameters

self :

scaleform.TextComponent

The text component whose property is set.

Returns

string

Currently set text value in HTML format.

Parameters

self :

scaleform.TextComponent

The text component whose text is substituted with image.

substring :

string

A sub-string in the text to check for image substitution.

Returns

table?

The image descriptor table containing the image used as substitution for text.

The ? notation indicates that this type is optional: there may be zero or one instances of it.
Parameters

self :

scaleform.TextComponent

The text component whose property is set.

Returns

integer

The length of the text.

Parameters

self :

scaleform.TextComponent

The text component whose property is set.

Returns

integer

The maximum length of the text that can be entered.

Parameters

self :

scaleform.TextComponent

The text component whose scroll value is obtained.

Returns

integer

The scroll value for vertical scrolling.

Parameters

self :

scaleform.TextComponent

The text component whose scroll value is obtained.

Returns

number

The scroll value for horizontal scrolling.

Parameters

self :

scaleform.TextComponent

The text component whose property is set.

Returns

boolean

Whether the text is multiline(true) or not.

Parameters

self :

scaleform.TextComponent

The text component currently in use.

Returns

integer

Returns number of lines.

Parameters

self :

scaleform.TextComponent

The text component whose property is set.

Returns

boolean

Returns true if the text is overwritable and false otherwise.

Parameters

self :

scaleform.TextComponent

The 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.
Returns

scaleform.ParagraphFormat

The paragraph format set within the text component.

Parameters

self :

scaleform.TextComponent

The text component whose property is set.

Returns

boolean

Whether password mode is set for text or not.

Parameters

self :

scaleform.TextComponent

The text component whose dimensions is set.

Returns

scaleform.Rect

The rectangle within the text component.

Parameters

self :

scaleform.TextComponent

The text component whose scroll value is obtained.

Returns

integer

The scroll value for vertical scrolling.

Parameters

self :

scaleform.TextComponent

The text component whose scroll value is obtained.

Returns

number

The scroll value for horizontal scrolling.

Parameters

self :

scaleform.TextComponent

The text component whose property is set.

Returns

boolean

Returns true if the text is selectable and false otherwise.

Parameters

self :

scaleform.TextComponent

The text component whose property is set.

v :

boolean

A flag to turn selection on/off.

Returns
This function does not return any values.
Parameters

self :

scaleform.TextComponent

The text component whose property is set.

mode :

scaleform.TextAAModes

The anti-aliasing mode.

Returns
This function does not return any values.
Parameters

self :

scaleform.TextComponent

The text component whose size is set.

autoSize :

boolean

A flag to set automatic resizing by X axis.

Returns
This function does not return any values.
Parameters

self :

scaleform.TextComponent

The text component whose size is set.

autoSize :

boolean

A flag to set automatic resizing by Y axis.

Returns
This function does not return any values.
Parameters

self :

scaleform.TextComponent

The text component whose background color is set.

color :

scaleform.Color

The color to use.

Returns
This function does not return any values.
Parameters

self :

scaleform.TextComponent

The text component whose property is set.

en :

boolean

A flag to determine whether to enable bidirectional text support.

Returns
This function does not return any values.
Parameters

self :

scaleform.TextComponent

The text component whose color is set.

Returns
This function does not return any values.

If alpha is set to 0, then border is not drawn.

Parameters

self :

scaleform.TextComponent

The text component whose property is set.

txtFmt :

scaleform.TextFormat

The text format to apply.

pFmt :

scaleform.ParagraphFormat

The paragraph format to apply.

Returns
This function does not return any values.
Parameters

self :

scaleform.TextComponent

The text component whose dimensions is set.

dim :

scaleform.Size

The size of the text component.

Returns
This function does not return any values.
Parameters

self :

scaleform.TextComponent

The text component whose property is set.

v :

boolean

A flag to turn on/off the text editing.

Returns
This function does not return any values.
Parameters

self :

scaleform.TextComponent

The text component whose filter is set.

filters :

table?

A table containing the filters to set to the text.

The ? notation indicates that this type is optional: there may be zero or one instances of it.
Returns
This function does not return any values.
Parameters

self :

scaleform.TextComponent

The text component whose property is set.

text :

string

A value assigned as HTML encoded string value.

length :

integer?

Length of the text.

The ? notation indicates that this type is optional: there may be zero or one instances of it.
Returns
This function does not return any values.
Parameters

self :

scaleform.TextComponent

The text component whose text is substituted with image.

imagesubstitute_desc :

table?

A table with the image description.

The ? notation indicates that this type is optional: there may be zero or one instances of it.

substring :

string?

A sub-string in the text to be replaced by an image from the imagesubstitute_desc descriptor.

The ? notation indicates that this type is optional: there may be zero or one instances of it.
Returns

boolean

Returns true if the substitution is set and false otherwise.

Parameters

self :

scaleform.TextComponent

The text component whose property is set.

maxLen :

integer

The maximum length of the string which will be displayed.

Returns
This function does not return any values.
Parameters

self :

scaleform.TextComponent

The text component whose multi-line property is set.

value :

boolean

The value to use to set the multi-line property.

Returns
This function does not return any values.
Parameters

self :

scaleform.TextComponent

The text component whose property is set.

overwrite :

boolean

A flag to turn on/off the overwriting mode.

Returns
This function does not return any values.
Parameters

self :

scaleform.TextComponent

The text component whose property is set.

fmt :

scaleform.ParagraphFormat

The 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.
Returns
This function does not return any values.
Parameters

self :

scaleform.TextComponent

The text component whose property is set.

pswd :

boolean

A flag to set the text in password mode

Returns
This function does not return any values.
Parameters

self :

scaleform.TextComponent

The text component whose dimensions is set.

rect :

scaleform.Rect

The rectangle to use.

Returns
This function does not return any values.
Parameters

self :

scaleform.TextComponent

The text component whose scroll value is set.

v :

integer

The value set as vertical scroll value.

Returns
This function does not return any values.
Parameters

self :

scaleform.TextComponent

The text component whose scroll value is set.

x :

number

The value set as horizontal scroll value.

Returns
This function does not return any values.
Parameters

self :

scaleform.TextComponent

The text component whose property is set.

v :

boolean

A flag to select/deselect text.

Returns
This function does not return any values.
Parameters

self :

scaleform.TextComponent

The text component whose property is set.

text :

string

A value assigned as text.

length :

integer?

Length of the text.

The ? notation indicates that this type is optional: there may be zero or one instances of it.
Returns
This function does not return any values.
Parameters

self :

scaleform.TextComponent

The text component whose property is set.

fmt :

scaleform.TextFormat

The 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.
Returns
This function does not return any values.
Parameters

self :

scaleform.TextComponent

The text component whose property is set.

align :

scaleform.VAlignModes

The alignment

Returns
This function does not return any values.
Parameters

self :

scaleform.TextComponent

The text component whose property is set.

wordwrap :

boolean

The flag to turn on/off wordwrapping feature.

Returns
This function does not return any values.
Parameters

self :

scaleform.TextComponent

The text component whose property is set.

Returns

string

Currently set text value.

Parameters

self :

scaleform.TextComponent

The text component currently in use.

Returns

scaleform.Size

The dimensions of the text component.

Parameters

self :

scaleform.TextComponent

The 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.
Returns

scaleform.TextFormat

Currently set text value in HTML format.

Parameters

self :

scaleform.TextComponent

The text component currently in use.

Returns

number

The height of text inside the component.

Parameters

self :

scaleform.TextComponent

The text component currently in use.

Returns

number

The width of text inside the component.

Parameters

self :

scaleform.TextComponent

The text component whose property is set.

Returns

scaleform.VAlignModes

Vertical alignment of the text component.

Parameters

self :

scaleform.TextComponent

The text component whose property is set.

Returns

boolean

Whether wordwrapping is turned on/off.

 scaleform.Component
The root type of all actor components.  scaleform.VisualComponent
An interface to the visual component.  scaleform.TextComponent.create (owner) : scaleform.TextComponent
Creates a new text component.  scaleform.TextComponent.always_show_selection (self) : boolean
Checks whether the text component keeps showing selection when not focused or not.  self : scaleform.TextComponent
The text component whose property is set.  boolean  scaleform.TextComponent
Represent the text field. true or false.  scaleform.TextComponent.antialiasing_mode (self) : scaleform.TextAAModes
Returns the currently set anti-aliasing mode of the text component.  self : scaleform.TextComponent
The text component whose property is set.  scaleform.TextAAModes
The anti-aliasing mode of the text component.  scaleform.TextAAModes
The different anti-aliasing modes can be set for a text component.  scaleform.TextComponent.auto_size_x (self) : boolean
Checks if the text is auto-sized and returns the value set.  self : scaleform.TextComponent
The text component whose size is automatically set.  boolean  scaleform.TextComponent.auto_size_y (self) : boolean
Checks if the text is auto-sized and returns the value set.  self : scaleform.TextComponent
The text component whose size is automatically set.  boolean  scaleform.TextComponent.background_color (self) : scaleform.Color
Returns the background color of the text component.  self : scaleform.TextComponent
The text component whose background color is set.  scaleform.Color
Currently set background color of the text.  scaleform.Color

{ alpha : integer, blue : integer, green : integer, red : integer, }  scaleform.TextComponent.bidirectional_text (self) : boolean
Determines if bidirectional text support is enabled on the component.  self : scaleform.TextComponent
The text component whose property is set.  boolean  scaleform.TextComponent.border_color (self) : scaleform.Color
Returns the currently set border color.  self : scaleform.TextComponent
The text component whose color is set.  scaleform.Color
The border color set around the text.  scaleform.TextComponent.bottom_scroll_line (self) : integer
Returns the index of bottommost line.  self : scaleform.TextComponent
The text component whose scroll value is set.  integerA strictly integral numeric value, with no decimal component.  owner : scaleform.Actor
The owner actor of the component.  scaleform.TextComponent
The newly created text component.  scaleform.Actor
Generic objects located in a scene.  scaleform.TextComponent.default_formats (self) : scaleform.TextFormat, scaleform.ParagraphFormat
Returns the default format applied within the text.  self : scaleform.TextComponent
The text component whose property is set.  scaleform.TextFormat
The text format applied.  scaleform.ParagraphFormat
The paragraph format applied.  scaleform.TextFormat
Used for formatting of text.  scaleform.ParagraphFormat
Used for formatting of paragraphs.  scaleform.TextComponent.editable (self) : boolean
Determines if the text is editable on the component.  self : scaleform.TextComponent
The text component whose property is set.  boolean  scaleform.TextComponent.html_text (self) : string
Returns the text value in HTML format.  self : scaleform.TextComponent
The text component whose property is set.  stringA string of characters.  scaleform.TextComponent.image_substitution (self, substring) : table?
Returns an image descriptor for a sub-string in the text or nil if not found.  self : scaleform.TextComponent
The text component whose text is substituted with image.  substring : string
A sub-string in the text to check for image substitution.  table?
The image descriptor table containing the image used as substitution for text.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
A Lua table consisting of paired keys and values.  scaleform.TextComponent.length (self) : integer
Returns the length of the text.  self : scaleform.TextComponent
The text component whose property is set.  integer  scaleform.TextComponent.max_length (self) : integer
Returns the maximum length of the text that can be entered.  self : scaleform.TextComponent
The text component whose property is set.  integer  scaleform.TextComponent.max_scroll_line (self) : integer
Returns the maximum value for vertical scrolling.  self : scaleform.TextComponent
The text component whose scroll value is obtained.  integer  scaleform.TextComponent.max_scroll_x (self) : number
Returns the maximum value for horizontal scrolling.  self : scaleform.TextComponent
The text component whose scroll value is obtained.  numberA numeric value.  scaleform.TextComponent.multiline (self) : boolean
Determines whether the text is multi-line or single-line.  self : scaleform.TextComponent
The text component whose property is set.  boolean  scaleform.TextComponent.num_lines (self) : integer
Returns the number of lines in the text component.  self : scaleform.TextComponent
The text component currently in use.  integer  scaleform.TextComponent.overwritable (self) : boolean
Determines if text overwritable mode is enabled on the component.  self : scaleform.TextComponent
The text component whose property is set.  boolean  scaleform.TextComponent.paragraph_format (self, startPos, endPos) : scaleform.ParagraphFormat
Returns the paragraph format used within the text component.  self : scaleform.TextComponent
The 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.ParagraphFormat
The paragraph format set within the text component.  scaleform.TextComponent.password_mode (self) : boolean
Determines if password mode is set for the text.  self : scaleform.TextComponent
The text component whose property is set.  boolean  scaleform.TextComponent.rect (self) : scaleform.Rect
Returns the position and dimensions of the text component.  self : scaleform.TextComponent
The text component whose dimensions is set.  scaleform.Rect
The rectangle within the text component.  scaleform.Rect
A rectangle based upon two points.
{ x1 : number, x2 : number, y1 : number, y2 : number, }  scaleform.TextComponent.scroll_line (self) : integer
Returns the value for vertical scrolling.  self : scaleform.TextComponent
The text component whose scroll value is obtained.  integer  scaleform.TextComponent.scroll_x (self) : number
Returns the value for horizontal scrolling.  self : scaleform.TextComponent
The text component whose scroll value is obtained.  number  scaleform.TextComponent.selectable (self) : boolean
Determines if the text is selectable on the component.  self : scaleform.TextComponent
The text component whose property is set.  boolean  scaleform.TextComponent.set_always_show_selection (self, v)
Controls whether the text component keeps showing selection when not focused or not.  self : scaleform.TextComponent
The text component whose property is set.  v : boolean
A flag to turn selection on/off.  scaleform.TextComponent.set_antialiasing_mode (self, mode)
Sets the anti-alias mode of the text component.  self : scaleform.TextComponent
The text component whose property is set.  mode : scaleform.TextAAModes
The anti-aliasing mode.  scaleform.TextComponent.set_auto_size_x (self, autoSize)
Sets auto size of the text component by X axis.  self : scaleform.TextComponent
The text component whose size is set.  autoSize : boolean
A flag to set automatic resizing by X axis.  scaleform.TextComponent.set_auto_size_y (self, autoSize)
Sets autosize of the text component by Y axis.  self : scaleform.TextComponent
The text component whose size is set.  autoSize : boolean
A flag to set automatic resizing by Y axis.  scaleform.TextComponent.set_background_color (self, color)
Sets the background color of the text component.  self : scaleform.TextComponent
The text component whose background color is set.  color : scaleform.Color
The color to use.  scaleform.TextComponent.set_bidirectional_text (self, en)
Enables bidirectional text support on the component.  self : scaleform.TextComponent
The text component whose property is set.  en : boolean
A flag to determine whether to enable bidirectional text support.  scaleform.TextComponent.set_border_color (self)
Sets the border color around the text.  self : scaleform.TextComponent
The text component whose color is set.  scaleform.TextComponent.set_default_formats (self, txtFmt, pFmt)
Sets the default format within the text.  self : scaleform.TextComponent
The text component whose property is set.  txtFmt : scaleform.TextFormat
The text format to apply.  pFmt : scaleform.ParagraphFormat
The paragraph format to apply.  scaleform.TextComponent.set_dimensions (self, dim)
Sets the dimensions of the text component.  self : scaleform.TextComponent
The text component whose dimensions is set.  dim : scaleform.Size
The size of the text component.  scaleform.Size
Width should be in the form of a table {width=a, height=b}
{ height : number, width : number, }  scaleform.TextComponent.set_editable (self, v)
Sets the flag to turn on/off text editing.  self : scaleform.TextComponent
The text component whose property is set.  v : boolean
A flag to turn on/off the text editing.  scaleform.TextComponent.set_filters (self, filters)
Sets filters on the text.  self : scaleform.TextComponent
The text component whose filter is set.  filters : table?
A table containing the filters to set to the text.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  scaleform.TextComponent.set_html_text (self, text, length)
Sets the text value to parsed HTML text value.  self : scaleform.TextComponent
The text component whose property is set.  text : string
A value assigned as HTML encoded string value.  length : integer?
Length of the text.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  scaleform.TextComponent.set_image_substitution (self, imagesubstitute_desc, substring) : boolean
Sets an image as a substitute for a string in the text.  self : scaleform.TextComponent
The text component whose text is substituted with image.  imagesubstitute_desc : table?
A table with the image description.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  substring : string?
A sub-string in the text to be replaced by an image from the imagesubstitute_desc descriptor.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  boolean  scaleform.TextComponent.set_max_length (self, maxLen)
Sets the flag to turn on/off text overwriting mode.  self : scaleform.TextComponent
The text component whose property is set.  maxLen : integer
The maximum length of the string which will be displayed.  scaleform.TextComponent.set_multiline (self, value)
Sets multi-line or single-line on the text.  self : scaleform.TextComponent
The text component whose multi-line property is set.  value : boolean
The value to use to set the multi-line property.  scaleform.TextComponent.set_overwritable (self, overwrite)
Sets the flag to turn on/off text overwriting mode.  self : scaleform.TextComponent
The text component whose property is set.  overwrite : boolean
A flag to turn on/off the overwriting mode.  scaleform.TextComponent.set_paragraph_format (self, fmt, startPos, endPos)
Sets the paragraph format within the text.  self : scaleform.TextComponent
The text component whose property is set.  fmt : scaleform.ParagraphFormat
The 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.TextComponent.set_password_mode (self, pswd)
Sets the password mode for the text.  self : scaleform.TextComponent
The text component whose property is set.  pswd : boolean
A flag to set the text in password mode  scaleform.TextComponent.set_rect (self, rect)
Sets the position and dimensions of the text component.  self : scaleform.TextComponent
The text component whose dimensions is set.  rect : scaleform.Rect
The rectangle to use.  scaleform.TextComponent.set_scroll_line (self, v)
Sets the vertical scroll value.  self : scaleform.TextComponent
The text component whose scroll value is set.  v : integer
The value set as vertical scroll value.  scaleform.TextComponent.set_scroll_x (self, x)
Sets the horizonal scroll value.  self : scaleform.TextComponent
The text component whose scroll value is set.  x : number
The value set as horizontal scroll value.  scaleform.TextComponent.set_selectable (self, v)
Sets the flag to turn on/off text selectability.  self : scaleform.TextComponent
The text component whose property is set.  v : boolean
A flag to select/deselect text.  scaleform.TextComponent.set_text (self, text, length)
Sets a text value to the text component.  self : scaleform.TextComponent
The text component whose property is set.  text : string
A value assigned as text.  length : integer?
Length of the text.
The ? notation indicates that this type is optional: there may be zero or one instances of it.
  scaleform.TextComponent.set_text_format (self, fmt, startPos, endPos)
Sets the format of the text.  self : scaleform.TextComponent
The text component whose property is set.  fmt : scaleform.TextFormat
The 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.TextComponent.set_vertical_alignment (self, align)
Sets vertical alignment such as top, bottom or center.  self : scaleform.TextComponent
The text component whose property is set.  align : scaleform.VAlignModes
The alignment  scaleform.VAlignModes
The vertical alignment modes that can be set for a text component.  scaleform.TextComponent.set_word_wrap (self, wordwrap)
Sets the flag to turn on/off wordwrapping.  self : scaleform.TextComponent
The text component whose property is set.  wordwrap : boolean
The flag to turn on/off wordwrapping feature.  scaleform.TextComponent.text (self) : string
Returns the text value.  self : scaleform.TextComponent
The text component whose property is set.  string  scaleform.TextComponent.text_dimensions (self) : scaleform.Size
Returns dimensions of the text component.  self : scaleform.TextComponent
The text component currently in use.  scaleform.Size
The dimensions of the text component.  scaleform.TextComponent.text_format (self, startPos, endPos) : scaleform.TextFormat
Returns the format of the text.  self : scaleform.TextComponent
The 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.TextFormat
Currently set text value in HTML format.  scaleform.TextComponent.text_height (self) : number
Returns dimensions of the text inside the component.  self : scaleform.TextComponent
The text component currently in use.  number  scaleform.TextComponent.text_width (self) : number
Returns dimensions of the text inside the component.  self : scaleform.TextComponent
The text component currently in use.  number  scaleform.TextComponent.vertical_alignment (self) : scaleform.VAlignModes
Returns vertical text alignment(top, bottom, center).  self : scaleform.TextComponent
The text component whose property is set.  scaleform.VAlignModes
Vertical alignment of the text component.  scaleform.TextComponent.word_wrap (self) : boolean
Determines whether the wordwrapping feature is turned on/off for the text component.  self : scaleform.TextComponent
The text component whose property is set.  booleanIndicates 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.
Please send us your comment about this page