Index · Object → RefCounted → Resource → StyleBox → StyleBoxFlat

StyleBoxFlat

A customizable StyleBox that doesn't use a texture.

Class 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 = 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

Properties

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.

Inherited from StyleBox (4)
Inherited from Resource (4)

Methods

func get_border_width(margin: Side) -> int

Returns the specified Side's border width.

func get_border_width_min() -> int

Returns the smallest border width out of all four borders.

func get_corner_radius(corner: Corner) -> int

Returns the given corner's radius.

func get_expand_margin(margin: Side) -> float

Returns the size of the specified Side's expand margin.

func set_border_width(margin: Side, width: int) -> void

Sets the specified Side's border width to width pixels.

func set_border_width_all(width: int) -> void

Sets the border width to width pixels for all sides.

func set_corner_radius(corner: Corner, radius: int) -> void

Sets the corner radius to radius pixels for the given corner.

func set_corner_radius_all(radius: int) -> void

Sets the corner radius to radius pixels for all corners.

func set_expand_margin(margin: Side, size: float) -> void

Sets the expand margin to size pixels for the specified Side.

func set_expand_margin_all(size: float) -> void

Sets the expand margin to size pixels for all sides.

Inherited from StyleBox (13)
func _draw(to_canvas_item: RID, rect: Rect2) -> void
func _get_draw_rect(rect: Rect2) -> Rect2
func _test_mask(point: Vector2, rect: Rect2) -> bool
func draw(canvas_item: RID, rect: Rect2) -> void
func get_content_margin(margin: Side) -> float
func get_margin(margin: Side) -> float
func set_content_margin(margin: Side, offset: float) -> void
func set_content_margin_all(offset: float) -> void
func test_mask(point: Vector2, rect: Rect2) -> bool
Inherited from Resource (18)
func _get_rid() -> RID
func _reset_state() -> void
func _set_path_cache(path: String) -> void
func _setup_local_to_scene() -> void
func copy_from_resource(resource: Resource) -> Error
func duplicate(deep: bool = false) -> Resource
func duplicate_deep(deep_subresources_mode: Resource.DeepDuplicateMode = 1) -> Resource
func emit_changed() -> void
func get_rid() -> RID
func is_built_in() -> bool
func reset_state() -> void
func set_id_for_path(path: String, id: String) -> void
func set_path_cache(path: String) -> void
func setup_local_to_scene() -> void
func take_over_path(path: String) -> void
Inherited from RefCounted (4)
func init_ref() -> bool
func reference() -> bool
func unreference() -> bool
Inherited from Object (62)
func _get(property: StringName) -> Variant
func _get_property_list() -> Dictionary[]
func _init() -> void
func _iter_get(iter: Variant) -> Variant
func _iter_init(iter: Array) -> bool
func _iter_next(iter: Array) -> bool
func _notification(what: int) -> void
func _set(property: StringName, value: Variant) -> bool
func _to_string() -> String
func _validate_property(property: Dictionary) -> void
func add_user_signal(signal: String, arguments: Array = []) -> void
func call(method: StringName) -> Variant
func callv(method: StringName, arg_array: Array) -> Variant
func cancel_free() -> void
func connect(signal: StringName, callable: Callable, flags: int = 0) -> Error
func disconnect(signal: StringName, callable: Callable) -> void
func emit_signal(signal: StringName) -> Error
func free() -> void
func get(property: StringName) -> Variant
func get_class() -> String
func get_incoming_connections() -> Dictionary[]
func get_indexed(property_path: NodePath) -> Variant
func get_meta(name: StringName, default: Variant = null) -> Variant
func get_meta_list() -> StringName[]
func get_method_list() -> Dictionary[]
func get_property_list() -> Dictionary[]
func get_signal_connection_list(signal: StringName) -> Dictionary[]
func get_signal_list() -> Dictionary[]
func has_meta(name: StringName) -> bool
func has_method(method: StringName) -> bool
func has_signal(signal: StringName) -> bool
func is_class(class: StringName) -> bool
func is_connected(signal: StringName, callable: Callable) -> bool
func notification(what: int, reversed: bool = false) -> void
func remove_meta(name: StringName) -> void
func remove_user_signal(signal: StringName) -> void
func set(property: StringName, value: Variant) -> void
func set_block_signals(enable: bool) -> void
func set_deferred(property: StringName, value: Variant) -> void
func set_indexed(property_path: NodePath, value: Variant) -> void
func set_message_translation(enable: bool) -> void
func set_meta(name: StringName, value: Variant) -> void
func set_script(script: Variant) -> void
func set_translation_domain(domain: StringName) -> void
func to_string() -> String
func tr(message: StringName, context: StringName = &"") -> String
func tr_n(message: StringName, plural_message: StringName, n: int, context: StringName = &"") -> String

Signals

Inherited from Resource (2)
signal changed()
Inherited from Object (2)