pandemonium_engine_minimal/doc/classes/ButtonGroup.xml
2023-12-14 23:24:47 +01:00

40 lines
1.2 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="ButtonGroup" inherits="Resource" version="4.2">
<brief_description>
Group of Buttons.
</brief_description>
<description>
Group of [Button]. All direct and indirect children buttons become radios. Only one allows being pressed.
[member BaseButton.toggle_mode] should be [code]true[/code].
</description>
<tutorials>
</tutorials>
<methods>
<method name="get_buttons">
<return type="Array" />
<description>
Returns an [Array] of [Button]s who have this as their [ButtonGroup] (see [member BaseButton.group]).
</description>
</method>
<method name="get_pressed_button">
<return type="BaseButton" />
<description>
Returns the current pressed button.
</description>
</method>
</methods>
<members>
<member name="resource_local_to_scene" type="bool" setter="set_local_to_scene" getter="is_local_to_scene" overrides="Resource" default="true" />
</members>
<signals>
<signal name="pressed">
<argument index="0" name="button" type="Object" />
<description>
Emitted when one of the buttons of the group is pressed.
</description>
</signal>
</signals>
<constants>
</constants>
</class>