Class UISetting_Header

UISetting subclass representing a simple text to describe the following section of settings.

Inheritance
object
UISetting
UISetting_Header
Namespace: AS2.UI
Assembly: .dll
Syntax
public class UISetting_Header : UISetting

Constructors

| Edit this page View Source

UISetting_Header(GameObject, Transform, string)

Sets up the logic for the setting.

Declaration
public UISetting_Header(GameObject go, Transform parentTransform, string name)
Parameters
Type Name Description
GameObject go

If null, a GameObject is instantiated, otherwise the given object is used.
Transform parentTransform

If go == null, this is the parent of the newly instantiated GameObject.
string name

The name of the setting.

Methods

| Edit this page View Source

ClearRefs()

Clears all subclass-specific callback events.

Declaration
protected override void ClearRefs()
Overrides
| Edit this page View Source

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
| Edit this page View Source

LockSetting()

Locks the setting to prevent changes.

Declaration
protected override void LockSetting()
Overrides
| Edit this page View Source

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
| Edit this page View Source

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
| Edit this page View Source

UnlockSetting()

Unlocks the setting to allow changes again after locking.

Declaration
protected override void UnlockSetting()
Overrides