Class UISetting_Text
UISetting subclass representing a setting
with a numeric or string value using a simple text input field.
Can be used to read in integer and float values as strings.
Inheritance
UISetting_Text
Namespace: AS2.UI
Assembly: .dll
Syntax
public class UISetting_Text : UISetting
Constructors
UISetting_Text(GameObject, Transform, string, string, InputType)
Declaration
public UISetting_Text(GameObject go, Transform parentTransform, string name, string text, UISetting_Text.InputType inputType)
Parameters
Fields
input
Declaration
private TMP_InputField input
Field Value
Type |
Description |
TMP_InputField |
|
inputType
Declaration
private UISetting_Text.InputType inputType
Field Value
onValueChangedEvent
Declaration
public Action<string, string> onValueChangedEvent
Field Value
prevText
Declaration
Field Value
Methods
ClearRefs()
Clears all subclass-specific callback events.
Declaration
protected override void ClearRefs()
Overrides
GetValueString()
Access to the current value.
Declaration
public override string GetValueString()
Returns
Type |
Description |
string |
The current value of the setting as a string.
|
Overrides
IsInputValid(string)
Declaration
protected bool IsInputValid(string input)
Parameters
Type |
Name |
Description |
string |
input |
|
Returns
LockSetting()
Locks the setting to prevent changes.
Declaration
protected override void LockSetting()
Overrides
OnValueChanged()
Declaration
private void OnValueChanged()
SetInteractableState(bool)
Sets the setting's interactable state.
Declaration
protected override void SetInteractableState(bool interactable)
Parameters
Type |
Name |
Description |
bool |
interactable |
The new interactable state.
|
Overrides
SetValueString(string)
The inverse of GetValueString().
If calling both methods after each other, nothing should change.
Declaration
public override void SetValueString(string input)
Parameters
Type |
Name |
Description |
string |
input |
String representation of the setting's new value.
|
Overrides
UnlockSetting()
Unlocks the setting to allow changes again after locking.
Declaration
protected override void UnlockSetting()
Overrides
UpdateValue(string)
Declaration
public void UpdateValue(string text)
Parameters
Type |
Name |
Description |
string |
text |
|