BaseStyleSpecification

The abstract base of all StyleSpecifications.

Type

struct

Properties

parent

• Type: string
• Optional: true

Name of a StyleSpecification. This style inherits all property values from its parent.

Styles without a parent property default to the root style for their type. The exception to this are the root styles themselves, as they cannot have a parent set. Due to this, for root styles, some style properties are mandatory and behavior may be unexpected, such as an element not showing up because its size defaults to 0.

horizontal_align

• Type: HorizontalAlign
• Optional: true

vertical_align

• Type: VerticalAlign
• Optional: true

ignored_by_search

• Type: boolean
• Optional: true

never_hide_by_search

• Type: boolean
• Optional: true

horizontally_stretchable

• Type: StretchRule
• Optional: true

vertically_stretchable

• Type: StretchRule
• Optional: true

horizontally_squashable

• Type: StretchRule
• Optional: true

vertically_squashable

• Type: StretchRule
• Optional: true

natural_size

• Type: uint32 | Tuple<uint32, uint32>
• Optional: true

If this is a tuple, the first member sets natural_width and the second sets natural_height. Otherwise, both natural_width and natural_height are set to the same value.

size

• Type: uint32 | Tuple<uint32, uint32>
• Optional: true

If this is a tuple, the first member sets width, and the second sets height. Otherwise, both width and height are set to the same value.

width

• Type: uint32
• Optional: true

Sets minimal_width, maximal_width and natural_width to the same value.

minimal_width

• Type: uint32
• Optional: true

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

maximal_width

• Type: uint32
• Optional: true

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

natural_width

• Type: uint32
• Optional: true

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

height

• Type: uint32
• Optional: true

Sets minimal_height, maximal_height and natural_height to the same value.

minimal_height

• Type: uint32
• Optional: true

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

maximal_height

• Type: uint32
• Optional: true

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

natural_height

• Type: uint32
• Optional: true

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

padding

• Type: int16
• Optional: true

Sets top_padding, right_padding, bottom_padding and left_padding to the same value.

top_padding

• Type: int16
• Optional: true

right_padding

• Type: int16
• Optional: true

bottom_padding

• Type: int16
• Optional: true

left_padding

• Type: int16
• Optional: true

margin

• Type: int16
• Optional: true

Sets top_margin, right_margin, bottom_margin and left_margin to the same value.

top_margin

• Type: int16
• Optional: true

right_margin

• Type: int16
• Optional: true

bottom_margin

• Type: int16
• Optional: true

left_margin

• Type: int16
• Optional: true

effect

• Type: "compilatron-hologram"
• Optional: true

Name of a custom GUI effect, which are hard-coded in the game's engine. Only has one option currently.

effect_opacity

• Type: float
• Optional: true

tooltip

• Type: LocalisedString
• Optional: true