HL.Keybind

class HL.Keybind

Runtime object.

Attributes

HL.Keybind.arg
Type:

string

Arg.

HL.Keybind.auto_consuming
Type:

boolean

Auto consuming.

HL.Keybind.catchall
Type:

boolean

Catchall.

HL.Keybind.click
Type:

boolean

Click.

HL.Keybind.description
Type:

any

Description.

HL.Keybind.device_inclusive
Type:

boolean

Device inclusive.

HL.Keybind.devices
Type:

nil

Devices.

HL.Keybind.display_key
Type:

string

Display key.

HL.Keybind.dont_inhibit
Type:

boolean

Dont inhibit.

HL.Keybind.drag
Type:

boolean

Drag.

HL.Keybind.enabled
Type:

boolean

Enabled.

HL.Keybind.handler
Type:

string

Handler.

HL.Keybind.has_description
Type:

boolean

Has description.

HL.Keybind.ignore_mods
Type:

boolean

Ignore mods.

HL.Keybind.key
Type:

string

Key.

HL.Keybind.keycode
Type:

integer

Keycode.

HL.Keybind.locked
Type:

boolean

Locked.

HL.Keybind.long_press
Type:

boolean

Long press.

HL.Keybind.modmask
Type:

integer

Modmask.

HL.Keybind.mouse
Type:

boolean

Mouse.

HL.Keybind.non_consuming
Type:

boolean

Non consuming.

HL.Keybind.release
Type:

boolean

Release.

HL.Keybind.repeating
Type:

boolean

Repeating.

HL.Keybind.submap
Type:

string

Submap.

HL.Keybind.submap_universal
Type:

boolean

Submap universal.

HL.Keybind.transparent
Type:

boolean

Transparent.

Methods

HL.Keybind.is_enabled()

Return whether the keybind is enabled.

HL.Keybind.set_enabled(enabled)

Enable or disable the keybind.

Parameters

enabledboolean

New enabled state.

HL.Keybind.remove()
HL.Keybind.unbind()

Remove the keybind.