mirror of
https://github.com/MihailRis/voxelcore.git
synced 2026-10-07 20:11:50 +00:00
Improved docs (#708)
* начало переписи доков * extensions update * libapp update * libfile update * io_stream update * Update io_stream.md * io_stream update x3 * io_stream update x4 * libtime update * libgui update + make bytearray.md * libinput update * Update libapp.md * Update libapp.md * libgui update * events.md ru fix * да ну не надо так делать --> не имеет смысла, ибо гитхаб -> показывает адекватно * types refactoring * fixes * Update libblock.md * Update libblock.md * Update libbyteutil.md
This commit is contained in:
parent
8b31bdeb78
commit
ac02bc0c8e
43 changed files with 1107 additions and 1314 deletions
|
|
@ -1,27 +1,52 @@
|
|||
# Библиотека *input*
|
||||
|
||||
|
||||
## Основные методы
|
||||
```lua
|
||||
input.keycode(keyname: str) --> int
|
||||
-- Возвращает код клавиши по имени, либо -1
|
||||
input.keycode(keyname: string) -> number
|
||||
|
||||
-- Возвращает код кнопки мыши по имени, либо -1
|
||||
input.mousecode(mousename: string) -> number
|
||||
|
||||
-- Проверяет активность ввода по коду, состоящему из:
|
||||
-- * типа ввода: key (клавиша) или mouse (кнопка мыши)
|
||||
-- * код ввода: [имя клавиши](#имена-клавиш) или имя кнопки мыши (left, middle, right)
|
||||
input.is_pressed(code: string) -> boolean
|
||||
|
||||
-- Возвращает названия всех доступных привязок.
|
||||
input.get_bindings() -> table<string>
|
||||
|
||||
-- Возвращает текстовое представление кнопки по имени привязки.
|
||||
input.get_binding_text(bindname: string) -> string
|
||||
|
||||
-- Проверяет активность привязки.
|
||||
input.is_active(bindname: string) -> string
|
||||
|
||||
-- Включает/выключает привязку до выхода из мира.
|
||||
input.set_enabled(bindname: string, flag: boolean)
|
||||
```
|
||||
|
||||
Возвращает код клавиши по имени, либо -1
|
||||
|
||||
## Курсор мыши
|
||||
```lua
|
||||
input.mousecode(mousename: str) --> int
|
||||
-- Возвращает позицию курсора на экране.
|
||||
input.get_mouse_pos() -> {number, number}
|
||||
|
||||
-- Возращает дельту позиции курсора.
|
||||
input.get_mouse_delta() -> {number, number}
|
||||
```
|
||||
|
||||
Возвращает код кнопки мыши по имени, либо -1
|
||||
|
||||
## Создание обработчиков
|
||||
```lua
|
||||
input.add_callback(
|
||||
-- Имя привязки
|
||||
bindname: str,
|
||||
bindname: string,
|
||||
-- Обработчик
|
||||
callback: function
|
||||
-- UI элемент-владелец обработчика (отвечает за срок жизни)
|
||||
[опционально] owner: Element,
|
||||
-- Игнорировать захват ввода UI элементами
|
||||
[опционально] istoplevel: bool
|
||||
[опционально] istoplevel: boolean
|
||||
)
|
||||
```
|
||||
|
||||
|
|
@ -49,55 +74,4 @@ input.add_callback("key:escape", function ()
|
|||
print("NO")
|
||||
return true -- предотвращает вызов назначенных ранее функций
|
||||
end, document.root)
|
||||
```
|
||||
|
||||
```lua
|
||||
input.get_mouse_pos() --> {int, int}
|
||||
```
|
||||
|
||||
Возвращает позицию курсора на экране.
|
||||
|
||||
```lua
|
||||
input.get_mouse_delta() --> {int, int}
|
||||
```
|
||||
|
||||
Возращает дельту позиции курсора.
|
||||
|
||||
```lua
|
||||
input.get_bindings() --> массив строк
|
||||
```
|
||||
|
||||
Возвращает названия всех доступных привязок.
|
||||
|
||||
```lua
|
||||
input.get_binding_text(bindname: str) --> str
|
||||
```
|
||||
|
||||
Возвращает текстовое представление кнопки по имени привязки.
|
||||
|
||||
```lua
|
||||
input.is_active(bindname: str) --> bool
|
||||
```
|
||||
|
||||
Проверяет активность привязки.
|
||||
|
||||
```lua
|
||||
input.set_enabled(bindname: str, flag: bool)
|
||||
```
|
||||
|
||||
Включает/выключает привязку до выхода из мира.
|
||||
|
||||
```lua
|
||||
input.is_pressed(code: str) --> bool
|
||||
```
|
||||
|
||||
Проверяет активность ввода по коду, состоящему из:
|
||||
- типа ввода: key (клавиша) или mouse (кнопка мыши)
|
||||
- код ввода: [имя клавиши](#имена-клавиш) или имя кнопки мыши (left, middle, right)
|
||||
|
||||
Пример:
|
||||
```lua
|
||||
if input.is_pressed("key:enter") then
|
||||
...
|
||||
end
|
||||
```
|
||||
```
|
||||
Loading…
Add table
Add a link
Reference in a new issue