add doc/*/scripting/builtins/libgfx-blockwraps.md

This commit is contained in:
MihailRis
2024-11-28 18:28:42 +03:00
parent 14650562c2
commit a5609f3e0c
4 changed files with 47 additions and 0 deletions
@@ -0,0 +1,23 @@
# Библиотека *gfx.blockwraps*
Библиотека для работы с *обертками блоков*.
Обёртки блоков введены для реализации анимации разрушения блоков и могут
использоваться для иных задач.
```lua
-- Создаёт обертку на указанной позиции, с указанной текстурой.
-- Возвращает id обёртки.
gfx.blockwraps.wrap(position: vec3, texture: str) --> int
-- Удаляет обертку, если она существует.
gfx.blockwraps.unwrap(id: int)
-- Меняет позицию обёртки, если она существует.
gfx.blockwraps.set_pos(id: int, position: vec3)
-- Меняет текстуру обёртки, если она существует.
gfx.blockwraps.set_texture(id: int, texture: str)
```
Обертки не удаляются автоматически без вызова `unwrap`.