2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
2023-03-01 00:44:37 +00:00
<class name= "ButtonGroup" inherits= "Resource" version= "4.1" xmlns:xsi= "http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation= "../class.xsd" >
2017-09-12 20:42:36 +00:00
<brief_description >
2023-04-30 14:26:09 +00:00
A group of buttons that doesn't allow more than one button to be pressed at a time.
2017-09-12 20:42:36 +00:00
</brief_description>
<description >
2023-04-30 14:26:09 +00:00
A group of [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 [CheckBox]) may have a special appearance in this state.
Every member of a [ButtonGroup] should have [member BaseButton.toggle_mode] set to [code]true[/code].
2017-09-12 20:42:36 +00:00
</description>
<tutorials >
</tutorials>
<methods >
2018-12-14 05:39:31 +00:00
<method name= "get_buttons" >
2022-08-05 01:41:48 +00:00
<return type= "BaseButton[]" />
2018-12-14 05:39:31 +00:00
<description >
2020-10-24 05:19:18 +00:00
Returns an [Array] of [Button]s who have this as their [ButtonGroup] (see [member BaseButton.button_group]).
2018-12-14 05:39:31 +00:00
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "get_pressed_button" >
2021-07-30 13:28:05 +00:00
<return type= "BaseButton" />
2017-09-12 20:42:36 +00:00
<description >
2018-12-14 05:39:31 +00:00
Returns the current pressed button.
2017-09-12 20:42:36 +00:00
</description>
</method>
</methods>
2019-09-03 10:44:58 +00:00
<members >
2023-04-20 02:37:52 +00:00
<member name= "allow_unpress" type= "bool" setter= "set_allow_unpress" getter= "is_allow_unpress" default= "false" >
If [code]true[/code], it is possible to unpress all buttons in this [ButtonGroup].
</member>
2021-12-02 19:38:49 +00:00
<member name= "resource_local_to_scene" type= "bool" setter= "set_local_to_scene" getter= "is_local_to_scene" overrides= "Resource" default= "true" />
2019-09-03 10:44:58 +00:00
</members>
2021-05-06 10:16:27 +00:00
<signals >
<signal name= "pressed" >
2022-08-06 18:11:48 +00:00
<param index= "0" name= "button" type= "BaseButton" />
2021-05-06 10:16:27 +00:00
<description >
Emitted when one of the buttons of the group is pressed.
</description>
</signal>
</signals>
2017-09-12 20:42:36 +00:00
</class>