Dropdown

class Dropdown

A control for choosing one of a list of options, which are shown when it is clicked. Added to a Canvas or a Panel.

RectTransform rect_transform()

The rect transform for the UI object.

LayoutElement layout_element()

How much space the UI object asks a layout for.

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.

bool visible()

void set_visible(bool value)

Whether the UI object is visible.

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.

std::vector<std::string> options()

void set_options(std::vector<std::string> value)

The options that the dropdown offers.

Note

Setting the options resets the selection to the first of them, or to nothing when the list is empty.

int32_t selected_index()

void set_selected_index(int32_t value)

The position in Dropdown::options() of the option that is chosen.

Note

Zero while the dropdown has no options, as there is nothing to choose.

bool changed()

void set_changed(bool value)

Whether the chosen option has been changed.

Note

This property is set to true when the user chooses an option, and not when a client chooses one. A client script should reset the property to false in order to detect subsequent changes.

bool interactable()

void set_interactable(bool value)

Whether the control responds to the user.

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.

StdLib::ColorRGBA color()

void set_color(StdLib::ColorRGBA value)

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

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.

std::string tooltip()

void set_tooltip(std::string value)

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

void remove()

Remove the UI object.