Toggle

class UI.Toggle

A control that is either checked or not. Added to a UI.Canvas or a UI.Panel.

Note

On its own a toggle is a check box. Put several of them in the same UI.ToggleGroup and they become radio buttons, as only one toggle in a group can be checked at a time.

rect_transform: UI.RectTransform

The rect transform for the UI object.

Attribute:

Read-only, cannot be set

Return type:

UI.RectTransform

layout_element: UI.LayoutElement

How much space the UI object asks a layout for.

Attribute:

Read-only, cannot be set

Return type:

UI.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: boolean

Whether the UI object is visible.

Attribute:

Can be read or written

Return type:

boolean

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.

text: UI.Text

The text for the toggle.

Attribute:

Read-only, cannot be set

Return type:

UI.Text

checked: boolean

Whether the toggle is checked.

Attribute:

Can be read or written

Return type:

boolean

Note

Checking a toggle that belongs to a UI.ToggleGroup unchecks the rest of that group, whether or not it is on the screen.

group: UI.ToggleGroup

The group that the toggle belongs to, or nil if it does not belong to one.

Attribute:

Can be read or written

Return type:

UI.ToggleGroup or Types.none

Note

Only one toggle in a group can be checked at a time, so a group turns a set of toggles into radio buttons. A group does not have to contain the toggles, so they can be grouped independently of how they are laid out.

changed: boolean

Whether the toggle has been changed.

Attribute:

Can be read or written

Return type:

boolean

Note

This property is set to true when the user changes the toggle, and not when a client checks or unchecks it. A client script should reset the property to false in order to detect subsequent changes.

interactable: boolean

Whether the control responds to the user.

Attribute:

Can be read or written

Return type:

boolean

Note

A control that is not interactable is drawn grayed out and ignores the user, but is still visible. Set its visibility to false to hide it instead.

color: StdLib.ColorRGBA

The color the control is tinted with. White, the default, leaves the control drawn as the skin has it.

Attribute:

Can be read or written

Return type:

StdLib.ColorRGBA

Note

The tint multiplies the sprite the control is drawn with, in every state, so a control can show a state of its own, an engaged autopilot for instance, by color. It is applied to the part of the control that responds to the user: the body of a button, dropdown or input field, the box of a toggle, and the handle of a slider. A control’s label is tinted through the color of its text.

tooltip: string

A short piece of text shown beside the pointer while it rests on the control. Empty, the default, shows nothing.

Attribute:

Can be read or written

Return type:

string

remove()

Remove the UI object.