pandemonium_engine_docs/classes/class_boxcontainer.rst

:github_url: hide

.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/BoxContainer.xml.

.. _class_BoxContainer:

BoxContainer
============

**Inherits:** :ref:`Container<class_Container>` **<** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`

**Inherited By:** :ref:`ColorPicker<class_ColorPicker>`, :ref:`HBoxContainer<class_HBoxContainer>`, :ref:`VBoxContainer<class_VBoxContainer>`

Base class for box containers.

Description
-----------

Arranges child controls vertically or horizontally, and rearranges the controls automatically when their minimum size changes.

Tutorials
---------

- :doc:`GUI containers <../tutorials/ui/gui_containers>`

Properties
----------

+-----------------------------------------------+---------------------------------------------------------+-----------------------------------------------------------------------+
| :ref:`AlignMode<enum_BoxContainer_AlignMode>` | :ref:`alignment<class_BoxContainer_property_alignment>` | ``0``                                                                 |
+-----------------------------------------------+---------------------------------------------------------+-----------------------------------------------------------------------+
| :ref:`MouseFilter<enum_Control_MouseFilter>`  | mouse_filter                                            | ``1`` (overrides :ref:`Control<class_Control_property_mouse_filter>`) |
+-----------------------------------------------+---------------------------------------------------------+-----------------------------------------------------------------------+

Methods
-------

+------+---------------------------------------------------------------------------------------------------+
| void | :ref:`add_spacer<class_BoxContainer_method_add_spacer>` **(** :ref:`bool<class_bool>` begin **)** |
+------+---------------------------------------------------------------------------------------------------+

Enumerations
------------

.. _enum_BoxContainer_AlignMode:

.. _class_BoxContainer_constant_ALIGN_BEGIN:

.. _class_BoxContainer_constant_ALIGN_CENTER:

.. _class_BoxContainer_constant_ALIGN_END:

enum **AlignMode**:

- **ALIGN_BEGIN** = **0** --- Aligns children with the beginning of the container.

- **ALIGN_CENTER** = **1** --- Aligns children with the center of the container.

- **ALIGN_END** = **2** --- Aligns children with the end of the container.

Property Descriptions
---------------------

.. _class_BoxContainer_property_alignment:

- :ref:`AlignMode<enum_BoxContainer_AlignMode>` **alignment**

+-----------+----------------------+
| *Default* | ``0``                |
+-----------+----------------------+
| *Setter*  | set_alignment(value) |
+-----------+----------------------+
| *Getter*  | get_alignment()      |
+-----------+----------------------+

The alignment of the container's children (must be one of :ref:`ALIGN_BEGIN<class_BoxContainer_constant_ALIGN_BEGIN>`, :ref:`ALIGN_CENTER<class_BoxContainer_constant_ALIGN_CENTER>` or :ref:`ALIGN_END<class_BoxContainer_constant_ALIGN_END>`).

Method Descriptions
-------------------

.. _class_BoxContainer_method_add_spacer:

- void **add_spacer** **(** :ref:`bool<class_bool>` begin **)**

Adds a control to the box as a spacer. If ``true``, ``begin`` will insert the spacer control in front of other children.

.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`