BoxContainer

Inherits: Container < Control < CanvasItem < Node < Object

Inherited By: ColorPicker, HBoxContainer, VBoxContainer

Base class for box containers.

Description

Arranges child Control nodes vertically or horizontally, and rearranges them automatically when their minimum size changes.

Tutorials

Properties

AlignmentMode

alignment

0

bool

vertical

false

Methods

Control

add_spacer ( bool begin )

Theme Properties

int

separation

4

Enumerations

enum AlignmentMode:

  • ALIGNMENT_BEGIN = 0 --- The child controls will be arranged at the beginning of the container, i.e. top if orientation is vertical, left if orientation is horizontal (right for RTL layout).

  • ALIGNMENT_CENTER = 1 --- The child controls will be centered in the container.

  • ALIGNMENT_END = 2 --- The child controls will be arranged at the end of the container, i.e. bottom if orientation is vertical, right if orientation is horizontal (left for RTL layout).

Property Descriptions

Default

0

Setter

set_alignment(value)

Getter

get_alignment()

The alignment of the container's children (must be one of ALIGNMENT_BEGIN, ALIGNMENT_CENTER, or ALIGNMENT_END).


Default

false

Setter

set_vertical(value)

Getter

is_vertical()

If true, the BoxContainer will arrange its children vertically, rather than horizontally.

Can't be changed when using HBoxContainer and VBoxContainer.

Method Descriptions

Adds a Control node to the box as a spacer. If begin is true, it will insert the Control node in front of all other children.

Theme Property Descriptions

  • int separation

Default

4

The space between the BoxContainer's elements, in pixels.