Table of Contents

Class ButtonGroup

Namespace
Godot
Assembly
GodotSharp.dll

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

public class ButtonGroup : Resource, IDisposable
Inheritance
ButtonGroup
Implements
Inherited Members

Constructors

ButtonGroup() 

public ButtonGroup()

Properties

AllowUnpress

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

public bool AllowUnpress { get; set; }

Property Value

bool

Methods

GetButtons()

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

public Array<BaseButton> GetButtons()

Returns

Array<BaseButton>

GetPressedButton()

Returns the current pressed button.

public BaseButton GetPressedButton()

Returns

BaseButton

HasGodotClassMethod(in godot_string_name)

Check if the type contains a method with the given name. This method is used by Godot to check if a method exists before invoking it. Do not call or override this method.

protected override bool HasGodotClassMethod(in godot_string_name method)

Parameters

method godot_string_name

Name of the method to check for.

Returns

bool

HasGodotClassSignal(in godot_string_name)

Check if the type contains a signal with the given name. This method is used by Godot to check if a signal exists before raising it. Do not call or override this method.

protected override bool HasGodotClassSignal(in godot_string_name signal)

Parameters

signal godot_string_name

Name of the signal to check for.

Returns

bool

InvokeGodotClassMethod(in godot_string_name, NativeVariantPtrArgs, out godot_variant)

Invokes the method with the given name, using the given arguments. This method is used by Godot to invoke methods from the engine side. Do not call or override this method.

protected override bool InvokeGodotClassMethod(in godot_string_name method, NativeVariantPtrArgs args, out godot_variant ret)

Parameters

method godot_string_name

Name of the method to invoke.

args NativeVariantPtrArgs

Arguments to use with the invoked method.

ret godot_variant

Value returned by the invoked method.

Returns

bool

Events

Pressed

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

public event ButtonGroup.PressedEventHandler Pressed

Event Type

ButtonGroup.PressedEventHandler
Edit this page