virtualx-engine-docs/_sources/classes/class_buttongroup.rst.txt
2024-10-23 09:41:33 -07:00

101 lines
3.4 KiB
ReStructuredText

:github_url: hide
.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/ButtonGroup.xml.
.. _class_ButtonGroup:
ButtonGroup
===========
**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
Group of Buttons.
.. rst-class:: classref-introduction-group
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``.
.. rst-class:: classref-reftable-group
Properties
----------
.. table::
:widths: auto
+-------------------------+-------------------------+---------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | resource_local_to_scene | ``true`` (overrides :ref:`Resource<class_Resource_property_resource_local_to_scene>`) |
+-------------------------+-------------------------+---------------------------------------------------------------------------------------+
.. rst-class:: classref-reftable-group
Methods
-------
.. table::
:widths: auto
+-------------------------------------+------------------------------------------------------------------------------------+
| :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>` **(** **)** |
+-------------------------------------+------------------------------------------------------------------------------------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Signals
-------
.. _class_ButtonGroup_signal_pressed:
.. rst-class:: classref-signal
**pressed** **(** :ref:`Object<class_Object>` button **)**
Emitted when one of the buttons of the group is pressed.
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Method Descriptions
-------------------
.. _class_ButtonGroup_method_get_buttons:
.. rst-class:: classref-method
: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>`).
.. rst-class:: classref-item-separator
----
.. _class_ButtonGroup_method_get_pressed_button:
.. rst-class:: classref-method
:ref:`BaseButton<class_BaseButton>` **get_pressed_button** **(** **)**
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.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`