update doc/ru structure & update docs (ru)

This commit is contained in:
MihailRis 2024-06-13 18:41:38 +03:00
parent 607d30fd33
commit dbe98959d1
18 changed files with 55 additions and 16 deletions

View File

@ -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)

View File

@ -129,3 +129,8 @@
Число слотов инвентаря блока. По-умолчанию - 0 (инвентарь отсутствует)
# Расширенные блоки
## Размер блока - `size`
Массив из трех целых чисел. Значение по-умолчанию - `[1, 1, 1]`.

12
doc/ru/main-page.md Normal file
View File

@ -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)

View File

@ -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 бит.