HL.BindOptions

class HL.BindOptions

Options table accepted by hl.bind().

Shape

{
    repeating = boolean?,
    locked = boolean?,
    release = boolean?,
    non_consuming = boolean?,
    auto_consuming = boolean?,
    transparent = boolean?,
    ignore_mods = boolean?,
    dont_inhibit = boolean?,
    long_press = boolean?,
    submap_universal = boolean?,
    click = boolean?,
    drag = boolean?,
    description = string?,
    desc = string?,
    device = {
        inclusive = boolean?,
        list = string[]?,
    }?,
}

Fields

repeatingboolean, optional

Enable repeat behavior.

lockedboolean, optional

Allow the bind while locked.

releaseboolean, optional

Trigger on key release.

non_consumingboolean, optional

Do not consume the input event.

auto_consumingboolean, optional

Auto-consuming bind behavior.

transparentboolean, optional

Make the bind transparent.

ignore_modsboolean, optional

Ignore active modifiers.

dont_inhibitboolean, optional

Do not respect input inhibition.

long_pressboolean, optional

Trigger as a long-press bind.

submap_universalboolean, optional

Apply across submaps.

clickboolean, optional

Treat the bind as a click bind. Also implies release.

dragboolean, optional

Treat the bind as a drag bind. Also implies release.

descriptionstring, optional

Description shown for the bind.

descstring, optional

Short alias for description. Used only if description is absent.

devicetable, optional

Device filter table.

Notes

click and drag are mutually exclusive. long_press and release are incompatible with repeating. Mouse binds are incompatible with repeating, release, and locked.

Used by

hl.bind()

Register a keybind.