Class UISetting_ValueSlider
UISetting subclass for settings that have a range of values
and should be selectable by a slider. The values can be float or integer
numbers or a list of strings for which the slider selects the index.
Inheritance
UISetting_ValueSlider
Namespace: AS2.UI
Assembly: .dll
Syntax
public class UISetting_ValueSlider : UISetting
Constructors
Declaration
public UISetting_ValueSlider(GameObject go, Transform parentTransform, string name, float minValue, float maxValue, float value, bool wholeNumbers)
Parameters
Type |
Name |
Description |
GameObject |
go |
|
Transform |
parentTransform |
|
string |
name |
|
float |
minValue |
|
float |
maxValue |
|
float |
value |
|
bool |
wholeNumbers |
|
Declaration
public UISetting_ValueSlider(GameObject go, Transform parentTransform, string name, string[] values, float initialIndex)
Parameters
Type |
Name |
Description |
GameObject |
go |
|
Transform |
parentTransform |
|
string |
name |
|
string[] |
values |
|
float |
initialIndex |
|
Fields
Declaration
private TMP_InputField input
Field Value
Type |
Description |
TMP_InputField |
|
mapping
Declaration
Field Value
mappingActive
Declaration
private bool mappingActive
Field Value
onValueChangedEvent
Declaration
public Action<string, float> onValueChangedEvent
Field Value
onValueChangedEventString
Declaration
public Action<string, string> onValueChangedEventString
Field Value
slider
Declaration
Field Value
Methods
ClearRefs()
Clears all subclass-specific callback events.
Declaration
protected override void ClearRefs()
Overrides
GetSlider()
Declaration
public Slider GetSlider()
Returns
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
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
Declaration
private void UpdateInputField()
UpdateValue(float)
Declaration
public void UpdateValue(float value)
Parameters
Type |
Name |
Description |
float |
value |
|
UpdateValue(string)
Declaration
public void UpdateValue(string text)
Parameters
Type |
Name |
Description |
string |
text |
|