update doc/*/scripting/builtins/libgui.md

This commit is contained in:
MihailRis 2026-02-06 18:46:32 +03:00
parent 965faebc7b
commit 135c938dd2
2 changed files with 63 additions and 1 deletions

View file

@ -40,6 +40,37 @@ gui.get_env(document: string) -> table
gui.get_locales_info() -> table
```
## Фреймы
```lua
-- Замена для menu:reset() для закрытия меню паузы, деактивирующая основной фрейм UI.
gui.close_menu()
-- Создаёт фрейм.
gui.create_frame(
-- Глобальный id фрейма (не связан с UI свойством 'id').
id: str,
-- Текстура, в которую будет производиться рендер фрейма.
-- В случае пустой строки рендер производится на экран.
output_texture: str,
-- Размер фрейма. Например: {640, 480}
size: vec2
) -> Element, Document
-- Возвращает id активного фрейма (не id элемента).
gui.get_active_frame() -> str
-- Устанавливает активный фрейм, получающий пользовательский ввод.
-- Пустая строка указывает null-фрейм, при котором захватывается курсор.
gui.set_active_frame(
-- id фрейма, созданного через gui.create_frame
id: str,
-- Функция-поставщик позиции курсора во фрейме.
-- Используется для пользовательской проекции (например в 3D)
[опционально] cursorLocator
)
```
## Разметка
```lua
@ -109,4 +140,4 @@ gui.template(
```lua
-- Корневой UI документ.
gui.root: Document
```
```