Files
godot-docs/classes/class_buttongroup.rst
2020-01-21 09:28:25 +01:00

54 lines
1.8 KiB
ReStructuredText

:github_url: hide
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the ButtonGroup.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_ButtonGroup:
ButtonGroup
===========
**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
**Category:** Core
Brief Description
-----------------
Group of Buttons.
Methods
-------
+-------------------------------------+------------------------------------------------------------------------------------+
| :ref:`Array<class_Array>` | :ref:`get_buttons<class_ButtonGroup_method_get_buttons>` **(** **)** |
+-------------------------------------+------------------------------------------------------------------------------------+
| :ref:`BaseButton<class_BaseButton>` | :ref:`get_pressed_button<class_ButtonGroup_method_get_pressed_button>` **(** **)** |
+-------------------------------------+------------------------------------------------------------------------------------+
Description
-----------
Group of :ref:`Button<class_Button>`. All direct and indirect children buttons become radios. Only one allows being pressed.
:ref:`BaseButton.toggle_mode<class_BaseButton_property_toggle_mode>` should be ``true``.
Method Descriptions
-------------------
.. _class_ButtonGroup_method_get_buttons:
- :ref:`Array<class_Array>` **get_buttons** **(** **)**
Returns an :ref:`Array<class_Array>` of :ref:`Button<class_Button>`\ s who have this as their ``ButtonGroup`` (see :ref:`BaseButton.group<class_BaseButton_property_group>`).
----
.. _class_ButtonGroup_method_get_pressed_button:
- :ref:`BaseButton<class_BaseButton>` **get_pressed_button** **(** **)**
Returns the current pressed button.