InputField#

class InputField#

An input field. 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::string value()#
void set_value(std::string value)#

The value of the input field.

Text text()#

The text component of the input field.

Note

Use InputField::value() to get and set the value in the field. This object can be used to alter the style of the input field’s text.

Text placeholder()#

The placeholder text component of the input field.

Note

Set its Text::content() to the hint to show while the field is empty. The hint is hidden as soon as the field has a value.

InputContentType content_type()#
void set_content_type(InputContentType value)#

The content the field accepts from the user. Keystrokes that do not fit are ignored as they are typed, so a numeric field only ever shows a number.

Note

The filter applies to typing alone. A value set by a client is shown as it is given.

int32_t character_limit()#
void set_character_limit(int32_t value)#

The most characters the user can type into the field, or 0 for no limit.

bool read_only()#
void set_read_only(bool value)#

Whether the user is stopped from editing the field. The value can still be selected and copied, and a client can still set it.

Note

A read-only field is drawn as normal. Make the field not interactable instead to gray it out and stop the user selecting it.

bool changed()#
void set_changed(bool value)#

Whether the input field has been changed.

Note

This property is set to true when the user modifies the value of the input field, and not when a client sets it. 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.

enum struct InputContentType#

What an input field lets the user type into it.

enumerator standard#

Any text.

enumerator integer#

A whole number: digits, with a leading minus sign.

enumerator decimal#

A number: digits, with a decimal separator and a leading minus sign.

enumerator alphanumeric#

Letters and digits.

enumerator password#

Any text, drawn as asterisks so that it cannot be read off the screen.