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

object

UISetting

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

Type	Name	Description
GameObject	go
Transform	parentTransform
string	name
string	text
UISetting_Text.InputType	inputType

Fields

input

Declaration

private TMP_InputField input

Field Value

Type	Description
TMP_InputField

inputType

Declaration

private UISetting_Text.InputType inputType

Field Value

Type	Description
UISetting_Text.InputType

onValueChangedEvent

Declaration

public Action<string, string> onValueChangedEvent

Field Value

Type	Description
Action<string, string>

prevText

Declaration

private string prevText

Field Value

Type	Description
string

Methods

ClearRefs()

Clears all subclass-specific callback events.

Declaration

protected override void ClearRefs()

Overrides

UISetting.ClearRefs()

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

UISetting.GetValueString()

IsInputValid(string)

Declaration

protected bool IsInputValid(string input)

Parameters

Type	Name	Description
string	input

Returns

Type	Description
bool

LockSetting()

Locks the setting to prevent changes.

Declaration

protected override void LockSetting()

Overrides

UISetting.LockSetting()

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

UISetting.SetInteractableState(bool)

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

UISetting.SetValueString(string)

UnlockSetting()

Unlocks the setting to allow changes again after locking.

Declaration

protected override void UnlockSetting()

Overrides

UISetting.UnlockSetting()

UpdateValue(string)

Declaration

public void UpdateValue(string text)

Parameters

Type	Name	Description
string	text