add block data-fields to docs

2024-10-02 17:00:51 +03:00
parent 6016433f47
commit 221a34fa2e
4 changed files with 106 additions and 0 deletions
@@ -159,3 +159,27 @@ block.get_model(id: int) -> str
 -- возвращает массив из 6 текстур, назначенных на стороны блока
 block.get_textures(id: int) -> таблица строк
 ```
+
+## Поля данных
+
+```lua
+-- записывает значение в указанное поле блока
+-- * бросает исключение при несовместимости типов
+-- * ничего не делает при отсутствии поля у блока
+block.set_field(
+    x: int, y: int, z: int, 
+    name: str,
+    value: bool|int|number|string, 
+    [опционально] index: int = 0
+)
+
+-- возвращает значение записанное в поле блока
+-- * возвращает nil если:
+--     1. поле не существует
+--     2. ни в одно поле блока не было произведено записи
+block.get_field(
+    x: int, y: int, z: int, 
+    name: str, 
+    [опционально] index: int = 0
+) -> хранимое значение или nil
+```