update doc/ru/** scripting-related docs

2024-10-16 02:00:46 +03:00
parent 917f47542f
commit c2cfe64b7e
5 changed files with 163 additions and 211 deletions
@@ -0,0 +1,52 @@
+# Библиотека hud
+
+```lua
+-- Открывает инвентарь.
+hud.open_inventory()
+
+-- Закрывает инвентарь.
+hud.close_inventory()
+
+-- Открывает инвентарь и UI блока. 
+-- Если блок не имеет макета UI - бросается исключение.
+-- Возвращает id инвентаря блока 
+-- (при *"inventory-size"=0* создаётся виртуальный инвентарь, 
+--  который удаляется после закрытия), и id макета UI. 
+hud.open_block(x: int, y: int, z: int) -> int, str
+```
+
+> [!NOTE]
+> Одновременно может быть открыт только один блок
+
+```lua
+-- Показывает элемент в режиме оверлея. 
+-- Также показывает инвентарь игрока, если playerinv - **true**.
+hud.show_overlay(layoutid: str, playerinv: bool)
+
+-- Добавляет постоянный элемент на экран. Элемент не удаляется при 
+-- закрытии инвентаря. Чтобы не перекрывать затенение в режиме 
+-- инвентаря нужно установить z-index элемента меньшим чем -1. 
+-- В случае тега inventory, произойдет привязка слотов к инвентарю игрока.
+hud.open_permanent(layoutid: str)
+
+-- Удаляет элемент с экрана.
+hud.close(layoutid: str)
+
+-- Дает ID инвентаря открытого блока или 0.
+hud.get_block_inventory() -> int
+
+-- Дает ID игрока, к которому привязан пользовательский интерфейс.
+hud.get_player() -> int
+
+-- Открывает меню паузы.
+hud.pause()
+
+-- Закрывает меню паузы.
+hud.resume()
+
+-- Возвращает true если открыто меню паузы.
+hud.is_paused() -> bool
+
+-- Возвращает true если открыт инвентарь или оверлей.
+hud.is_inventory_open() -> bool
+```