StyleBoxFlat
Inherits: StyleBox < Resource < Shared < Object
A customizable StyleBox that doesn’t use a texture.
Description
Section titled “Description”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:
height = 30corner_radius_top_left = 50corner_radius_bottom_left = 100The 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:
corner_radius_top_left: 10corner_radius_bottom_left: 20Properties
Section titled “Properties”| Type | Name | Default |
|---|---|---|
| bool | anti_aliasing | true |
| float | anti_aliasing_size | 1.0 |
| Color | bg_color | Color(0.6, 0.6, 0.6, 1) |
| bool | border_blend | false |
| Color | border_color | Color(0.8, 0.8, 0.8, 1) |
| int | border_width_bottom | 0 |
| int | border_width_left | 0 |
| int | border_width_right | 0 |
| int | border_width_top | 0 |
| int | corner_detail | 8 |
| int | corner_radius_bottom_left | 0 |
| int | corner_radius_bottom_right | 0 |
| int | corner_radius_top_left | 0 |
| int | corner_radius_top_right | 0 |
| bool | draw_center | true |
| float | expand_margin_bottom | 0.0 |
| float | expand_margin_left | 0.0 |
| float | expand_margin_right | 0.0 |
| float | expand_margin_top | 0.0 |
| Color | shadow_color | Color(0, 0, 0, 0.6) |
| Vector2 | shadow_offset | Vector2(0, 0) |
| int | shadow_size | 0 |
| Vector2 | skew | Vector2(0, 0) |
Methods
Section titled “Methods”| Returns | Method |
|---|---|
| int | get_border_width(margin) |
| int | get_border_width_min() |
| int | get_corner_radius(corner) |
| float | get_expand_margin(margin) |
| void | set_border_width(margin, width) |
| void | set_border_width_all(width) |
| void | set_corner_radius(corner, radius) |
| void | set_corner_radius_all(radius) |
| void | set_expand_margin(margin, size) |
| void | set_expand_margin_all(size) |
Property descriptions
Section titled “Property descriptions”anti_aliasing
Section titled “anti_aliasing”bool anti_aliasing = true
Setter/getter: set_anti_aliased(), is_anti_aliased()
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.
anti_aliasing_size
Section titled “anti_aliasing_size”float anti_aliasing_size = 1.0
Setter/getter: set_aa_size(), get_aa_size()
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.
bg_color
Section titled “bg_color”Color bg_color = Color(0.6, 0.6, 0.6, 1)
Setter/getter: set_bg_color(), get_bg_color()
The background color of the stylebox.
border_blend
Section titled “border_blend”bool border_blend = false
Setter/getter: set_border_blend(), get_border_blend()
If true, the border will fade into the background color.
border_color
Section titled “border_color”Color border_color = Color(0.8, 0.8, 0.8, 1)
Setter/getter: set_border_color(), get_border_color()
Sets the color of the border.
border_width_bottom
Section titled “border_width_bottom”int border_width_bottom = 0
Setter/getter: set_border_width(), get_border_width()
Border width for the bottom border.
border_width_left
Section titled “border_width_left”int border_width_left = 0
Setter/getter: set_border_width(), get_border_width()
Border width for the left border.
border_width_right
Section titled “border_width_right”int border_width_right = 0
Setter/getter: set_border_width(), get_border_width()
Border width for the right border.
border_width_top
Section titled “border_width_top”int border_width_top = 0
Setter/getter: set_border_width(), get_border_width()
Border width for the top border.
corner_detail
Section titled “corner_detail”int corner_detail = 8
Setter/getter: set_corner_detail(), get_corner_detail()
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.
corner_radius_bottom_left
Section titled “corner_radius_bottom_left”int corner_radius_bottom_left = 0
Setter/getter: set_corner_radius(), get_corner_radius()
The bottom-left corner’s radius. If 0, the corner is not rounded.
corner_radius_bottom_right
Section titled “corner_radius_bottom_right”int corner_radius_bottom_right = 0
Setter/getter: set_corner_radius(), get_corner_radius()
The bottom-right corner’s radius. If 0, the corner is not rounded.
corner_radius_top_left
Section titled “corner_radius_top_left”int corner_radius_top_left = 0
Setter/getter: set_corner_radius(), get_corner_radius()
The top-left corner’s radius. If 0, the corner is not rounded.
corner_radius_top_right
Section titled “corner_radius_top_right”int corner_radius_top_right = 0
Setter/getter: set_corner_radius(), get_corner_radius()
The top-right corner’s radius. If 0, the corner is not rounded.
draw_center
Section titled “draw_center”bool draw_center = true
Setter/getter: set_draw_center(), is_draw_center_enabled()
Toggles drawing of the inner part of the stylebox.
expand_margin_bottom
Section titled “expand_margin_bottom”float expand_margin_bottom = 0.0
Setter/getter: set_expand_margin(), get_expand_margin()
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.
expand_margin_left
Section titled “expand_margin_left”float expand_margin_left = 0.0
Setter/getter: set_expand_margin(), get_expand_margin()
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.
expand_margin_right
Section titled “expand_margin_right”float expand_margin_right = 0.0
Setter/getter: set_expand_margin(), get_expand_margin()
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.
expand_margin_top
Section titled “expand_margin_top”float expand_margin_top = 0.0
Setter/getter: set_expand_margin(), get_expand_margin()
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.
shadow_color
Section titled “shadow_color”Color shadow_color = Color(0, 0, 0, 0.6)
Setter/getter: set_shadow_color(), get_shadow_color()
The color of the shadow. This has no effect if shadow_size is lower than 1.
shadow_offset
Section titled “shadow_offset”Vector2 shadow_offset = Vector2(0, 0)
Setter/getter: set_shadow_offset(), get_shadow_offset()
The shadow offset in pixels. Adjusts the position of the shadow relatively to the stylebox.
shadow_size
Section titled “shadow_size”int shadow_size = 0
Setter/getter: set_shadow_size(), get_shadow_size()
The shadow size in pixels.
Vector2 skew = Vector2(0, 0)
Setter/getter: set_skew(), get_skew()
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.
Method descriptions
Section titled “Method descriptions”get_border_width
Section titled “get_border_width”int get_border_width(margin: Side) const
Returns the specified Side’s border width.
get_border_width_min
Section titled “get_border_width_min”int get_border_width_min() const
Returns the smallest border width out of all four borders.
get_corner_radius
Section titled “get_corner_radius”int get_corner_radius(corner: Corner) const
Returns the given corner’s radius.
get_expand_margin
Section titled “get_expand_margin”float get_expand_margin(margin: Side) const
Returns the size of the specified Side’s expand margin.
set_border_width
Section titled “set_border_width”void set_border_width(margin: Side, width: int)
Sets the specified Side’s border width to width pixels.
set_border_width_all
Section titled “set_border_width_all”void set_border_width_all(width: int)
Sets the border width to width pixels for all sides.
set_corner_radius
Section titled “set_corner_radius”void set_corner_radius(corner: Corner, radius: int)
Sets the corner radius to radius pixels for the given corner.
set_corner_radius_all
Section titled “set_corner_radius_all”void set_corner_radius_all(radius: int)
Sets the corner radius to radius pixels for all corners.
set_expand_margin
Section titled “set_expand_margin”void set_expand_margin(margin: Side, size: float)
Sets the expand margin to size pixels for the specified Side.
set_expand_margin_all
Section titled “set_expand_margin_all”void set_expand_margin_all(size: float)
Sets the expand margin to size pixels for all sides.