Interface ValueWrapper<T>

A UI element that holds a typed value and notifies listeners on change. Returned by AddSlider, AddTextInput, AddToggle, AddDropdown, AddTextArea, AddColorPicker, AddFilePicker, AddDirectoryPicker, and AddListBox. Values are automatically persisted to storage on every change and restored on next run.

Example

const toggle = UI.AddToggle("enabled", "Enable feature");
toggle.OnChange((val) => { Console.Log("enabled: " + val); });
interface ValueWrapper<T> {
    Hide(): void;
    Show(): void;
    Destroy(): void;
    GetValue(): T;
    SetValue(val: T): void;
    OnChange(callback: (newValue: T) => void): void;
}

Type Parameters

  • T

Hierarchy (View Summary)

Methods

Hide Show Destroy GetValue SetValue OnChange

Methods

Hide

  • Hide(): void

    Hides the element without destroying it. Call Show() to make it visible again.

    Returns void

Show

  • Show(): void

    Makes a previously hidden element visible again.

    Returns void

Destroy

  • Destroy(): void

    Permanently removes the element from the UI panel.

    Returns void

GetValue

  • GetValue(): T

    Returns the current value of the element.

    Returns T

SetValue

  • SetValue(val: T): void

    Programmatically sets the element's value. Persists to storage and triggers OnChange listeners.

    Parameters

    • val: T

    Returns void

OnChange

  • OnChange(callback: (newValue: T) => void): void

    Registers a callback that fires whenever the user changes the value.

    Parameters

    • callback: (newValue: T) => void

    Returns void

Settings

Member Visibility

On This Page

Methods