druid.hotkey API

at /druid/extended/hotkey.lua

The component used for managing hotkeys and trigger callbacks when hotkeys are pressed

Functions

hotkey:init(keys, callback, [callback_argument])

The Hotkey constructor

Parameters:
- keys (string|string[]): The keys to be pressed for trigger callback. Should contains one key and any modificator keys
- callback (function): The callback function
- [callback_argument] (any): The argument to pass into the callback function

hotkey:on_style_change(style)

hotkey:add_hotkey(keys, [callback_argument])

Add hotkey for component callback

Parameters:
- keys (string|hash|hash[]|string[]): that have to be pressed before key pressed to activate
- [callback_argument] (any): The argument to pass into the callback function
Returns:
- self (druid.hotkey): Current instance

hotkey:is_processing()

hotkey:on_focus_gained()

hotkey:on_input([action_id], action)

Parameters:
- [action_id] (hash|nil): The action id
- action (action): The action
Returns:
- is_consume (boolean): True if the action is consumed

hotkey:set_repeat(is_enabled_repeated)

If true, the callback will be triggered on action.repeated

on_hotkey_pressed (event): fun(self, context, callback_argument) The event triggered when a hotkey is pressed

on_hotkey_released (event): fun(self, context, callback_argument) The event triggered when a hotkey is released