Class UISetting

Superclass of all implemented settings (like dropdowns, toggles, text boxes, etc.). Used together with the setting prefab GameObjects.

Inheritance
object
UISetting
UISetting_Color
UISetting_Dropdown
UISetting_Header
UISetting_MinMax
UISetting_Slider
UISetting_Spacing
UISetting_Text
UISetting_Toggle
UISetting_ValueSlider
Namespace: AS2.UI
Assembly: .dll
Syntax
public abstract class UISetting

Fields

| Edit this page View Source

backgroundButton_onButtonPressedEvent

Declaration
public Action<string> backgroundButton_onButtonPressedEvent
Field Value
Type Description
Action<string>
| Edit this page View Source

backgroundButton_onButtonPressedLongEvent

Declaration
public Action<string, float> backgroundButton_onButtonPressedLongEvent
Field Value
Type Description
Action<string, float>
| Edit this page View Source

button

Declaration
protected Button button
Field Value
Type Description
Button
| Edit this page View Source

buttonBackgroundImage

Declaration
protected Image buttonBackgroundImage
Field Value
Type Description
Image
| Edit this page View Source

buttonHoldEnabled

Declaration
protected bool buttonHoldEnabled
Field Value
Type Description
bool
| Edit this page View Source

buttonTrigger

Declaration
protected ButtonHoldTrigger buttonTrigger
Field Value
Type Description
ButtonHoldTrigger
| Edit this page View Source

go

Declaration
protected GameObject go
Field Value
Type Description
GameObject
| Edit this page View Source

locked

Declaration
protected bool locked
Field Value
Type Description
bool
| Edit this page View Source

name

Declaration
protected string name
Field Value
Type Description
string

Methods

| Edit this page View Source

Clear()

Clears the callback events of the setting.

Declaration
public void Clear()
| Edit this page View Source

ClearRefs()

Clears all subclass-specific callback events.

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

DisableButtonHold()

Disables the background button hold feature.

Declaration
public void DisableButtonHold()
| Edit this page View Source

EnableButtonHold()

Enables the background button hold feature.

Declaration
public void EnableButtonHold()
| Edit this page View Source

GetBackgroundButton()

Declaration
public Button GetBackgroundButton()
Returns
Type Description
Button
| Edit this page View Source

GetGameObject()

Declaration
public GameObject GetGameObject()
Returns
Type Description
GameObject
| Edit this page View Source

GetName()

Declaration
public string GetName()
Returns
Type Description
string
| Edit this page View Source

GetValueString()

Access to the current value.

Declaration
public abstract string GetValueString()
Returns
Type Description
string

The current value of the setting as a string.
| Edit this page View Source

InitBackgroundButton()

Declaration
protected void InitBackgroundButton()
| Edit this page View Source

InteractiveBarUpdate()

Call this each frame if you want support for the interactive bar.

Declaration
public void InteractiveBarUpdate()
| Edit this page View Source

Lock(bool)

Locks the setting so that its value cannot be changed anymore.

Declaration
public void Lock(bool lockButton = true)
Parameters
Type Name Description
bool lockButton

Indicates whether the background button should be locked as well.
| Edit this page View Source

LockSetting()

Locks the setting to prevent changes.

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

OnButtonPressed()

Declaration
private void OnButtonPressed()
| Edit this page View Source

OnButtonPressedLong(float)

Declaration
private void OnButtonPressedLong(float duration)
Parameters
Type Name Description
float duration
| Edit this page View Source

SetInteractable(bool, bool)

Sets the interactable state of the setting and its background button.

Declaration
public void SetInteractable(bool interactable, bool backgroundInteractable = true)
Parameters
Type Name Description
bool interactable

The new interactable state of the setting.
bool backgroundInteractable

The new interactable state of the button.
| Edit this page View Source

SetInteractableState(bool)

Sets the setting's interactable state.

Declaration
protected abstract void SetInteractableState(bool interactable)
Parameters
Type Name Description
bool interactable

The new interactable state.
| Edit this page View Source

SetValueString(string)

The inverse of GetValueString(). If calling both methods after each other, nothing should change.

Declaration
public abstract void SetValueString(string input)
Parameters
Type Name Description
string input

String representation of the setting's new value.
| Edit this page View Source

Unlock(bool)

Unlocks the setting so that its value can be changed again.

Declaration
public void Unlock(bool unlockButton = true)
Parameters
Type Name Description
bool unlockButton

Indicates whether the background button should be unlocked as well.
| Edit this page View Source

UnlockSetting()

Unlocks the setting to allow changes again after locking.

Declaration
protected abstract void UnlockSetting()