:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ButtonGroup.xml. .. _class_ButtonGroup: ButtonGroup =========== **Inherits:** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` A group of buttons that doesn't allow more than one button to be pressed at a time. .. rst-class:: classref-introduction-group Description ----------- A group of :ref:`BaseButton`-derived buttons. The buttons in a **ButtonGroup** are treated like radio buttons: No more than one button can be pressed at a time. Some types of buttons (such as :ref:`CheckBox`) may have a special appearance in this state. Every member of a **ButtonGroup** should have :ref:`BaseButton.toggle_mode` set to ``true``. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-------------------------+----------------------------------------------------------------+---------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`allow_unpress` | ``false`` | +-------------------------+----------------------------------------------------------------+---------------------------------------------------------------------------------------+ | :ref:`bool` | resource_local_to_scene | ``true`` (overrides :ref:`Resource`) | +-------------------------+----------------------------------------------------------------+---------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +------------------------------------------------------------------+------------------------------------------------------------------------------+ | :ref:`Array`\[:ref:`BaseButton`\] | :ref:`get_buttons`\ (\ ) | +------------------------------------------------------------------+------------------------------------------------------------------------------+ | :ref:`BaseButton` | :ref:`get_pressed_button`\ (\ ) | +------------------------------------------------------------------+------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Signals ------- .. _class_ButtonGroup_signal_pressed: .. rst-class:: classref-signal **pressed**\ (\ button\: :ref:`BaseButton`\ ) :ref:`🔗` Emitted when one of the buttons of the group is pressed. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_ButtonGroup_property_allow_unpress: .. rst-class:: classref-property :ref:`bool` **allow_unpress** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_allow_unpress**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_allow_unpress**\ (\ ) If ``true``, it is possible to unpress all buttons in this **ButtonGroup**. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_ButtonGroup_method_get_buttons: .. rst-class:: classref-method :ref:`Array`\[:ref:`BaseButton`\] **get_buttons**\ (\ ) :ref:`🔗` Returns an :ref:`Array` of :ref:`Button`\ s who have this as their **ButtonGroup** (see :ref:`BaseButton.button_group`). .. rst-class:: classref-item-separator ---- .. _class_ButtonGroup_method_get_pressed_button: .. rst-class:: classref-method :ref:`BaseButton` **get_pressed_button**\ (\ ) :ref:`🔗` Returns the current pressed button. .. |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.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`