Class UISetting_Toggle
UISetting subclass for simple Boolean settings. The setting's value can be changed with a toggle button.
Namespace: AS2.UI
Assembly: .dll
Syntax
public class UISetting_Toggle : UISetting
Constructors
UISetting_Toggle(GameObject, Transform, string, bool)
Declaration
public UISetting_Toggle(GameObject go, Transform parentTransform, string name, bool isOn)
Parameters
Type | Name | Description |
---|---|---|
GameObject | go | |
Transform | parentTransform | |
string | name | |
bool | isOn |
Fields
onValueChangedEvent
Declaration
public Action<string, bool> onValueChangedEvent
Field Value
Type | Description |
---|---|
Action<string, bool> |
toggle
Declaration
private Toggle toggle
Field Value
Type | Description |
---|---|
Toggle |
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
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(bool)
Declaration
public void UpdateValue(bool isOn)
Parameters
Type | Name | Description |
---|---|---|
bool | isOn |