InputField#

type krpc_UI_InputField_t#

krpc_error_t krpc_UI_InputField_RectTransform(krpc_connection_t connection, krpc_UI_RectTransform_t *returnValue, krpc_UI_InputField_t instance)#: The rect transform for the UI object.

krpc_error_t krpc_UI_InputField_LayoutElement(krpc_connection_t connection, krpc_UI_LayoutElement_t *returnValue, krpc_UI_InputField_t instance)#: 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.

krpc_error_t krpc_UI_InputField_Visible(krpc_connection_t connection, bool *returnValue, krpc_UI_InputField_t instance)#

krpc_error_t krpc_UI_InputField_set_Visible(krpc_connection_t connection, krpc_UI_InputField_t instance, 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.

krpc_error_t krpc_UI_InputField_Value(krpc_connection_t connection, char **returnValue, krpc_UI_InputField_t instance)#

krpc_error_t krpc_UI_InputField_set_Value(krpc_connection_t connection, krpc_UI_InputField_t instance, const char *value)#: The value of the input field.

krpc_error_t krpc_UI_InputField_Text(krpc_connection_t connection, krpc_UI_Text_t *returnValue, krpc_UI_InputField_t instance)#: The text component of the input field.

Note

Use krpc_UI_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.

krpc_error_t krpc_UI_InputField_Placeholder(krpc_connection_t connection, krpc_UI_Text_t *returnValue, krpc_UI_InputField_t instance)#: The placeholder text component of the input field.

Note

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

krpc_error_t krpc_UI_InputField_ContentType(krpc_connection_t connection, krpc_UI_InputContentType_t *returnValue, krpc_UI_InputField_t instance)#

krpc_error_t krpc_UI_InputField_set_ContentType(krpc_connection_t connection, krpc_UI_InputField_t instance, krpc_UI_InputContentType_t 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.

krpc_error_t krpc_UI_InputField_CharacterLimit(krpc_connection_t connection, int32_t *returnValue, krpc_UI_InputField_t instance)#

krpc_error_t krpc_UI_InputField_set_CharacterLimit(krpc_connection_t connection, krpc_UI_InputField_t instance, int32_t value)#: The most characters the user can type into the field, or 0 for no limit.

krpc_error_t krpc_UI_InputField_ReadOnly(krpc_connection_t connection, bool *returnValue, krpc_UI_InputField_t instance)#

krpc_error_t krpc_UI_InputField_set_ReadOnly(krpc_connection_t connection, krpc_UI_InputField_t instance, 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.

krpc_error_t krpc_UI_InputField_Changed(krpc_connection_t connection, bool *returnValue, krpc_UI_InputField_t instance)#

krpc_error_t krpc_UI_InputField_set_Changed(krpc_connection_t connection, krpc_UI_InputField_t instance, 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.

krpc_error_t krpc_UI_InputField_Interactable(krpc_connection_t connection, bool *returnValue, krpc_UI_InputField_t instance)#

krpc_error_t krpc_UI_InputField_set_Interactable(krpc_connection_t connection, krpc_UI_InputField_t instance, 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.

krpc_error_t krpc_UI_InputField_Color(krpc_connection_t connection, krpc_StdLib_ColorRGBA_t *returnValue, krpc_UI_InputField_t instance)#

krpc_error_t krpc_UI_InputField_set_Color(krpc_connection_t connection, krpc_UI_InputField_t instance, const krpc_StdLib_ColorRGBA_t *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.

krpc_error_t krpc_UI_InputField_Tooltip(krpc_connection_t connection, char **returnValue, krpc_UI_InputField_t instance)#

krpc_error_t krpc_UI_InputField_set_Tooltip(krpc_connection_t connection, krpc_UI_InputField_t instance, const char *value)#: A short piece of text shown beside the pointer while it rests on the control. Empty, the default, shows nothing.

krpc_error_t krpc_UI_InputField_Remove(krpc_connection_t connection, krpc_UI_InputField_t instance)#: Remove the UI object.

type krpc_UI_InputContentType_t#

What an input field lets the user type into it.

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

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

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