User:Unsane/MirLua/m hotkeys

Предоставляет функционал для работы с комбинациями клавиш.
Подключение модуля: local hotkeys = require('m_hotkeys')

Функции

MakeHotkey

Создает комбинацию клавиш

Параметры

modifier

Тип: number

Код клавиш-модификаторов (ctrl, alt и т.д.)

vKey

Тип: number

Код виртуальной клавиши

Результат

Тип: number

Возвращает комбинацию клавиш

Пример

local hk = hotkeys.MakeHotkey()

Register

Регистрирует комбинацию клавиш

Параметры

data

Тип: table

Таблица HotkeyItem

Результат

Тип: boolean

Возвращает true, если комбинация клавиш зарегистрирована, иначе false

Пример

local hIcon = hotkeys.Register({ Name = 'hkUniqueName' })

Unregister

Удаляет комбинацию клавиш

Параметры

name

Тип: string

Имя комбинации клавиш

Результат

Тип: boolean

Возвращает true, если комбинация клавиш удалена, иначе false

Пример

hotkeys.Unregister('hkUniqueName')

Структуры

HotkeyItem

Таблица, описывающая параметры комбинации клавиш

Поля

Name

Тип: string

Имя комбинации клавиш (автоматически переводится ядром)

Description

Тип: string

Описание комбинации клавиш (автоматически переводится ядром)

Section

Тип: string

Название секции для группировки в настройках. По умолчанию, в качестве секции используется название плагина (MirLua)

Hotkey

Тип: number

комбинация клавиш по умолчанию

Service

Тип: string

Имя сервиса

Flags

Тип: number

Дополнительные флаги