Toggle Group

class ToggleGroup

A set of toggles of which only one can be checked at a time, which is what turns a set of Toggle controls into radio buttons. Added to a Canvas or a Panel.

Note

A group does not contain its toggles, it only refers to them, so toggles can be grouped independently of how they are laid out. A column of radio buttons in a grid of them is one group, even though each row is laid out separately.

rect_transform

The rect transform for the UI object.

Attribute:

Read-only, cannot be set

Return type:

RectTransform

layout_element

How much space the UI object asks a layout for.

Attribute:

Read-only, cannot be set

Return type:

LayoutElement

Note

Only has an effect when the object is in a panel that has a layout. A canvas is not inside a layout and does not have one.

visible

Whether the UI object is visible.

Attribute:

Can be read or written

Return type:

bool

Note

This is the object’s own setting, which is what it was last set to. An object is only drawn when everything it is inside is visible as well, so an interface can be built with its parts visible, inside a panel that is not, and shown all at once by making that panel visible.

selected

The toggle in the group that is checked, or None if none of them are.

Attribute:

Read-only, cannot be set

Return type:

Toggle or None

allow_switch_off

Whether all of the toggles in the group are allowed to be unchecked at once.

Attribute:

Can be read or written

Return type:

bool

Note

When this is false, the user cannot clear the checked toggle, they can only check a different one. It does not stop a client setting Toggle.checked, which is obeyed either way. A group starts out with no toggle checked either way.

remove()

Remove the UI object.