LuaStyle - Runtime Docs

Class LuaStyle

Style of a GUI element. All of the attributes listed here may be nil if not available for a particular GUI element.

Members

help()	→ string	All methods and properties that this object supports.
All methods and properties that this object supports.
gui [R]	:: LuaGui	Gui of the LuaGuiElement of this style.
Gui of the LuaGuiElement of this style.
name [R]	:: string	Name of this style.
Name of this style.
minimal_width [RW]	:: int	Minimal width ensures, that the widget will never be smaller than than that size.
Minimal width ensures, that the widget will never be smaller than than that size.
maximal_width [RW]	:: int	Maximal width ensures, that the widget will never be bigger than than that size.
Maximal width ensures, that the widget will never be bigger than than that size.
minimal_height [RW]	:: int	Minimal height ensures, that the widget will never be smaller than than that size.
Minimal height ensures, that the widget will never be smaller than than that size.
maximal_height [RW]	:: int	Maximal height ensures, that the widget will never be bigger than than that size.
Maximal height ensures, that the widget will never be bigger than than that size.
natural_width [RW]	:: int	Natural width specifies the width of the element tries to have, but it can still be squashed/stretched to have a smaller or bigger size.
Natural width specifies the width of the element tries to have, but it can still be squashed/stretched to have a smaller or bigger size.
natural_height [RW]	:: int	Natural height specifies the height of the element tries to have, but it can still be squashed/stretched to have a smaller or bigger size.
Natural height specifies the height of the element tries to have, but it can still be squashed/stretched to have a smaller or bigger size.
top_padding [RW]	:: int
right_padding [RW]	:: int
bottom_padding [RW]	:: int
left_padding [RW]	:: int
top_margin [RW]	:: int
right_margin [RW]	:: int
bottom_margin [RW]	:: int
left_margin [RW]	:: int
horizontal_align [RW]	:: string?	Horizontal align of the inner content of the widget, if any.
Horizontal align of the inner content of the widget, if any.
vertical_align [RW]	:: string?	Vertical align of the inner content of the widget, if any.
Vertical align of the inner content of the widget, if any.
font_color [RW]	:: Color
font [RW]	:: string
top_cell_padding [RW]	:: int	Space between the table cell contents top and border.
Space between the table cell contents top and border.
right_cell_padding [RW]	:: int	Space between the table cell contents right and border.
Space between the table cell contents right and border.
bottom_cell_padding [RW]	:: int	Space between the table cell contents bottom and border.
Space between the table cell contents bottom and border.
left_cell_padding [RW]	:: int	Space between the table cell contents left and border.
Space between the table cell contents left and border.
horizontally_stretchable [RW]	:: boolean?	Whether the GUI element stretches its size horizontally to other elements.
Whether the GUI element stretches its size horizontally to other elements.
vertically_stretchable [RW]	:: boolean?	Whether the GUI element stretches its size vertically to other elements.
Whether the GUI element stretches its size vertically to other elements.
horizontally_squashable [RW]	:: boolean?	Whether the GUI element can be squashed (by maximal width of some parent element) horizontally.
Whether the GUI element can be squashed (by maximal width of some parent element) horizontally.
vertically_squashable [RW]	:: boolean?	Whether the GUI element can be squashed (by maximal height of some parent element) vertically.
Whether the GUI element can be squashed (by maximal height of some parent element) vertically.
rich_text_setting [RW]	:: defines.rich_text_setting	How this GUI element handles rich text.
How this GUI element handles rich text.
hovered_font_color [RW]	:: Color
clicked_font_color [RW]	:: Color
disabled_font_color [RW]	:: Color
pie_progress_color [RW]	:: Color
clicked_vertical_offset [RW]	:: int
selected_font_color [RW]	:: Color
selected_hovered_font_color [RW]	:: Color
selected_clicked_font_color [RW]	:: Color
strikethrough_color [RW]	:: Color
draw_grayscale_picture [RW]	:: boolean
horizontal_spacing [RW]	:: int	Horizontal space between individual cells.
Horizontal space between individual cells.
vertical_spacing [RW]	:: int	Vertical space between individual cells.
Vertical space between individual cells.
use_header_filler [RW]	:: boolean
bar_width [RW]	:: uint
color [RW]	:: Color
column_alignments [R]	:: LuaCustomTable[uint → Alignment]	Array containing the alignment for every column of this table element.
Array containing the alignment for every column of this table element.
single_line [RW]	:: boolean
extra_top_padding_when_activated [RW]	:: int
extra_bottom_padding_when_activated [RW]	:: int
extra_left_padding_when_activated [RW]	:: int
extra_right_padding_when_activated [RW]	:: int
extra_top_margin_when_activated [RW]	:: int
extra_bottom_margin_when_activated [RW]	:: int
extra_left_margin_when_activated [RW]	:: int
extra_right_margin_when_activated [RW]	:: int
stretch_image_to_widget_size [RW]	:: boolean
badge_font [RW]	:: string
badge_horizontal_spacing [RW]	:: int
default_badge_font_color [RW]	:: Color
selected_badge_font_color [RW]	:: Color
disabled_badge_font_color [RW]	:: Color
width [W]	:: int	Sets both minimal and maximal width to the given value.
Sets both minimal and maximal width to the given value.
height [W]	:: int	Sets both minimal and maximal height to the given value.
Sets both minimal and maximal height to the given value.
size [W]	:: int or array[int]	Sets both width and height to the given value.
Sets both width and height to the given value.
padding [W]	:: int or array[int]	Sets top/right/bottom/left paddings to this value.
Sets top/right/bottom/left paddings to this value.
margin [W]	:: int or array[int]	Sets top/right/bottom/left margins to this value.
Sets top/right/bottom/left margins to this value.
cell_padding [W]	:: int	Space between the table cell contents and border.
Space between the table cell contents and border.
extra_padding_when_activated [W]	:: int or array[int]	Sets `extra_top/right/bottom/left_padding_when_activated` to this value.
Sets `extra_top/right/bottom/left_padding_when_activated` to this value.
extra_margin_when_activated [W]	:: int or array[int]	Sets `extra_top/right/bottom/left_margin_when_activated` to this value.
Sets `extra_top/right/bottom/left_margin_when_activated` to this value.
valid [R]	:: boolean	Is this object valid?
Is this object valid?
object_name [R]	:: string	The class name of this object.
The class name of this object.

