From 15bb6d998d026cb1e3f379ef60472ce992578fb1 Mon Sep 17 00:00:00 2001 From: MihailRis Date: Mon, 3 Jun 2024 19:04:34 +0300 Subject: [PATCH] =?UTF-8?q?added=20doc/ru/=D0=9F=D0=BE=D0=BB=D1=8C=D0=B7?= =?UTF-8?q?=D0=BE=D0=B2=D0=B0=D1=82=D0=B5=D0=BB=D1=8C=D1=81=D0=BA=D0=B8?= =?UTF-8?q?=D0=B9-=D0=B2=D0=B2=D0=BE=D0=B4.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- doc/ru/Пользовательский-ввод.md | 59 +++++++++++++++++++++++++++++++++ src/window/input.md | 9 ----- 2 files changed, 59 insertions(+), 9 deletions(-) create mode 100644 doc/ru/Пользовательский-ввод.md delete mode 100644 src/window/input.md diff --git a/doc/ru/Пользовательский-ввод.md b/doc/ru/Пользовательский-ввод.md new file mode 100644 index 00000000..b2397478 --- /dev/null +++ b/doc/ru/Пользовательский-ввод.md @@ -0,0 +1,59 @@ +# Пользовательский ввод + +Обработка нажатий клавиш и кнопок мыши обрабатываются через привязки (bindings), которые назначаются в паке, в файле `config/bindings.toml` в формате: + +```toml +packid.binding.name="inputtype:codename" +``` + +- packid - опционально, но желательно +- inputtype - key или mouse +- codename - имя клавиши или кнопки мыши (left/right/middle) + +## Имена клавиш + +- space, backspace, tab, enter, caps-lock, escape +- left-ctrl, left-shift, left-alt, left-super +- right-ctrl, right-shift, right-alt, right-alt +- delete, home, end, insert, page-up, page-down +- left, right, down, up +- a..z +- 0..9 +- f1..f25 + +## Библиотека input + +```python +input.keycode(keyname: str) -> int +``` + +Возвращает код клавиши по имени, либо -1 + +```python +input.mousecode(mousename: str) -> int +``` + +Возвращает код кнопки мыши по имени, либо -1 + +```python +input.add_callback(bindname: str, callback: function) +``` + +Назначает функцию, которая будет вызываться при активации привязки. Пример: +```lua +input.add_callback("hud.inventory", function () + print("Inventory open key pressed") +end) +``` + +```python +input.get_mouse_pos() -> {int, int} +``` + +Возвращает позицию курсора на экране. + +```python +input.get_bindings() -> массив строк +``` + +Возвращает названия всех доступных привязок. diff --git a/src/window/input.md b/src/window/input.md deleted file mode 100644 index aa1829bd..00000000 --- a/src/window/input.md +++ /dev/null @@ -1,9 +0,0 @@ -## Key Names -- space, backspace, tab, enter, caps-lock, escape -- left-ctrl, left-shift, left-alt, left-super -- right-ctrl, right-shift, right-alt, right-alt -- delete, home, end, insert, page-up, page-down -- left, right, down, up -- a..z -- 0..9 -- f1..f25