Inheritance #

StyleBoxFlat #

is_refcounted, is_instantiable, resource, core, not_builtin_classes

A customizable StyleBox that doesn't use a texture.

By configuring various properties of this style box, you can achieve many common looks without the need of a texture. This includes optionally rounded borders, antialiasing, shadows, and skew.

Setting corner radius to high values is allowed. As soon as corners overlap, the stylebox will switch to a relative system:

[codeblock lang=text]

height = 30

corner_radius_top_left = 50

corner_radius_bottom_left = 100

The relative system now would take the 1:2 ratio of the two left corners to calculate the actual corner width. Both corners added will never be more than the height. Result:

[codeblock lang=text]

corner_radius_top_left: 10

corner_radius_bottom_left: 20

Members #

var anti_aliasing: bool = true#

Antialiasing draws a small ring around the edges, which fades to transparency. As a result, edges look much smoother. This is only noticeable when using rounded corners or skew.

Note: When using beveled corners with 45-degree angles (corner_detail = 1), it is recommended to set anti_aliasing to false to ensure crisp visuals and avoid possible visual glitches.

var anti_aliasing_size: float = 1.0#

This changes the size of the antialiasing effect. 1.0 is recommended for an optimal result at 100% scale, identical to how rounded rectangles are rendered in web browsers and most vector drawing software.

Note: Higher values may produce a blur effect but can also create undesired artifacts on small boxes with large-radius corners.

var bg_color: Color = Color(0.6, 0.6, 0.6, 1)#

The background color of the stylebox.

var border_blend: bool = false#

If true, the border will fade into the background color.

var border_color: Color = Color(0.8, 0.8, 0.8, 1)#

Sets the color of the border.

var border_width_bottom: int = 0#

Border width for the bottom border.

var border_width_left: int = 0#

Border width for the left border.

var border_width_right: int = 0#

Border width for the right border.

var border_width_top: int = 0#

Border width for the top border.

var corner_detail: int = 8#

This sets the number of vertices used for each corner. Higher values result in rounder corners but take more processing power to compute. When choosing a value, you should take the corner radius (set_corner_radius_all) into account.

For corner radii less than 10, 4 or 5 should be enough. For corner radii less than 30, values between 8 and 12 should be enough.

A corner detail of 1 will result in chamfered corners instead of rounded corners, which is useful for some artistic effects.

var corner_radius_bottom_left: int = 0#

The bottom-left corner's radius. If 0, the corner is not rounded.

var corner_radius_bottom_right: int = 0#

The bottom-right corner's radius. If 0, the corner is not rounded.

var corner_radius_top_left: int = 0#

The top-left corner's radius. If 0, the corner is not rounded.

var corner_radius_top_right: int = 0#

The top-right corner's radius. If 0, the corner is not rounded.

var draw_center: bool = true#

Toggles drawing of the inner part of the stylebox.

var expand_margin_bottom: float = 0.0#

Expands the stylebox outside of the control rect on the bottom edge. Useful in combination with border_width_bottom to draw a border outside the control rect.

Note: Unlike StyleBox.content_margin_bottom, expand_margin_bottom does not affect the size of the clickable area for Controls. This can negatively impact usability if used wrong, as the user may try to click an area of the StyleBox that cannot actually receive clicks.

var expand_margin_left: float = 0.0#

Expands the stylebox outside of the control rect on the left edge. Useful in combination with border_width_left to draw a border outside the control rect.

Note: Unlike StyleBox.content_margin_left, expand_margin_left does not affect the size of the clickable area for Controls. This can negatively impact usability if used wrong, as the user may try to click an area of the StyleBox that cannot actually receive clicks.

var expand_margin_right: float = 0.0#

Expands the stylebox outside of the control rect on the right edge. Useful in combination with border_width_right to draw a border outside the control rect.

Note: Unlike StyleBox.content_margin_right, expand_margin_right does not affect the size of the clickable area for Controls. This can negatively impact usability if used wrong, as the user may try to click an area of the StyleBox that cannot actually receive clicks.

var expand_margin_top: float = 0.0#

Expands the stylebox outside of the control rect on the top edge. Useful in combination with border_width_top to draw a border outside the control rect.

Note: Unlike StyleBox.content_margin_top, expand_margin_top does not affect the size of the clickable area for Controls. This can negatively impact usability if used wrong, as the user may try to click an area of the StyleBox that cannot actually receive clicks.

var shadow_color: Color = Color(0, 0, 0, 0.6)#

The color of the shadow. This has no effect if shadow_size is lower than 1.

var shadow_offset: Vector2 = Vector2(0, 0)#

The shadow offset in pixels. Adjusts the position of the shadow relatively to the stylebox.

var shadow_size: int = 0#

The shadow size in pixels.

var skew: Vector2 = Vector2(0, 0)#

If set to a non-zero value on either axis, skew distorts the StyleBox horizontally and/or vertically. This can be used for "futuristic"-style UIs. Positive values skew the StyleBox towards the right (X axis) and upwards (Y axis), while negative values skew the StyleBox towards the left (X axis) and downwards (Y axis).

Note: To ensure text does not touch the StyleBox's edges, consider increasing the StyleBox's content margin (see StyleBox.content_margin_bottom). It is preferable to increase the content margin instead of the expand margin (see expand_margin_bottom), as increasing the expand margin does not increase the size of the clickable area for Controls.

Methods #

Annotations #

Constants #

Constructors #

Enums #

Operators #

Signals #

Theme Items #

Tutorials #