Methods

help() → string

All methods and properties that this object supports.

Attributes

gui :: LuaGuiRead

Gui of the LuaGuiElement of this style.

name :: stringRead

Name of this style.

minimal_width :: intRead/Write

Minimal width ensures, that the widget will never be smaller than than that size. It can't be squashed to be smaller.

maximal_width :: intRead/Write

Maximal width ensures, that the widget will never be bigger than than that size. It can't be stretched to be bigger.

minimal_height :: intRead/Write

Minimal height ensures, that the widget will never be smaller than than that size. It can't be squashed to be smaller.

maximal_height :: intRead/Write

Maximal height ensures, that the widget will never be bigger than than that size. It can't be stretched to be bigger.

natural_width :: intRead/Write

Natural width specifies the width of the element tries to have, but it can still be squashed/stretched to have a smaller or bigger size.

natural_height :: intRead/Write

Natural height specifies the height of the element tries to have, but it can still be squashed/stretched to have a smaller or bigger size.

top_padding :: intRead/Write

right_padding :: intRead/Write

bottom_padding :: intRead/Write

left_padding :: intRead/Write

top_margin :: intRead/Write

right_margin :: intRead/Write

bottom_margin :: intRead/Write

left_margin :: intRead/Write

horizontal_align :: string?Read/Write

Horizontal align of the inner content of the widget, if any. Possible values are "left", "center" or "right".

vertical_align :: string?Read/Write

Vertical align of the inner content of the widget, if any. Possible values are "top", "center" or "bottom".

font_color :: ColorRead/Write

font :: stringRead/Write

top_cell_padding :: intRead/Write

Space between the table cell contents top and border.

Can only be used if this is LuaTableStyle

right_cell_padding :: intRead/Write

Space between the table cell contents right and border.

Can only be used if this is LuaTableStyle

bottom_cell_padding :: intRead/Write

Space between the table cell contents bottom and border.

Can only be used if this is LuaTableStyle

left_cell_padding :: intRead/Write

Space between the table cell contents left and border.

Can only be used if this is LuaTableStyle

horizontally_stretchable :: boolean?Read/Write

Whether the GUI element stretches its size horizontally to other elements. nil if this element does not support stretching.

vertically_stretchable :: boolean?Read/Write

Whether the GUI element stretches its size vertically to other elements. nil if this element does not support stretching.

horizontally_squashable :: boolean?Read/Write

Whether the GUI element can be squashed (by maximal width of some parent element) horizontally. nil if this element does not support squashing. This is mainly meant to be used for scroll-pane The default value is false.

vertically_squashable :: boolean?Read/Write

Whether the GUI element can be squashed (by maximal height of some parent element) vertically. nil if this element does not support squashing. This is mainly meant to be used for scroll-pane The default (parent) value for scroll pane is true, false otherwise.