LabelStyleSpecification - Prototype Docs

LabelStyleSpecification :: struct

Root style: "label"

Properties

type	:: `"label_style"`
font optional	:: string	Name of a FontPrototype. [...]
Name of a FontPrototype. [...]
font_color optional	:: Color	Required on the root style.
Required on the root style.
hovered_font_color optional	:: Color
game_controller_hovered_font_color optional	:: Color
clicked_font_color optional	:: Color
disabled_font_color optional	:: Color
parent_hovered_font_color optional	:: Color
rich_text_setting optional	:: RichTextSetting	Required on the root style.
Required on the root style.
single_line optional	:: boolean	Required on the root style.
Required on the root style.
underlined optional	:: boolean
rich_text_highlight_error_color optional	:: Color	Required on the root style.
Required on the root style.
rich_text_highlight_warning_color optional	:: Color	Required on the root style.
Required on the root style.
rich_text_highlight_ok_color optional	:: Color	Required on the root style.
Required on the root style.

Inherited from BaseStyleSpecification

parent optional	:: string	Name of a StyleSpecification. [...]
Name of a StyleSpecification. [...]
horizontal_align optional	:: HorizontalAlign
vertical_align optional	:: VerticalAlign
ignored_by_search optional	:: boolean
never_hide_by_search optional	:: boolean
horizontally_stretchable optional	:: StretchRule
vertically_stretchable optional	:: StretchRule
horizontally_squashable optional	:: StretchRule
vertically_squashable optional	:: StretchRule
natural_size optional	:: uint32 or {uint32, uint32}	If this is a tuple, the first member sets `natural_width` and the second sets `natural_height`. [...]
If this is a tuple, the first member sets `natural_width` and the second sets `natural_height`. [...]
size optional	:: uint32 or {uint32, uint32}	If this is a tuple, the first member sets `width`, and the second sets `height`. [...]
If this is a tuple, the first member sets `width`, and the second sets `height`. [...]
width optional	:: uint32	Sets `minimal_width`, `maximal_width` and `natural_width` to the same value.
Sets `minimal_width`, `maximal_width` and `natural_width` to the same value.
minimal_width optional	:: uint32	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 optional	:: uint32	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. [...]
natural_width optional	:: uint32	Natural width specifies the width of the element tries to have, but it can still be squashed/stretched to have a different size.
Natural width specifies the width of the element tries to have, but it can still be squashed/stretched to have a different size.
height optional	:: uint32	Sets `minimal_height`, `maximal_height` and `natural_height` to the same value.
Sets `minimal_height`, `maximal_height` and `natural_height` to the same value.
minimal_height optional	:: uint32	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 optional	:: uint32	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_height optional	:: uint32	Natural height specifies the height of the element tries to have, but it can still be squashed/stretched to have a different size.
Natural height specifies the height of the element tries to have, but it can still be squashed/stretched to have a different size.
padding optional	:: int16	Sets `top_padding`, `right_padding`, `bottom_padding` and `left_padding` to the same value.
Sets `top_padding`, `right_padding`, `bottom_padding` and `left_padding` to the same value.
top_padding optional	:: int16
right_padding optional	:: int16
bottom_padding optional	:: int16
left_padding optional	:: int16
margin optional	:: int16	Sets `top_margin`, `right_margin`, `bottom_margin` and `left_margin` to the same value.
Sets `top_margin`, `right_margin`, `bottom_margin` and `left_margin` to the same value.
top_margin optional	:: int16
right_margin optional	:: int16
bottom_margin optional	:: int16
left_margin optional	:: int16
effect optional	:: union	Name of a custom GUI effect, which are hard-coded in the game's engine. [...]
Name of a custom GUI effect, which are hard-coded in the game's engine. [...]
effect_opacity optional	:: float
tooltip optional	:: LocalisedString

type	:: `"label_style"`
clicked_font_color optional	:: Color
disabled_font_color optional	:: Color
font optional	:: string	Name of a FontPrototype. [...]
Name of a FontPrototype. [...]
font_color optional	:: Color	Required on the root style.
Required on the root style.
game_controller_hovered_font_color optional	:: Color
hovered_font_color optional	:: Color
parent_hovered_font_color optional	:: Color
rich_text_highlight_error_color optional	:: Color	Required on the root style.
Required on the root style.
rich_text_highlight_ok_color optional	:: Color	Required on the root style.
Required on the root style.
rich_text_highlight_warning_color optional	:: Color	Required on the root style.
Required on the root style.
rich_text_setting optional	:: RichTextSetting	Required on the root style.
Required on the root style.
single_line optional	:: boolean	Required on the root style.
Required on the root style.
underlined optional	:: boolean

Inherited from BaseStyleSpecification

bottom_margin optional	:: int16
bottom_padding optional	:: int16
effect optional	:: union	Name of a custom GUI effect, which are hard-coded in the game's engine. [...]
Name of a custom GUI effect, which are hard-coded in the game's engine. [...]
effect_opacity optional	:: float
height optional	:: uint32	Sets `minimal_height`, `maximal_height` and `natural_height` to the same value.
Sets `minimal_height`, `maximal_height` and `natural_height` to the same value.
horizontal_align optional	:: HorizontalAlign
horizontally_squashable optional	:: StretchRule
horizontally_stretchable optional	:: StretchRule
ignored_by_search optional	:: boolean
left_margin optional	:: int16
left_padding optional	:: int16
margin optional	:: int16	Sets `top_margin`, `right_margin`, `bottom_margin` and `left_margin` to the same value.
Sets `top_margin`, `right_margin`, `bottom_margin` and `left_margin` to the same value.
maximal_height optional	:: uint32	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. [...]
maximal_width optional	:: uint32	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 optional	:: uint32	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. [...]
minimal_width optional	:: uint32	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. [...]
natural_height optional	:: uint32	Natural height specifies the height of the element tries to have, but it can still be squashed/stretched to have a different size.
Natural height specifies the height of the element tries to have, but it can still be squashed/stretched to have a different size.
natural_size optional	:: uint32 or {uint32, uint32}	If this is a tuple, the first member sets `natural_width` and the second sets `natural_height`. [...]
If this is a tuple, the first member sets `natural_width` and the second sets `natural_height`. [...]
natural_width optional	:: uint32	Natural width specifies the width of the element tries to have, but it can still be squashed/stretched to have a different size.
Natural width specifies the width of the element tries to have, but it can still be squashed/stretched to have a different size.
never_hide_by_search optional	:: boolean
padding optional	:: int16	Sets `top_padding`, `right_padding`, `bottom_padding` and `left_padding` to the same value.
Sets `top_padding`, `right_padding`, `bottom_padding` and `left_padding` to the same value.
parent optional	:: string	Name of a StyleSpecification. [...]
Name of a StyleSpecification. [...]
right_margin optional	:: int16
right_padding optional	:: int16
size optional	:: uint32 or {uint32, uint32}	If this is a tuple, the first member sets `width`, and the second sets `height`. [...]
If this is a tuple, the first member sets `width`, and the second sets `height`. [...]
tooltip optional	:: LocalisedString
top_margin optional	:: int16
top_padding optional	:: int16
vertical_align optional	:: VerticalAlign
vertically_squashable optional	:: StretchRule
vertically_stretchable optional	:: StretchRule
width optional	:: uint32	Sets `minimal_width`, `maximal_width` and `natural_width` to the same value.
Sets `minimal_width`, `maximal_width` and `natural_width` to the same value.

Properties

type :: `"label_style"`

font :: string optional

Name of a FontPrototype.

Required on the root style.