From dbe98959d1fa2923ca20957a1358d496752c8d02 Mon Sep 17 00:00:00 2001 From: MihailRis Date: Thu, 13 Jun 2024 18:41:38 +0300 Subject: [PATCH] update doc/ru structure & update docs (ru) --- doc/ru/0.Главная.md | 16 -------- ...едзагрузка-ассетов.md => assets-preload.md} | 0 doc/ru/{7.Аудио.md => audio.md} | 0 .../{9.Модели-блоков.md => block-models.md} | 0 ...Свойства-блоков.md => block-properties.md} | 5 +++ doc/ru/{Консоль.md => console.md} | 0 .../{2.Контент‐паки.md => content-packs.md} | 0 ...спользованию-движка.md => engine-use-recommendations.md} | 0 ...войства-предметов.md => item-properties.md} | 0 doc/ru/main-page.md | 12 ++++++ doc/ru/{8.Скриптинг.md => scripting.md} | 38 +++++++++++++++++++ .../events.md} | 0 .../filesystem.md} | 0 .../modules/core_Vector2&&Vector3.md} | 0 .../modules/core_bit_converter.md} | 0 .../modules/core_data_buffer.md} | 0 .../user-input.md} | 0 ...азметка-интерфейса.md => xml-ui-layouts.md} | 0 18 files changed, 55 insertions(+), 16 deletions(-) delete mode 100644 doc/ru/0.Главная.md rename doc/ru/{6.Предзагрузка-ассетов.md => assets-preload.md} (100%) rename doc/ru/{7.Аудио.md => audio.md} (100%) rename doc/ru/{9.Модели-блоков.md => block-models.md} (100%) rename doc/ru/{3.Свойства-блоков.md => block-properties.md} (97%) rename doc/ru/{Консоль.md => console.md} (100%) rename doc/ru/{2.Контент‐паки.md => content-packs.md} (100%) rename doc/ru/{1.Рекомендации-по-использованию-движка.md => engine-use-recommendations.md} (100%) rename doc/ru/{4.Свойства-предметов.md => item-properties.md} (100%) create mode 100644 doc/ru/main-page.md rename doc/ru/{8.Скриптинг.md => scripting.md} (92%) rename doc/ru/{События-движка.md => scripting/events.md} (100%) rename doc/ru/{Файловая-система-и-сериализация.md => scripting/filesystem.md} (100%) rename doc/ru/{8.3 Модуль-Vector2&&Vector3.md => scripting/modules/core_Vector2&&Vector3.md} (100%) rename doc/ru/{8.1.Модуль-Lua-core_bit_converter.md => scripting/modules/core_bit_converter.md} (100%) rename doc/ru/{8.2.Модуль-Lua-core_data_buffer.md => scripting/modules/core_data_buffer.md} (100%) rename doc/ru/{Пользовательский-ввод.md => scripting/user-input.md} (100%) rename doc/ru/{5.XML-разметка-интерфейса.md => xml-ui-layouts.md} (100%) diff --git a/doc/ru/0.Главная.md b/doc/ru/0.Главная.md deleted file mode 100644 index 3a638d98..00000000 --- a/doc/ru/0.Главная.md +++ /dev/null @@ -1,16 +0,0 @@ -# Разделы - -- [Рекомендации по использованию движка](1.Рекомендации-по-использованию-движка.md) -- [Контент‐паки](2.Контент‐паки.md) -- [Свойства блоков](3.Свойства-блоков.md) -- [Свойства предметов](4.Свойства-предметов.md) -- [XML разметка интерфейса](5.XML-разметка-интерфейса.md) -- [Предзагрузка ассетов](6.Предзагрузка-ассетов.md) -- [Аудио](7.Аудио.md) -- [Скриптинг](8.Скриптинг.md) - - [Модуль core:bit_converter](8.1.Модуль-Lua-core_bit_converter.md) - - [Модуль core:data_buffer](8.2.Модуль-Lua-core_data_buffer.md) - - [Пользовательский ввод](Пользовательский-ввод.md) - - [Файловая система и сериализация](Файловая-система-и-сериализация.md) -- [Консоль](Консоль.md) -- [Модели блоков](9.Модели-блоков.md) diff --git a/doc/ru/6.Предзагрузка-ассетов.md b/doc/ru/assets-preload.md similarity index 100% rename from doc/ru/6.Предзагрузка-ассетов.md rename to doc/ru/assets-preload.md diff --git a/doc/ru/7.Аудио.md b/doc/ru/audio.md similarity index 100% rename from doc/ru/7.Аудио.md rename to doc/ru/audio.md diff --git a/doc/ru/9.Модели-блоков.md b/doc/ru/block-models.md similarity index 100% rename from doc/ru/9.Модели-блоков.md rename to doc/ru/block-models.md diff --git a/doc/ru/3.Свойства-блоков.md b/doc/ru/block-properties.md similarity index 97% rename from doc/ru/3.Свойства-блоков.md rename to doc/ru/block-properties.md index c1cc2bda..982bacc4 100644 --- a/doc/ru/3.Свойства-блоков.md +++ b/doc/ru/block-properties.md @@ -129,3 +129,8 @@ Число слотов инвентаря блока. По-умолчанию - 0 (инвентарь отсутствует) +# Расширенные блоки + +## Размер блока - `size` + +Массив из трех целых чисел. Значение по-умолчанию - `[1, 1, 1]`. diff --git a/doc/ru/Консоль.md b/doc/ru/console.md similarity index 100% rename from doc/ru/Консоль.md rename to doc/ru/console.md diff --git a/doc/ru/2.Контент‐паки.md b/doc/ru/content-packs.md similarity index 100% rename from doc/ru/2.Контент‐паки.md rename to doc/ru/content-packs.md diff --git a/doc/ru/1.Рекомендации-по-использованию-движка.md b/doc/ru/engine-use-recommendations.md similarity index 100% rename from doc/ru/1.Рекомендации-по-использованию-движка.md rename to doc/ru/engine-use-recommendations.md diff --git a/doc/ru/4.Свойства-предметов.md b/doc/ru/item-properties.md similarity index 100% rename from doc/ru/4.Свойства-предметов.md rename to doc/ru/item-properties.md diff --git a/doc/ru/main-page.md b/doc/ru/main-page.md new file mode 100644 index 00000000..b51ee499 --- /dev/null +++ b/doc/ru/main-page.md @@ -0,0 +1,12 @@ +# Разделы + +- [Рекомендации по использованию движка](engine-use-recommendations.md) +- [Контент‐паки](content-packs.md) +- [Свойства блоков](block-properties.md) +- [Свойства предметов](item-properties.md) +- [XML разметка интерфейса](xml-ui-layouts.md) +- [Предзагрузка ассетов](assets-preload.md) +- [Аудио](audio.md) +- [Скриптинг](scripting.md) +- [Консоль](console.md) +- [Модели блоков](block-models.md) diff --git a/doc/ru/8.Скриптинг.md b/doc/ru/scripting.md similarity index 92% rename from doc/ru/8.Скриптинг.md rename to doc/ru/scripting.md index f5ba82c2..05f0f407 100644 --- a/doc/ru/8.Скриптинг.md +++ b/doc/ru/scripting.md @@ -2,6 +2,15 @@ В качестве языка сценариев используется LuaJIT +Подразделы: +- [События движка](scripting/events.md) +- [Пользовательский ввод](scripting/user-input.md) +- [Файловая система и сериализация](scripting/filesystem.md) +- [Модуль core:bit_converter](scripting/modules/core_bit_converter.md) +- [Модуль core:data_buffer](scripting/modules/core_data_buffer.md) +- [Модули core:Vector2, core:Vector3](scripting/modules/core_Vector2&&Vector3.md) + + ```lua require "контентпак:имя_модуля" -- загружает lua модуль из папки modules (расширение не указывается) ``` @@ -373,6 +382,35 @@ block.set_rotation(x: int, y: int, z: int, rotation: int) Устанавливает вращение блока по индексу в его профиле вращения. +### Расширенные блоки + +Расширенные блоки - те, размер которых превышает 1x1x1 + +```python +block.is_extended(id: int) -> bool +``` + +Проверяет, является ли блок расширенным. + +```python +block.get_size(id: int) -> int, int, int +``` + +Возвращает размер блока. + +```python +block.is_segment(x: int, y: int, z: int) -> bool +``` + +Проверяет является ли блок сегментом расширенного блока, не являющимся главным. + +```python +block.seek_origin(x: int, y: int, z: int) -> int, int, int +``` + +Возвращает позицию главного сегмента расширенного блока или исходную позицию, +если блок не являющийся расширенным. + ### Пользовательские биты Выделенная под использования в скриптах часть поля `voxel.states` хранящего доп-информацию о вокселе, такую как вращение блока. На данный момент выделенная часть составляет 8 бит. diff --git a/doc/ru/События-движка.md b/doc/ru/scripting/events.md similarity index 100% rename from doc/ru/События-движка.md rename to doc/ru/scripting/events.md diff --git a/doc/ru/Файловая-система-и-сериализация.md b/doc/ru/scripting/filesystem.md similarity index 100% rename from doc/ru/Файловая-система-и-сериализация.md rename to doc/ru/scripting/filesystem.md diff --git a/doc/ru/8.3 Модуль-Vector2&&Vector3.md b/doc/ru/scripting/modules/core_Vector2&&Vector3.md similarity index 100% rename from doc/ru/8.3 Модуль-Vector2&&Vector3.md rename to doc/ru/scripting/modules/core_Vector2&&Vector3.md diff --git a/doc/ru/8.1.Модуль-Lua-core_bit_converter.md b/doc/ru/scripting/modules/core_bit_converter.md similarity index 100% rename from doc/ru/8.1.Модуль-Lua-core_bit_converter.md rename to doc/ru/scripting/modules/core_bit_converter.md diff --git a/doc/ru/8.2.Модуль-Lua-core_data_buffer.md b/doc/ru/scripting/modules/core_data_buffer.md similarity index 100% rename from doc/ru/8.2.Модуль-Lua-core_data_buffer.md rename to doc/ru/scripting/modules/core_data_buffer.md diff --git a/doc/ru/Пользовательский-ввод.md b/doc/ru/scripting/user-input.md similarity index 100% rename from doc/ru/Пользовательский-ввод.md rename to doc/ru/scripting/user-input.md diff --git a/doc/ru/5.XML-разметка-интерфейса.md b/doc/ru/xml-ui-layouts.md similarity index 100% rename from doc/ru/5.XML-разметка-интерфейса.md rename to doc/ru/xml-ui-layouts.md