SUIInputField
Index
Functions Index
Function Name |
---|
void OnValueChanged (Closure callback) |
void OnEndEdit (Closure callback) |
void ActivateInputField () |
void DeactivateInputField () |
void Select () |
Properties Index
Property Name |
---|
string Text |
bool Enabled |
bool Interactable |
bool IsFocused |
float CaretBlinkRate |
int CaretWidth |
int CharacterLimit |
bool ReadOnly |
bool MultiLine |
char AsteriskChar |
int CaretPosition |
int SelectionAnchorPosition |
int SelectionFocusPosition |
float MinWidth |
float PreferredWidth |
float FlexibleWidth |
float MinHeight |
float PreferredHeight |
float FlexibleHeight |
SColor NormalColor |
SColor HighlightedColor |
SColor PressedColor |
SColor DisabledColor |
float ColorMultiplier |
SGameObject GameObject |
Functions
OnValueChanged
void OnValueChanged (Closure callback)
Given function will be called when text in Input Field has changed
Parameter | Type | Description |
---|---|---|
OnEndEdit
void OnEndEdit (Closure callback)
Given function will be called when editing has ended
Parameter | Type | Description |
---|---|---|
ActivateInputField
void ActivateInputField ()
Function Description
DeactivateInputField
void DeactivateInputField ()
Function Description
Select
void Select ()
Function Description
Properties
Text
string Text get
set
The current value of the input field.
Enabled
bool Enabled get
set
Whether this Input Field component is Enabled
Interactable
bool Interactable get
set
Is the Input Field interactable?
IsFocused
bool IsFocused get
Does the InputField currently have focus and is able to process events.
CaretBlinkRate
float CaretBlinkRate get
set
The blinking rate of the input caret, defined as the number of times the blink cycle occurs per second.
CaretWidth
int CaretWidth get
set
The width of the caret in pixels.
CharacterLimit
int CharacterLimit get
set
Property Description
ReadOnly
bool ReadOnly get
set
Property Description
MultiLine
bool MultiLine get
If the input field supports multiple lines.
AsteriskChar
char AsteriskChar get
set
The character used for password fields.
CaretPosition
int CaretPosition get
set
Current InputField caret position (also selection tail).
SelectionAnchorPosition
int SelectionAnchorPosition get
set
The beginning point of the selection.
SelectionFocusPosition
int SelectionFocusPosition get
set
The end point of the selection.
MinWidth
float MinWidth get
The minimum width this UIInputField may be allocated. (Used by the Layout system).
PreferredWidth
float PreferredWidth get
The preferred width this UIInputField should be allocated if there is sufficient space. (Used by the Layout system)
FlexibleWidth
float FlexibleWidth get
The extra relative width this UIInputField should be allocated if there is additional available space. (Used by the Layout system)
MinHeight
float MinHeight get
The minimum height this UIInputField may be allocated.(Used by the Layout system).
PreferredHeight
float PreferredHeight get
The preferred height this UIInputField should be allocated if there is sufficient space. (Used by the Layout system)
FlexibleHeight
float FlexibleHeight get
The extra relative height this UIInputField should be allocated if there is additional available space. (Used by the Layout system)
NormalColor
SColor NormalColor get
set
The normal color.
HighlightedColor
SColor HighlightedColor get
set
The color of the control when it is highlighted.
PressedColor
SColor PressedColor get
set
The color of the control when it is pressed.
DisabledColor
SColor DisabledColor get
set
The color of the control when it is disabled.
ColorMultiplier
float ColorMultiplier get
set
This multiplies the tint color for each transition by its value.
GameObject
SGameObject GameObject get
Property Description
Last updated