Table of Contents

Class ButtonGroup

A group of buttons that doesn't allow more than one button to be pressed at a time.

Inheritance
ButtonGroup

Remarks

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 toggle_mode set to true.

Properties

allow_unpress

If true, it is possible to unpress all buttons in this ButtonGroup.

var allow_unpress : bool = false

Property Value

bool

Remarks

  • void set_allow_unpress(bool value)
  • bool is_allow_unpress

Methods

get_buttons

Returns an Array of Buttons who have this as their ButtonGroup (see button_group).

BaseButton[] get_buttons

get_pressed_button

Returns the current pressed button.

BaseButton get_pressed_button

Events

pressed(BaseButton)

Emitted when one of the buttons of the group is pressed.

signal pressed(BaseButton button)

Parameters

button BaseButton