StyleBoxFlat

Inherits: StyleBox < Resource < Reference < Object

Customizable StyleBox with a given set of parameters (no texture required).

Description

This StyleBox can be used to achieve all kinds of looks without the need of a texture. Those properties are customizable:

  • Color
  • Border width (individual width for each border)
  • Rounded corners (individual radius for each corner)
  • Shadow (with blur and offset)

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

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:

corner_radius_top_left: 10
corner_radius_bottom_left: 20

Methods

intget_border_width ( Margin margin ) const
intget_border_width_min ( ) const
intget_corner_radius ( Corner corner ) const
floatget_expand_margin ( Margin margin ) const
voidset_border_width ( Margin margin, int width )
voidset_border_width_all ( int width )
voidset_corner_radius ( Corner corner, int radius )
voidset_corner_radius_all ( int radius )
voidset_corner_radius_individual ( int radius_top_left, int radius_top_right, int radius_bottom_right, int radius_bottom_left )
voidset_expand_margin ( Margin margin, float size )
voidset_expand_margin_all ( float size )
voidset_expand_margin_individual ( float size_left, float size_top, float size_right, float size_bottom )

Property Descriptions

Defaulttrue
Setterset_anti_aliased(value)
Getteris_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.


  • int anti_aliasing_size
Default1
Setterset_aa_size(value)
Getterget_aa_size()

This changes the size of the faded ring. Higher values can be used to achieve a “blurry” effect.


DefaultColor( 0.6, 0.6, 0.6, 1 )
Setterset_bg_color(value)
Getterget_bg_color()

The background color of the stylebox.


Defaultfalse
Setterset_border_blend(value)
Getterget_border_blend()

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


DefaultColor( 0.8, 0.8, 0.8, 1 )
Setterset_border_color(value)
Getterget_border_color()

Sets the color of the border.


  • int border_width_bottom
Default0
Setterset_border_width(value)
Getterget_border_width()

Border width for the bottom border.


  • int border_width_left
Default0
Setterset_border_width(value)
Getterget_border_width()

Border width for the left border.


  • int border_width_right
Default0
Setterset_border_width(value)
Getterget_border_width()

Border width for the right border.


  • int border_width_top
Default0
Setterset_border_width(value)
Getterget_border_width()

Border width for the top border.


  • int corner_detail
Default8
Setterset_corner_detail(value)
Getterget_corner_detail()

This sets the amount 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 smaller than 10, 4 or 5 should be enough. For corner radii smaller 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.


  • int corner_radius_bottom_left
Default0
Setterset_corner_radius(value)
Getterget_corner_radius()

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


  • int corner_radius_bottom_right
Default0
Setterset_corner_radius(value)
Getterget_corner_radius()

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


  • int corner_radius_top_left
Default0
Setterset_corner_radius(value)
Getterget_corner_radius()

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


  • int corner_radius_top_right
Default0
Setterset_corner_radius(value)
Getterget_corner_radius()

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


Defaulttrue
Setterset_draw_center(value)
Getteris_draw_center_enabled()

Toggles drawing of the inner part of the stylebox.


  • float expand_margin_bottom
Default0.0
Setterset_expand_margin(value)
Getterget_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.


Default0.0
Setterset_expand_margin(value)
Getterget_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.


  • float expand_margin_right
Default0.0
Setterset_expand_margin(value)
Getterget_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.


Default0.0
Setterset_expand_margin(value)
Getterget_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.


DefaultColor( 0, 0, 0, 0.6 )
Setterset_shadow_color(value)
Getterget_shadow_color()

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


DefaultVector2( 0, 0 )
Setterset_shadow_offset(value)
Getterget_shadow_offset()

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


  • int shadow_size
Default0
Setterset_shadow_size(value)
Getterget_shadow_size()

The shadow size in pixels.

Method Descriptions

Returns the given margin’s border width. See Margin for possible values.


  • int get_border_width_min ( ) const

Returns the smallest border width out of all four borders.


  • int get_corner_radius ( Corner corner ) const

Returns the given corner’s radius. See Corner for possible values.


Returns the size of the given margin’s expand margin. See Margin for possible values.


  • void set_border_width ( Margin margin, int width )

Sets the border width to width pixels for the given margin. See Margin for possible values.


  • void set_border_width_all ( int width )

Sets the border width to width pixels for all margins.


  • void set_corner_radius ( Corner corner, int radius )

Sets the corner radius to radius pixels for the given corner. See Corner for possible values.


  • void set_corner_radius_all ( int radius )

Sets the corner radius to radius pixels for all corners.


  • void set_corner_radius_individual ( int radius_top_left, int radius_top_right, int radius_bottom_right, int radius_bottom_left )

Sets the corner radius for each corner to radius_top_left, radius_top_right, radius_bottom_right, and radius_bottom_left pixels.


Sets the expand margin to size pixels for the given margin. See Margin for possible values.


  • void set_expand_margin_all ( float size )

Sets the expand margin to size pixels for all margins.


  • void set_expand_margin_individual ( float size_left, float size_top, float size_right, float size_bottom )

Sets the expand margin for each margin to size_left, size_top, size_right, and size_bottom pixels.

Doc ID missing

Disclaimer: This page has been automaticaly and directly extracted from the official Godot Docs website, the 1970-01-01 at 00:00:00. It’s the English Stable version because it’s what most Godot users should use. The Copyright owners are Juan Linietsky, Ariel Manzur and the Godot community. CC-BY 3.0. Thanks for your patience and generosity.