Interface HotkeyCaptureWrapper

A hotkey capture element that displays the currently bound key combo and lets the user rebind it by pressing a new combination.

Example

const capture = UI.AddHotkeyCapture("trigger", "Trigger key", "Ctrl+Shift+T");
capture.OnChange((combo) => { Console.Log("new combo: " + combo); });
interface HotkeyCaptureWrapper {
    Hide(): void;
    Show(): void;
    Destroy(): void;
    GetValue(): string;
    SetValue(val: string): void;
    OnChange(callback: (newValue: string) => void): void;
    OnPressed(callback: () => void): void;
}

Hierarchy (View Summary)

Methods

Hide Show Destroy GetValue SetValue OnChange OnPressed

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(): string

    Returns the current value of the element.

    Returns string

SetValue

  • SetValue(val: string): void

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

    Parameters

    • val: string

    Returns void

OnChange

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

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

    Parameters

    • callback: (newValue: string) => void

    Returns void

OnPressed

  • OnPressed(callback: () => void): void

    Fires when the captured combo is pressed (not just changed).

    Parameters

    • callback: () => void

    Returns void

Settings

Member Visibility

On This Page

Methods