mirror of
https://github.com/MihailRis/voxelcore.git
synced 2026-11-22 18:39:46 +00:00
fix docs typos and other trash
This commit is contained in:
parent
9744407599
commit
ef61e28f50
88 changed files with 359 additions and 358 deletions
|
|
@ -4,7 +4,7 @@
|
|||
|
||||
Вид 3D текста, как и [частицы](particles.md), настраивается через таблицу, все поля которой опциональны.
|
||||
|
||||
| Поле | Описание | По-умолчанию |
|
||||
| Поле | Описание | По умолчанию |
|
||||
| --------------- | ------------------------------------------------------- | ----------------- |
|
||||
| display | Формат отображения | static_billboard |
|
||||
| color | Цвет текста | {1, 1, 1, 1} |
|
||||
|
|
@ -31,7 +31,7 @@ gfx.text3d.show(
|
|||
position: vec3,
|
||||
-- отображаемый текст
|
||||
text: str,
|
||||
-- таблица настроек отображение текста
|
||||
-- таблица настроек отображения текста
|
||||
preset: table,
|
||||
-- дополнительная таблица настроек отображения текста
|
||||
[опционально] extension: table
|
||||
|
|
@ -86,7 +86,7 @@ gfx.text3d.set_entity(id: int, entity: int)
|
|||
```
|
||||
|
||||
Геттер и сеттер сущности, к позиции которой привязан 3D текст.
|
||||
Позиция, устанавливаемая через `gfx.text3d.set_pos`, в таком случае, относительна позиции сущности.
|
||||
Позиция, устанавливаемая через `gfx.text3d.set_pos`, в таком случае, относительно позиции сущности.
|
||||
|
||||
```lua
|
||||
gfx.text3d.update_settings(id: int, preset: table)
|
||||
|
|
|
|||
|
|
@ -1,10 +1,10 @@
|
|||
# Анимация
|
||||
|
||||
Для того, чтобы загрузить дорожку анимации для скелета сущности ([см. риггинг](rigging.md)) или камеры ([см. камеры](scripting/builtins/libcameras.md)) её, как любой, незагружаемый по-умолчанию, следует указать в [preload.json пака](assets-preload.md) в секции animation.
|
||||
Для того, чтобы загрузить дорожку анимации для скелета сущности ([см. риггинг](rigging.md)) или камеры ([см. камеры](scripting/builtins/libcameras.md)) её, как любой, незагружаемый по умолчанию, следует указать в [preload.json пака](assets-preload.md) в секции animation.
|
||||
|
||||
На данный момент, движком поддерживается один формат описания анимации - [VCA](vca.md).
|
||||
|
||||
Общий API для работы с анимацией, как и другими продолжительными событиями, существует библиотека animation, доступная в виде глобальной переменной.
|
||||
Для работы с анимацией, как и с другими продолжительными событиями, существует общий API - библиотека animation, доступная в виде глобальной переменной.
|
||||
|
||||
Самый простой способ анимировать что-то:
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# Предзагрузка ассетов (файл *preload.json*)
|
||||
|
||||
Для загрузки ассетов, не загружаемых автоматически, такие как звуки, дополнительные текстуры, используется файл `preload.json`, создающийся в папке контент-пака.
|
||||
Для загрузки ассетов, не загружаемых автоматически, таких как звуки, дополнительные текстуры, используется файл `preload.json`, создающийся в папке контент-пака.
|
||||
|
||||
Ассеты в файле разделяются на категории:
|
||||
- animation - анимация
|
||||
|
|
@ -26,7 +26,7 @@
|
|||
```
|
||||
Будет доступен под именем: "events/explosion"
|
||||
|
||||
В случае, если нужно будет работать с PCM данными звука (сейчас не доступно из скриптинга), требуется указать параметр `keep-pcm`:
|
||||
В случае, если нужно будет работать с PCM данными звука (сейчас недоступно из скриптинга), требуется указать параметр `keep-pcm`:
|
||||
```json
|
||||
{
|
||||
"sounds": [
|
||||
|
|
|
|||
|
|
@ -70,9 +70,9 @@ audio.play_stream(
|
|||
volume: number
|
||||
-- скорость воспроизведения (положительное число)
|
||||
pitch: number,
|
||||
-- [опционально] имя канала: regular/ambient/music/ui (по-умолчанию - regular)
|
||||
-- [опционально] имя канала: regular/ambient/music/ui (по умолчанию - regular)
|
||||
channel: string,
|
||||
-- [опционально] зацикливание потока (по-умолчанию - false)
|
||||
-- [опционально] зацикливание потока (по умолчанию - false)
|
||||
loop: bool
|
||||
) -> int
|
||||
```
|
||||
|
|
@ -87,9 +87,9 @@ audio.play_stream_2d(
|
|||
volume: number
|
||||
-- скорость воспроизведения (положительное число)
|
||||
pitch: number,
|
||||
-- [опционально] имя канала: regular/ambient/music/ui (по-умолчанию - regular)
|
||||
-- [опционально] имя канала: regular/ambient/music/ui (по умолчанию - regular)
|
||||
channel: string,
|
||||
-- [опционально] зацикливание потока (по-умолчанию - false)
|
||||
-- [опционально] зацикливание потока (по умолчанию - false)
|
||||
loop: bool
|
||||
) -> int
|
||||
```
|
||||
|
|
@ -109,9 +109,9 @@ audio.play_sound(
|
|||
volume: number
|
||||
-- скорость воспроизведения (положительное число)
|
||||
pitch: number,
|
||||
-- [опционально] имя канала: regular/ambient/music/ui (по-умолчанию - regular)
|
||||
-- [опционально] имя канала: regular/ambient/music/ui (по умолчанию - regular)
|
||||
channel: string,
|
||||
-- [опционально] зацикливание потока (по-умолчанию - false)
|
||||
-- [опционально] зацикливание потока (по умолчанию - false)
|
||||
loop: bool
|
||||
) -> int
|
||||
```
|
||||
|
|
@ -128,9 +128,9 @@ audio.play_sound_2d(
|
|||
volume: number
|
||||
-- скорость воспроизведения (положительное число)
|
||||
pitch: number,
|
||||
-- [опционально] имя канала: regular/ambient/music/ui (по-умолчанию - regular)
|
||||
-- [опционально] имя канала: regular/ambient/music/ui (по умолчанию - regular)
|
||||
channel: string,
|
||||
-- [опционально] зацикливание потока (по-умолчанию - false)
|
||||
-- [опционально] зацикливание потока (по умолчанию - false)
|
||||
loop: bool
|
||||
) -> int
|
||||
```
|
||||
|
|
@ -139,7 +139,7 @@ audio.play_sound_2d(
|
|||
|
||||
### Взаимодействие со спикером.
|
||||
|
||||
При обращении к несуществующим спикером ничего происходить не будет.
|
||||
При обращении к несуществующему спикеру ничего происходить не будет.
|
||||
|
||||
```lua
|
||||
-- остановить воспроизведение спикера
|
||||
|
|
@ -189,9 +189,9 @@ audio.get_velocity(speakerid: int) -> number, number, number
|
|||
-- (используется OpenAL для имитации эффекта Доплера)
|
||||
audio.set_velocity(speakerid: int, x: number, y: number, z: number)
|
||||
|
||||
-- получить длительность аудио в секуднах, проигрываемого источником
|
||||
-- возвращает 0, если не спикер не существует
|
||||
-- так же возвращает 0, если длительность неизвестна (пример: радио)
|
||||
-- получить длительность аудио в секундах, проигрываемого источником
|
||||
-- возвращает 0, если спикер не существует
|
||||
-- также возвращает 0, если длительность неизвестна (пример: радио)
|
||||
audio.get_duration(speakerid: int) -> number
|
||||
```
|
||||
|
||||
|
|
@ -241,14 +241,14 @@ stream:create_sound(
|
|||
|
||||
```lua
|
||||
-- запрашивает доступ к записи звука
|
||||
-- при подтверждении, в callback передаётся токен для использовании в audio.input.fetch
|
||||
-- при подтверждении, в callback передаётся токен для использования в audio.input.fetch
|
||||
audio.input.request_open(callback: function(string))
|
||||
|
||||
-- читает новые PCM данные аудио ввода
|
||||
audio.input.fetch(
|
||||
-- токен, полученный через audio.input.request_open
|
||||
access_token: string,
|
||||
-- максимальное размер буфера в байтах
|
||||
-- максимальный размер буфера в байтах
|
||||
[опционально] max_read_size: int
|
||||
)
|
||||
```
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# Модели блоков (устарело)
|
||||
|
||||
> ![WARNING]
|
||||
> [!WARNING]
|
||||
> Свойство `model-primitives` является устаревшим, используйте [формат VCM](vcm.md) для текстового описания модели из примитивов.
|
||||
|
||||
Создание собственной модели блока может быть реализовано при указании у блока свойств:
|
||||
|
|
@ -16,7 +16,7 @@
|
|||
|
||||
**AABB** примитив - массив состоящий из значений:
|
||||
```
|
||||
[x, y, z, width, height, depth, имёна текстур для каждой стороны]
|
||||
[x, y, z, width, height, depth, имена текстур для каждой стороны]
|
||||
```
|
||||
|
||||
**tetragon** примитив (по смыслу скорее parallelogram) - массив из трёх векторов, описывающих позицию примитива, вектор X\*ширина, Y\*высота.
|
||||
|
|
|
|||
|
|
@ -30,7 +30,7 @@
|
|||
### Модель - *model*
|
||||
|
||||
Модель блока из списка:
|
||||
- "block" - используется по-умолчанию для всех обычных блоков
|
||||
- "block" - используется по умолчанию для всех обычных блоков
|
||||
- "none" - невидимый блок (пример: воздух)
|
||||
- "X" - модель травы (крест из двух спрайтов)
|
||||
- "aabb" - модель, соответствующая хитбоксу блока (составной хитбокс будет объединен в один). Примеры: трубы, лампочки, панели.
|
||||
|
|
@ -66,7 +66,7 @@
|
|||
|
||||
Профиль вращения (набор положений, в которые можно установить блок) из списка:
|
||||
|
||||
- "none" - вращение блока отключено (по-умолчанию)
|
||||
- "none" - вращение блока отключено (по умолчанию)
|
||||
- "pipe" - профиль "труба". Примеры блоков: бревно, труба, лампочка
|
||||
- "pane" - профиль "панель". Примеры блоков: панель, дверь, табличка
|
||||
- "stairs" - профиль "ступеньки" ("pane" + перевернутые варианты)
|
||||
|
|
@ -104,8 +104,8 @@
|
|||
}
|
||||
```
|
||||
|
||||
- `offset` определяет битового смещения, с которого начинается индекс варианта. (По-умолчанию - 0)
|
||||
- `bits` определяет число бит, кодирующих индекс варианта. (По-умолчанию - 4).
|
||||
- `offset` определяет битовое смещение, с которого начинается индекс варианта. (По умолчанию - 0)
|
||||
- `bits` определяет число бит, кодирующих индекс варианта. (По умолчанию - 4).
|
||||
На данный момент максимальное число вариантов - 16, поэтому указание более 4 бит не имеет практического смысла.
|
||||
|
||||
Доступные для вариативности свойства:
|
||||
|
|
@ -153,7 +153,7 @@
|
|||
|
||||
- `[15, 15, 15]` - самый яркий белый свет
|
||||
- `[7, 0, 0]` - слабый красный свет
|
||||
- `[0, 0, 0]` - блок не излучает свет (по-умолчанию)
|
||||
- `[0, 0, 0]` - блок не излучает свет (по умолчанию)
|
||||
|
||||
|
||||
### Светопроводимость - *light-passing*
|
||||
|
|
@ -170,7 +170,7 @@
|
|||
|
||||
### Вершинный Ambient-Occlusion - *ambient-occlusion*
|
||||
|
||||
Определяет наличие эффекта вершинного AO. Включен по-умолчанию.
|
||||
Определяет наличие эффекта вершинного AO. Включен по умолчанию.
|
||||
|
||||
### Отсечение - *culling*
|
||||
|
||||
|
|
@ -231,7 +231,7 @@
|
|||
|
||||
### Скрытый блок - *hidden*
|
||||
|
||||
При значении в `true` блок не появляется в инвентаре и для него не генерируется предмет, поэтому c 0.17 требуется указать свойство *picking-item*
|
||||
При значении в `true` блок не появляется в инвентаре и для него не генерируется предмет, поэтому с 0.17 требуется указать свойство *picking-item*
|
||||
|
||||
### Подбираемый предмет - *picking-item*
|
||||
|
||||
|
|
@ -241,29 +241,29 @@
|
|||
|
||||
### Имя макета UI - *ui-layout*
|
||||
|
||||
Позволяет указать id XML-макета интерфейса блока. По-умолчанию используется строковый id блока.
|
||||
Позволяет указать id XML-макета интерфейса блока. По умолчанию используется строковый id блока.
|
||||
|
||||
### Размер инвентаря - *inventory-size*
|
||||
|
||||
Число слотов инвентаря блока. По-умолчанию - 0 (инвентарь отсутствует)
|
||||
Число слотов инвентаря блока. По умолчанию - 0 (инвентарь отсутствует)
|
||||
|
||||
## Расширенные блоки
|
||||
|
||||
### Размер блока - *size*
|
||||
|
||||
Массив из трех целых чисел. Значение по-умолчанию - `[1, 1, 1]`.
|
||||
Массив из трех целых чисел. Значение по умолчанию - `[1, 1, 1]`.
|
||||
|
||||
### Поведение приземленности - *grounding-behaviour*
|
||||
|
||||
Определяет поведение расширенного приземленного блока. Доступные варианты поведения:
|
||||
|
||||
- "partial" - как минимум один сегмент блока должен быть приземленным (по-умолчанию)
|
||||
- "partial" - как минимум один сегмент блока должен быть приземленным (по умолчанию)
|
||||
- "complete" - все сегменты блока должны быть приземленными
|
||||
- "origin" - главный сегмент должен быть приземленным
|
||||
|
||||
## Поля блока
|
||||
|
||||
Поля блоков позволяет записывать больше уникальных для конкретного блока данных, чем это позволяют пользовательские биты.
|
||||
Поля блоков позволяют записывать больше уникальных для конкретного блока данных, чем это позволяют пользовательские биты.
|
||||
|
||||
Поля блока объявляются в следующем формате:
|
||||
|
||||
|
|
@ -306,7 +306,7 @@
|
|||
|
||||
Доступ к пользовательским свойствам производится через таблицу `block.properties[id]["свойство"]` где id - числовой id (индекс) блока.
|
||||
|
||||
Пользовательские свойства должны быть объявляены в файле `пак:config/user-props.toml`:
|
||||
Пользовательские свойства должны быть объявлены в файле `пак:config/user-props.toml`:
|
||||
```toml
|
||||
"пак:имя_свойства" = {}
|
||||
```
|
||||
|
|
@ -332,9 +332,9 @@
|
|||
}
|
||||
```
|
||||
|
||||
- count равен 1 по-умолчанию. Не нужно указывать если указаны `min` и `max`.
|
||||
- count равен 1 по умолчанию. Не нужно указывать если указаны `min` и `max`.
|
||||
- min, max - минимальное и максимальное количество предмета.
|
||||
- chance - вероятность выпадения предмета. По-умолчанию: 1.0.
|
||||
- chance - вероятность выпадения предмета. По умолчанию: 1.0.
|
||||
|
||||
Следует учитывать, что в item указывается именно предмет. Т.е. чтобы указать предмет блока, нужно добавить `.item` после имени блока.
|
||||
Пример: `base:dirt.item`.
|
||||
|
|
@ -350,11 +350,11 @@
|
|||
|
||||
### Интервал тактов - *tick-interval*
|
||||
|
||||
Интервал в тактах мира (1/20 секуды). Значение 20 приводит к интервалу вызова on_block_tick равному одной секунде.
|
||||
Интервал в тактах мира (1/20 секунды). Значение 20 приводит к интервалу вызова on_block_tick равному одной секунде.
|
||||
|
||||
## Методы
|
||||
|
||||
Методы используются для управлением перезаписью свойств при расширении блока другими паками.
|
||||
Методы используются для управления перезаписью свойств при расширении блока другими паками.
|
||||
|
||||
### `имя_свойства@append`
|
||||
|
||||
|
|
|
|||
|
|
@ -5,9 +5,9 @@
|
|||
При отправке команды через стандартную консоль (макет core:console):
|
||||
1. проверяется правило `allow-cheats`
|
||||
2. автоматически устанавливаются переменные `player`, `pos.x|y|z`, `entity.id`, `entity.selected`.
|
||||
3. вызывается обработчик команд - console.submit или по-умолчанию.
|
||||
3. вызывается обработчик команд - console.submit или по умолчанию.
|
||||
|
||||
Обработчик по-умолчанию вызывает console.execute, передавая результат в вызов console.log.
|
||||
Обработчик по умолчанию вызывает console.execute, передавая результат в вызов console.log.
|
||||
|
||||
## Создание команд
|
||||
|
||||
|
|
@ -24,7 +24,7 @@ console.add_command(схема: str, исполнитель: function, чит_к
|
|||
```
|
||||
|
||||
Название может содержать:
|
||||
- латинницу
|
||||
- латиницу
|
||||
- цифры (кроме первого символа)
|
||||
- `.`, `_`, `-`
|
||||
|
||||
|
|
@ -56,13 +56,13 @@ console.add_command(схема: str, исполнитель: function, чит_к
|
|||
x:num~pos.x
|
||||
```
|
||||
|
||||
Переменные можно указывать и в качестве значений по-умолчанию, при использовании префикса `$`:
|
||||
Переменные можно указывать и в качестве значений по умолчанию, при использовании префикса `$`:
|
||||
|
||||
```python
|
||||
t:int=$time
|
||||
```
|
||||
|
||||
Перечисления указывазываются в формате:
|
||||
Перечисления указываются в формате:
|
||||
|
||||
```python
|
||||
mode:[replace|destruct|none]
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@
|
|||
|
||||
Далее в *res/content* создаётся папка с выбранным названием контент-пака.
|
||||
|
||||
В созданной папке создаётся файл **package.json** с следующим содержимым:
|
||||
В созданной папке создаётся файл **package.json** со следующим содержимым:
|
||||
```json
|
||||
{
|
||||
"id": "выбранное_имя_пака",
|
||||
|
|
@ -98,13 +98,13 @@ print(file.read("пак:package.json")) -- выведет содержимое p
|
|||
- `pages/` - макеты страниц меню (элемент pagebox)
|
||||
- Конфигурация:
|
||||
- `config/` - файлы конфигурации
|
||||
- `defaults.toml` - переопределения стандартных привязок к контенту, такие как сущность игрока, генератор по-умолчанию и т.д.
|
||||
- `defaults.toml` - переопределения стандартных привязок к контенту, такие как сущность игрока, генератор по умолчанию и т.д.
|
||||
- `bindings.toml` - привязки к клавишам / мыши
|
||||
- `user-props.toml` - пользовательские свойства определений контента
|
||||
- `devtools/` - вспомогательные файлы внутренних инструментов отладки
|
||||
- `content.json` - генерируемые автоматически списки контента, используемое для проверки корректности индексов в мире и конвертации при несовпадении
|
||||
- `content.json` - генерируемые автоматически списки контента, используемые для проверки корректности индексов в мире и конвертации при несовпадении
|
||||
- `icon.png` - иконка пака
|
||||
- `package.json` - файл опеределения пака
|
||||
- `package.json` - файл определения пака
|
||||
- `preload.json` - списки предзагрузки ассетов, которые не загружаются автоматически, не следует указывать ассеты без надобности
|
||||
- `resources.json` - списки определений [ресурсов](resources.md) (не путать с ассетами)
|
||||
- `resource-aliases.json` - файлы объявления псевдонимов для [ресурсов](resources.md)
|
||||
|
|
@ -120,7 +120,7 @@ print(file.read("пак:package.json")) -- выведет содержимое p
|
|||
будет выбран тот, что принадлежит источнику с наивысшим приоритетом.
|
||||
|
||||
Источники контента в порядке убывания приоритета:
|
||||
- `world:content` - контент папке с миром (`мир/content/`)
|
||||
- `world:content` - контент в папке с миром (`мир/content/`)
|
||||
- `user:content` - контент в папке пользователя (`$HOME/.voxeng/content/`)
|
||||
- `project:content` - контент в папке с проектом (`проект/content/`)
|
||||
- `res:content` - встроенный контент, поставляемый вместе с ядром движка (`res/content/`)
|
||||
|
|
|
|||
|
|
@ -21,7 +21,7 @@
|
|||
|
||||
#### Данные в мире
|
||||
|
||||
Состояние, которое нужно сохранять в мире, должны находиться в `world:data/id_пака/`. Путь следует получать через специальную функцию:
|
||||
Состояние, которое нужно сохранять в мире, должно находиться в `world:data/id_пака/`. Путь следует получать через специальную функцию:
|
||||
```lua
|
||||
local path = pack.data_file(PACK_ID, "имя_файла")
|
||||
file.write(path, данные)
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
## Логика
|
||||
|
||||
### Cписок компонентов - *components*
|
||||
### Список компонентов - *components*
|
||||
|
||||
Определяет компоненты и порядок их инициализации.
|
||||
|
||||
|
|
@ -56,7 +56,7 @@
|
|||
Определяет то, как с ним будет работать физический движок.
|
||||
|
||||
- *static* (статический) - физический движок не воздействует на тело.
|
||||
- *dynamic* (динамический) - тип по-умолчанию. Физический движок просчитывает движение и столкновения.
|
||||
- *dynamic* (динамический) - тип по умолчанию. Физический движок просчитывает движение и столкновения.
|
||||
- *kinematic* (кинематический) - просчитывается только движение, без столкновений.
|
||||
|
||||
### Блокирование - *blocking*
|
||||
|
|
@ -65,16 +65,16 @@
|
|||
|
||||
*В будущем будет также блокировать движение других сущностей.*
|
||||
|
||||
Значение по-умолчанию: *true*.
|
||||
Значение по умолчанию: *true*.
|
||||
|
||||
### Непрозрачность для лучей - *selectable*
|
||||
|
||||
При значении в `false` курсор будет игнорировать cущность, пропуская луч далее.
|
||||
При значении в `false` курсор будет игнорировать сущность, пропуская луч далее.
|
||||
Распространяется на все использования raycast без флага include_non_selectable.
|
||||
|
||||
### Список сенсоров - *sensors*
|
||||
|
||||
Сенсор - область пространства, привязанная к физическому телу, детектирующее попадание в него других тел.
|
||||
Сенсор - область пространства, привязанная к физическому телу, детектирующая попадание в него других тел.
|
||||
|
||||
- При попадании тела вызывается событие *on_sensor_enter*.
|
||||
- При покидании тела вызывается событие *on_sensor_exit*.
|
||||
|
|
@ -125,7 +125,7 @@
|
|||
|
||||
### Имя скелета - *skeleton-name*
|
||||
|
||||
Значение по-умолчанию совпадает с именем сущности. Определяет то, какой скелет будет использоваться сущностью. См. [риггинг](rigging.md).
|
||||
Значение по умолчанию совпадает с именем сущности. Определяет то, какой скелет будет использоваться сущностью. См. [риггинг](rigging.md).
|
||||
|
||||
### Тип освещения - *lighting-mode*
|
||||
|
||||
|
|
@ -140,7 +140,7 @@
|
|||
|
||||
(Указываются булевы значения)
|
||||
|
||||
| Название | Цель | По-умолчанию |
|
||||
| Название | Цель | По умолчанию |
|
||||
| ---------------------- | -------------------------------------------------------- | ------------ |
|
||||
| save | сама сущность | true |
|
||||
| save-skeleton-pose | поза скелета сущности | false |
|
||||
|
|
|
|||
|
|
@ -14,8 +14,8 @@
|
|||
### Модель предмета - `model-name`
|
||||
|
||||
Имя модели предмета. Модель будет загружена автоматически.
|
||||
Значение по-умолчанию - `packid:itemname.model`.
|
||||
Если модель не указана, будет сгенерирована автоматическию
|
||||
Значение по умолчанию - `packid:itemname.model`.
|
||||
Если модель не указана, будет сгенерирована автоматически
|
||||
|
||||
### Имя и Описание
|
||||
`caption` - имя предмета в инвентаре
|
||||
|
|
@ -47,11 +47,11 @@
|
|||
|
||||
- `[15, 15, 15]` - самый яркий белый свет
|
||||
- `[7, 0, 0]` - слабый красный свет
|
||||
- `[0, 0, 0]` - предмет не излучает свет (по-умолчанию)
|
||||
- `[0, 0, 0]` - предмет не излучает свет (по умолчанию)
|
||||
|
||||
### Размер стопки (стека) - `stack-size`
|
||||
|
||||
Определяет максимальное количество предмета в одном слоте. Значение по-умолчанию - 64.
|
||||
Определяет максимальное количество предмета в одном слоте. Значение по умолчанию - 64.
|
||||
|
||||
### Число использований (прочность) - `uses`
|
||||
|
||||
|
|
@ -64,11 +64,11 @@
|
|||
- `none` - отображение отключено
|
||||
- `number` - число
|
||||
- `relation` - отношение текущего значения к изначальному (x/y)
|
||||
- `vbar` - вертикальная шкала (используется по-умолчанию)
|
||||
- `vbar` - вертикальная шкала (используется по умолчанию)
|
||||
|
||||
### Имя скрипта - `script-name`
|
||||
|
||||
Определяет имя скрипта, содержащего обработчики событий предмета. По-умолчанию соответствует строковому id (имени) предмета.
|
||||
Определяет имя скрипта, содержащего обработчики событий предмета. По умолчанию соответствует строковому id (имени) предмета.
|
||||
Свойство обеспечивает возможность использования одного скрипта для нескольких предметов.
|
||||
|
||||
## Теги - *tags*
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
Частицы представляют собой таблицу, все поля которой опциональны.
|
||||
|
||||
|
||||
| Поле | Описание | По-умолчанию |
|
||||
| Поле | Описание | По умолчанию |
|
||||
| --------------- | ---------------------------------------------------------------------------- | --------------- |
|
||||
| texture | Текстура частицы. | "" |
|
||||
| frames | Кадры анимации (массив имен текстур). Должны находиться в одном атласе. | {} |
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@
|
|||
Запрашиваемые паком ресурсы указываются через файл resources.json в формате:
|
||||
```json
|
||||
{
|
||||
"тип-ресура": [
|
||||
"тип-ресурса": [
|
||||
"имена",
|
||||
"ресурсов"
|
||||
]
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@
|
|||
>
|
||||
> Скелет является неиндексируемой единицей контента. При его загрузке к имени добавляется префикс пака (пример: *drop* в паке base -> *base:drop*).
|
||||
|
||||
Элемент скелета, или кость, состоит из матрицы транформации, определяющей её положение, вращение и масштаб относительно родительского элемента (кости) или сущности, если элемент является корневым, модели и списка под-элементов.
|
||||
Элемент скелета, или кость, состоит из матрицы трансформации, определяющей её положение, вращение и масштаб относительно родительского элемента (кости) или сущности, если элемент является корневым, модели и списка под-элементов.
|
||||
|
||||
Файл скелета имеет следующую структуру:
|
||||
```json
|
||||
|
|
|
|||
|
|
@ -69,7 +69,7 @@
|
|||
|
||||
Актуальна следующая структура:
|
||||
|
||||
- Глобальное пространство (оно же - _G), являющееся корневым, запись в которое, вне модулей ядра движка, является крайне нежелательным для вашего же времени, что может уйти на лишние часы отладки.
|
||||
- Глобальное пространство (оно же - _G), являющееся корневым, запись в которое, вне модулей ядра движка, является крайне нежелательной для вашего же времени, что может уйти на лишние часы отладки.
|
||||
- Пространство пака - создаётся каждый раз при загрузке контента для каждого, включённого в конфигурацию, пака. Это пространство используют модули, а также скрипты предметов и блоков.
|
||||
- Пространство [компонента](scripting/ecs.md#пользовательские-компоненты).
|
||||
- Пространство [UI-документа](scripting/ui.md)
|
||||
|
|
@ -77,7 +77,7 @@
|
|||
|
||||
## Модули
|
||||
|
||||
Модуль - глобальный объект со сроком жизни, ограниченным сроком жизни контента, используемый как для взаимодействия разных паков, так и для вместо глобальных переменных в пределах самого пака.
|
||||
Модуль - глобальный объект со сроком жизни, ограниченным сроком жизни контента, используемый как для взаимодействия разных паков, так и в качестве замены глобальных переменных в пределах самого пака.
|
||||
|
||||
Модуль должен находиться в `контентпак/modules/**` (допускаются вложенные папки, что нужно будет указывать)
|
||||
|
||||
|
|
|
|||
|
|
@ -2,12 +2,12 @@
|
|||
|
||||
Библиотека для высокоуровневого управления работой движка, доступная только в режиме сценария или теста.
|
||||
|
||||
Имя сценария/теста без пути и расширения доступен как `app.script`. Путь к файлу можно получить как:
|
||||
Имя сценария/теста без пути и расширения доступно как `app.script`. Путь к файлу можно получить как:
|
||||
```lua
|
||||
local filename = "script:"..app.script..".lua"
|
||||
```
|
||||
|
||||
Так как управляющий сценарий может не принадлежать ни одному из паков, он не относиться к своему паку и имеет собственное пространство имён, в котором доступны все глобальные функции и таблицы, а также библиотека `app`.
|
||||
Так как управляющий сценарий может не принадлежать ни одному из паков, он не относится к своему паку и имеет собственное пространство имён, в котором доступны все глобальные функции и таблицы, а также библиотека `app`.
|
||||
|
||||
## Содержание:
|
||||
Методы для работы с:
|
||||
|
|
@ -25,18 +25,18 @@ app.tick()
|
|||
-- Ожидает указанное время в секундах, выполняя основной цикл движка.
|
||||
app.sleep(time: number)
|
||||
|
||||
-- Завершает выполнение движка, выводя стек вызовов для ослеживания места вызова функции.
|
||||
-- Завершает выполнение движка, выводя стек вызовов для отслеживания места вызова функции.
|
||||
app.quit()
|
||||
|
||||
-- Ожидает истинности утверждения (условия), проверяемого функцией,
|
||||
-- выполняя основной цикл движка.
|
||||
app.sleep_until(
|
||||
-- функция, проверяющее условия завершения ожидания
|
||||
-- функция, проверяющая условия завершения ожидания
|
||||
predicate: function() -> boolean,
|
||||
-- максимальное количество тактов цикла движка, после истечения которых
|
||||
-- будет брошено исключение "max ticks exceed"
|
||||
[опционально] max_ticks: int = 1e9,
|
||||
-- максимальное длительность ожидания в секундах.
|
||||
-- максимальная длительность ожидания в секундах.
|
||||
-- (работает с системным временем, включая test-режим)
|
||||
[опционально] timeout: number = 1e9
|
||||
)
|
||||
|
|
|
|||
|
|
@ -51,7 +51,7 @@ assets.parse_animation(
|
|||
-- Создаёт холст (Canvas) из загруженной текстуры
|
||||
assets.to_canvas(
|
||||
-- Имя загруженной текстуры.
|
||||
-- Поддерживается как отдельные ("имя_текстуры"),
|
||||
-- Поддерживаются как отдельные ("имя_текстуры"),
|
||||
-- так и находящиеся в атласе ("атлас:имя_текстуры").
|
||||
name: string
|
||||
) -> Canvas
|
||||
|
|
|
|||
|
|
@ -29,11 +29,11 @@ block.properties: table<int, table<string, any>>
|
|||
-- Если чанк на указанных координатах не загружен, возвращает -1.
|
||||
block.get(x: int, y: int, z: int) -> int
|
||||
|
||||
-- Устанавливает блок с заданным числовым id и состоянием (0 - по-умолчанию) на заданных координатах.
|
||||
-- Устанавливает блок с заданным числовым id и состоянием (0 - по умолчанию) на заданных координатах.
|
||||
-- Если передан noupdate=true, то вызов ивента `on_update` для соседних блоков не произойдёт.
|
||||
block.set(x: int, y: int, z: int, id: int, states: int, noupdate: boolean=false)
|
||||
|
||||
-- Устанавливает блок с заданным числовым id и состоянием (0 - по-умолчанию) на заданных координатах
|
||||
-- Устанавливает блок с заданным числовым id и состоянием (0 - по умолчанию) на заданных координатах
|
||||
-- от лица игрока, вызывая событие on_placed.
|
||||
-- playerid не является обязательным
|
||||
block.place(x: int, y: int, z: int, id: int, states: int, [опционально] playerid: int)
|
||||
|
|
@ -70,7 +70,7 @@ block.caption(blockid: int) -> string
|
|||
-- Возвращает строковый id блока по его числовому id.
|
||||
block.name(blockid: int) -> string
|
||||
|
||||
-- Возвращает числовой id блока, принимая в качестве агрумента строковый
|
||||
-- Возвращает числовой id блока, принимая в качестве аргумента строковый
|
||||
block.index(name: string) -> int
|
||||
|
||||
-- Собирает полное состояние в виде целого числа
|
||||
|
|
@ -106,7 +106,7 @@ block.raycast(start: vec3, dir: vec3, max_distance: number, [опциональ
|
|||
Бросает луч из точки start в направлении dir. Max_distance указывает максимальную длину луча.
|
||||
|
||||
Аргумент `filter` позволяет указать какие блоки являются "прозрачными" для луча, прим.: {"base:glass","base:water"}.
|
||||
Для использования агрумент `dest` нужно чем-то заполнить(можно nil), это сделано для обратной совместимости
|
||||
Для использования аргумент `dest` нужно чем-то заполнить (можно nil), это сделано для обратной совместимости
|
||||
|
||||
Аргумент `include_non_selectable` определяет, будут ли учтены блоки, которые нельзя выбрать курсором.
|
||||
Пример - `base:water`
|
||||
|
|
@ -125,11 +125,11 @@ block.raycast(start: vec3, dir: vec3, max_distance: number, [опциональ
|
|||
block.get_X(x: int, y: int, z: int) -> int, int, int
|
||||
block.get_X(id: int, rotation: int) -> int, int, int
|
||||
|
||||
-- То же, но для оси Y (по-умолчанию 0, 1, 0)
|
||||
-- То же, но для оси Y (по умолчанию 0, 1, 0)
|
||||
block.get_Y(x: int, y: int, z: int) -> int, int, int
|
||||
block.get_Y(id: int, rotation: int) -> int, int, int
|
||||
|
||||
-- То же, но для оси Z (по-умолчанию 0, 0, 1)
|
||||
-- То же, но для оси Z (по умолчанию 0, 0, 1)
|
||||
block.get_Z(x: int, y: int, z: int) -> int, int, int
|
||||
block.get_Z(id: int, rotation: int) -> int, int, int
|
||||
|
||||
|
|
|
|||
|
|
@ -24,7 +24,7 @@ byteutil.tpack(format: string, ...) -> table
|
|||
|
||||
Символы значений описывают тип и размер.
|
||||
|
||||
| Символ | Аналог в С++ | Тип Lua | Размер |
|
||||
| Символ | Аналог в C++ | Тип Lua | Размер |
|
||||
| --------- | --------------- | -------- | ------- |
|
||||
| `b` | int8_t | number | 1 байт |
|
||||
| `B` | uint8_t | number | 1 байт |
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@ cam:get_pos() -> vec3
|
|||
-- устанавливает позицию камеры
|
||||
cam:set_pos(pos: vec3)
|
||||
|
||||
-- возращает вращение камеры
|
||||
-- возвращает вращение камеры
|
||||
cam:get_rot() -> mat4
|
||||
-- устанавливает вращение камеры
|
||||
cam:set_rot(rot: mat4)
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# Библиотека *compression*
|
||||
|
||||
Библиотека функций для работы сжатия/разжатия массивов байт
|
||||
Библиотека функций для сжатия/разжатия массивов байт
|
||||
|
||||
```lua
|
||||
-- Сжимает массив байт.
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
# Библиотека *ctypes*
|
||||
|
||||
Библиотека для безопасной работы с типами языка С.
|
||||
Библиотека для безопасной работы с типами языка C.
|
||||
|
||||
| ctypes.\<name\> | С-тип | Минимум | Максимум |
|
||||
| ctypes.\<name\> | C-тип | Минимум | Максимум |
|
||||
| ------------- | -------- | -------------------- | -------------------- |
|
||||
| uint8 | uint8_t | 0 | 255 |
|
||||
| uint16 | uint16_t | 0 | 65535 |
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@ entities.get(uid: int) -> table
|
|||
-- префикс - id пака
|
||||
-- имя - название компонента
|
||||
-- префикс и имя компонента разделяются двумя подчеркиваниями
|
||||
-- Возвращает обьект сущности
|
||||
-- Возвращает объект сущности
|
||||
entities.spawn(name: string, pos: vec3, [optional] args: table) -> table
|
||||
|
||||
-- Проверяет наличие сущности по уникальному идентификатору.
|
||||
|
|
@ -41,7 +41,7 @@ entities.defs_count() -> int
|
|||
```
|
||||
|
||||
> [!NOTE]
|
||||
> Следующие функции для получения получения нескольких сущностей возвращают таблицы с целочисленными ключами (uid).
|
||||
> Следующие функции для получения нескольких сущностей возвращают таблицы с целочисленными ключами (uid).
|
||||
> Для итерации нужно использовать pairs, для подсчёта размера таблицы - table.count_pairs.
|
||||
> Использование ipairs даст некорректные результаты, так как возвращаемая таблица не является массивом.
|
||||
|
||||
|
|
|
|||
|
|
@ -64,7 +64,7 @@ file.write(путь: string, текст: string) -> nil
|
|||
-- Записывает массив байт в файл (с перезаписью)
|
||||
file.write_bytes(путь: string, data: table<number>)
|
||||
|
||||
-- Удаляет файл. Возращает true если файл существовал. Бросает исключение при нарушении доступа.
|
||||
-- Удаляет файл. Возвращает true если файл существовал. Бросает исключение при нарушении доступа.
|
||||
file.remove(путь: string) -> boolean
|
||||
|
||||
-- Проверяет, существует ли по данному пути файл
|
||||
|
|
@ -118,7 +118,7 @@ file.read_combined_object(путь: string) -> table
|
|||
|
||||
## Zip-архивы
|
||||
```lua
|
||||
-- Монтирует ZIP-архив как файловой системе. Возвращает имя точки входа.
|
||||
-- Монтирует ZIP-архив к файловой системе. Возвращает имя точки входа.
|
||||
file.mount(путь: string) -> string
|
||||
|
||||
-- Размонтирует точку входа.
|
||||
|
|
|
|||
|
|
@ -33,7 +33,7 @@ skeleton:get_texture(key: string) -> string
|
|||
-- Назначает текстуру по ключу
|
||||
skeleton:set_texture(key: string, value: string)
|
||||
|
||||
-- Проверяет статус видимости кости по индесу
|
||||
-- Проверяет статус видимости кости по индексу
|
||||
-- или всего скелета, если индекс не указан
|
||||
skeleton:is_visible([опционально] index: int) -> boolean
|
||||
|
||||
|
|
|
|||
|
|
@ -4,9 +4,9 @@
|
|||
|
||||
Настройки погоды:
|
||||
|
||||
| Свойство | Описание | По-умолчанию |
|
||||
| Свойство | Описание | По умолчанию |
|
||||
| ------------- | ------------------------------------------ | ----------------- |
|
||||
| fall | Осадки (см. таблица 2) | {} |
|
||||
| fall | Осадки (см. таблицу 2) | {} |
|
||||
| clouds | Облачность [0.0, 1.0] | 0.0 |
|
||||
| fog_opacity | Максимальная плотность тумана [0.0, 1.0] | 0.0 |
|
||||
| fog_dencity | Плотность тумана | 1.0 |
|
||||
|
|
@ -18,7 +18,7 @@
|
|||
|
||||
Осадки:
|
||||
|
||||
| Свойство | Описание | По-умолчанию |
|
||||
| Свойство | Описание | По умолчанию |
|
||||
| ------------- | -------------------------------------------- | ------------ |
|
||||
| texture | Текстура осадков | "" |
|
||||
| noise | Шум осадков | "" |
|
||||
|
|
@ -27,7 +27,7 @@
|
|||
| scale | Масштаб UV развертки осадков | 0.1 |
|
||||
| min_opacity | Минимальный множитель alpha-канала осадков | 0.0 |
|
||||
| max_opacity | Максимальный множитель alpha-канала осадков | 1.0 |
|
||||
| max_intensity | Масимальная интенсивность осадков | 1.0 |
|
||||
| max_intensity | Максимальная интенсивность осадков | 1.0 |
|
||||
| opaque | Отключение полупрозрачности осадков | false |
|
||||
| splash | Таблица настроек частиц всплесков от осадков | {} |
|
||||
|
||||
|
|
|
|||
|
|
@ -106,14 +106,14 @@ gui.show_message(
|
|||
gui.ask(
|
||||
-- сообщение (не переводится автоматически, используйте gui.str(...))
|
||||
message: string,
|
||||
-- функция, вызываемая при подтвержении
|
||||
-- функция, вызываемая при подтверждении
|
||||
on_confirm: function() -> nil,
|
||||
-- функция, вызываемая при отказе/отмене
|
||||
[опционально] on_deny: function() -> nil,
|
||||
-- текст кнопки подтвержения (по-умолчанию: "Да")
|
||||
-- используйте пустую строку для значения по-умолчанию, если нужно указать no_text.
|
||||
-- текст кнопки подтверждения (по умолчанию: "Да")
|
||||
-- используйте пустую строку для значения по умолчанию, если нужно указать no_text.
|
||||
[опционально] yes_text: string
|
||||
-- текст кнопки отказа (по-умолчанию: "Нет")
|
||||
-- текст кнопки отказа (по умолчанию: "Нет")
|
||||
[опционально] no_text: string
|
||||
)
|
||||
```
|
||||
|
|
@ -131,14 +131,14 @@ gui.alert(
|
|||
gui.confirm(
|
||||
-- сообщение (не переводится автоматически, используйте gui.str(...))
|
||||
message: string,
|
||||
-- функция, вызываемая при подтвержении
|
||||
-- функция, вызываемая при подтверждении
|
||||
on_confirm: function() -> nil,
|
||||
-- функция, вызываемая при отказе/отмене
|
||||
[опционально] on_deny: function() -> nil,
|
||||
-- текст кнопки подтвержения (по-умолчанию: "Да")
|
||||
-- используйте пустую строку для значения по-умолчанию, если нужно указать no_text.
|
||||
-- текст кнопки подтверждения (по умолчанию: "Да")
|
||||
-- используйте пустую строку для значения по умолчанию, если нужно указать no_text.
|
||||
[опционально] yes_text: string
|
||||
-- текст кнопки отказа (по-умолчанию: "Нет")
|
||||
-- текст кнопки отказа (по умолчанию: "Нет")
|
||||
[опционально] no_text: string
|
||||
)
|
||||
```
|
||||
|
|
|
|||
|
|
@ -20,7 +20,7 @@ hud.open(
|
|||
[опционально] invid: int
|
||||
) -> int
|
||||
|
||||
-- Возвращает true если указаный макет UI открыт.
|
||||
-- Возвращает true если указанный макет UI открыт.
|
||||
hud.is_open(
|
||||
layoutid: string
|
||||
) -> boolean
|
||||
|
|
|
|||
|
|
@ -11,7 +11,8 @@ input.mousecode(mousename: string) -> number
|
|||
|
||||
-- Проверяет активность ввода по коду, состоящему из:
|
||||
-- * типа ввода: key (клавиша) или mouse (кнопка мыши)
|
||||
-- * код ввода: [имя клавиши](#имена-клавиш) или имя кнопки мыши (left, middle, right)
|
||||
-- * код ввода: имя клавиши или имя кнопки мыши (left, middle, right).
|
||||
-- См. user-input.md
|
||||
input.is_pressed(code: string) -> boolean
|
||||
|
||||
-- Возвращает названия всех доступных привязок.
|
||||
|
|
@ -32,7 +33,7 @@ input.set_enabled(bindname: string, flag: boolean)
|
|||
-- Возвращает позицию курсора на экране.
|
||||
input.get_mouse_pos() -> {number, number}
|
||||
|
||||
-- Возращает дельту позиции курсора.
|
||||
-- Возвращает дельту позиции курсора.
|
||||
input.get_mouse_delta() -> {number, number}
|
||||
|
||||
-- Возвращает вертикальное смещение колеса мыши, накопленное за текущий кадр.
|
||||
|
|
|
|||
|
|
@ -55,9 +55,9 @@ inventory.find_by_item(
|
|||
invid: int,
|
||||
-- id предмета
|
||||
itemid: int,
|
||||
-- [опционально] индекс начала диапазона слотов (c 0)
|
||||
-- [опционально] индекс начала диапазона слотов (с 0)
|
||||
range_begin: int,
|
||||
-- [опционально] индекс конца диапазона слотов (c 0)
|
||||
-- [опционально] индекс конца диапазона слотов (с 0)
|
||||
range_end: int,
|
||||
-- [опционально] минимальное количество предмета в слоте
|
||||
min_count: int = 1
|
||||
|
|
@ -82,7 +82,7 @@ inventory.remove(invid: int)
|
|||
|
||||
> [!NOTE]
|
||||
> Локальные свойства предмета - данные прикреплённые к последнему предмету в стеке.
|
||||
> При разделении стека (ПКМ) данные не копируются а перемещаются в новый стек.
|
||||
> При разделении стека (ПКМ) данные не копируются, а перемещаются в новый стек.
|
||||
> Свойства могут иметь любой сериализуемый тип, включая таблицы.
|
||||
> В отличие от полей блоков имена свойств не требуется регистрировать в определении предмета.
|
||||
|
||||
|
|
@ -172,13 +172,13 @@ inventory.get_all_data(
|
|||
slot: int,
|
||||
) -> table | nil
|
||||
|
||||
-- Устанавливает значения локальных cвойств предмета.
|
||||
-- Устанавливает значения локальных свойств предмета.
|
||||
inventory.set_all_data(
|
||||
-- id инвентаря
|
||||
invid: int,
|
||||
-- индекс слота
|
||||
slot: int,
|
||||
-- таблица cвойство:значение
|
||||
-- таблица свойство:значение
|
||||
fields: table,
|
||||
-- удалить остальные значения свойств
|
||||
[опционально] clear: boolean = false
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
*mat4* содержит набор функций для работы с матрицами трансформации размерностью 4x4.
|
||||
|
||||
Большинство функций имеют несколько вариантов списка агрументов (перегрузок).
|
||||
Большинство функций имеют несколько вариантов списка аргументов (перегрузок).
|
||||
|
||||
## Единичная матрица - *mat4.idt(...)*
|
||||
|
||||
|
|
@ -117,7 +117,7 @@ mat4.decompose(m: matrix)
|
|||
## Отслеживание точки - *mat4.look_at(...)*
|
||||
|
||||
```lua
|
||||
-- cоздаёт матрицу вида с точки 'eye' на точку 'center', где вектор 'up' определяет верх.
|
||||
-- создаёт матрицу вида с точки 'eye' на точку 'center', где вектор 'up' определяет верх.
|
||||
mat4.look_at(eye: vec3, center: vec3, up: vec3)
|
||||
-- записывает матрицу вида в dst
|
||||
mat4.look_at(eye: vec3, center: vec3, up: vec3, dst: matrix)
|
||||
|
|
@ -126,14 +126,14 @@ mat4.look_at(eye: vec3, center: vec3, up: vec3, dst: matrix)
|
|||
## Расчёт матрицы перспективы - *mat4.perspective*
|
||||
|
||||
```lua
|
||||
-- возвращает расчитанную матрицу перспективы.
|
||||
-- возвращает рассчитанную матрицу перспективы.
|
||||
-- параметр fov принимает значение вертикального поля зрения в градусах.
|
||||
-- параметр ratio задаёт отношение сторон (сторона X к стороне Y, пример: для монитора 800:600 отношение сторон равно 4 к 3, или 4 / 3).
|
||||
-- параметр near задаёт расстояние от камеры до плоскости Near.
|
||||
-- параметр far задаёт расстояние от камеры до плоскости Far.
|
||||
mat4.perspective(fov: number, ratio: number, near: number, far: number) -> mat4
|
||||
|
||||
-- расчитывает матрицу перспективы на основе переданных значений и записывает её в переменную dst.
|
||||
-- рассчитывает матрицу перспективы на основе переданных значений и записывает её в переменную dst.
|
||||
mat4.perspective(fov: number, ratio: number, near: number, far: number, dst: mat4) -> nil
|
||||
```
|
||||
|
||||
|
|
|
|||
|
|
@ -112,7 +112,7 @@ socket:recv(
|
|||
-- Использовать таблицу вместо Bytearray
|
||||
[опционально] usetable: boolean=false
|
||||
) -> nil|table|Bytearray
|
||||
-- В случае ошибки возвращает nil (сокет закрыт или несуществует).
|
||||
-- В случае ошибки возвращает nil (сокет закрыт или не существует).
|
||||
-- Если данных пока нет, возвращает пустой массив байт.
|
||||
|
||||
-- Асинхронный вариант для использования в корутинах.
|
||||
|
|
@ -170,7 +170,7 @@ socket:set_nodelay(state: boolean)
|
|||
network.tcp_open(
|
||||
-- Порт
|
||||
port: int,
|
||||
-- Функция, вызываемая при поключениях
|
||||
-- Функция, вызываемая при подключениях
|
||||
-- Как единственный аргумент передаётся сокет подключенного клиента
|
||||
callback: function(Socket)
|
||||
) -> ServerSocket
|
||||
|
|
@ -224,7 +224,7 @@ socket:get_address() -> string, int
|
|||
```lua
|
||||
network.udp_open(
|
||||
port: int,
|
||||
-- Функция, вызываемая при получении датаграмы
|
||||
-- Функция, вызываемая при получении датаграммы
|
||||
-- В параметры передаётся адрес и порт отправителя, а также сами данные
|
||||
datagramHandler: function(address: string, port: int, data: Bytearray, server: DatagramServerSocket)
|
||||
) -> DatagramServerSocket
|
||||
|
|
|
|||
|
|
@ -49,7 +49,7 @@ pack.is_installed(packid: string) -> boolean
|
|||
pack.get_installed() -> table<string>
|
||||
```
|
||||
|
||||
Возращает id всех установленных в мире контент-паков.
|
||||
Возвращает id всех установленных в мире контент-паков.
|
||||
|
||||
```lua
|
||||
pack.get_available() -> table<string>
|
||||
|
|
@ -102,4 +102,4 @@ pack.assemble(packids: table<string>) -> table<string>
|
|||
pack.request_writeable(packid: string, callback: function(string))
|
||||
```
|
||||
|
||||
Запрашивает у пользователя право на модификацию пака. При подтвержении новая точка входа будет передана в callback.
|
||||
Запрашивает у пользователя право на модификацию пака. При подтверждении новая точка входа будет передана в callback.
|
||||
|
|
|
|||
|
|
@ -74,7 +74,7 @@ player.set_infinite_items(playerid: int, boolean)
|
|||
player.is_infinite_items(playerid: int) -> boolean
|
||||
|
||||
|
||||
-- Сеттер и геттер мнгновенного разрушения блоков при активации привязки player.destroy.
|
||||
-- Сеттер и геттер мгновенного разрушения блоков при активации привязки player.destroy.
|
||||
player.set_instant_destruction(playerid: int, boolean)
|
||||
player.is_instant_destruction(playerid: int) -> boolean
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Библиотека для работы с кватернионами.
|
||||
|
||||
Кватернионы задаюся таблицей, состоящей из 4 компонентов:
|
||||
Кватернионы задаются таблицей, состоящей из 4 компонентов:
|
||||
`{w, x, y, z}`
|
||||
|
||||
## Кватернион из матрицы - *quat.from_mat4(...)*
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# Библиотека *random*
|
||||
|
||||
Библиотека функций для генерации случайный чисел.
|
||||
Библиотека функций для генерации случайных чисел.
|
||||
|
||||
## Недетерминированные числа
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
rules.create(
|
||||
-- имя правила
|
||||
name: string,
|
||||
-- значение по-умолчанию
|
||||
-- значение по умолчанию
|
||||
default: boolean,
|
||||
-- функция-обработчик изменения значения
|
||||
[опционально] handler: function
|
||||
|
|
@ -14,7 +14,7 @@ rules.create(
|
|||
Создаёт правило. Если указан обработчик, возвращает id для возможности удаления.
|
||||
|
||||
> [!NOTE]
|
||||
> Созданием правила считается вызов rules.create с назначением значения по-умолчанию.
|
||||
> Созданием правила считается вызов rules.create с назначением значения по умолчанию.
|
||||
> Не созданные правила могут быть использованы, но сброс через rules.reset приведёт
|
||||
> к установке значения nil.
|
||||
|
||||
|
|
@ -54,13 +54,13 @@ rules.set(name: string, value: boolean)
|
|||
rules.reset(name: string)
|
||||
```
|
||||
|
||||
Сбрасывает значение правила к значению по-умолчанию.
|
||||
Сбрасывает значение правила к значению по умолчанию.
|
||||
|
||||
|
||||
## Стандартные правила
|
||||
|
||||
|
||||
| Имя | Описание | По-умолчанию |
|
||||
| Имя | Описание | По умолчанию |
|
||||
| ---------------------- | --------------------------------------------------------------- | ------------ |
|
||||
| allow-cheats | Разрешить команды, имена которых есть в массиве console.cheats. | true |
|
||||
| allow-content-access | Разрешить панель доступа к контенту. | true |
|
||||
|
|
|
|||
|
|
@ -16,13 +16,13 @@ utf8.length(text: string) -> int
|
|||
-- Возвращает код первого символа строки
|
||||
utf8.codepoint(chars: string) -> int
|
||||
|
||||
-- Кодирует код в в UTF-8
|
||||
-- Кодирует код в UTF-8
|
||||
utf8.encode(codepoint: int) -> string
|
||||
|
||||
-- Возвращает подстроку от позиции startchar до endchar включительно
|
||||
utf8.sub(text: string, startchar: int, [опционально] endchar: int) -> string
|
||||
|
||||
-- Переводит строку в вверхний регистр
|
||||
-- Переводит строку в верхний регистр
|
||||
utf8.upper(text: string) -> string
|
||||
|
||||
-- Переводит строку в нижний регистр
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@
|
|||
|
||||
> [!WARNING]
|
||||
>
|
||||
> Аннотации типов являются частью документации и не указываются при вызове использовании.
|
||||
> Аннотации типов являются частью документации и не указываются при вызове.
|
||||
|
||||
|
||||
## Операции с векторами
|
||||
|
|
|
|||
|
|
@ -23,7 +23,7 @@ world.set_day_time(time: number)
|
|||
-- Устанавливает указанную скорость смены времени суток.
|
||||
world.set_day_time_speed(value: number)
|
||||
|
||||
-- Возвращает скорость скорость смены времени суток.
|
||||
-- Возвращает скорость смены времени суток.
|
||||
world.get_day_time_speed() -> number
|
||||
|
||||
-- Возвращает суммарное время, прошедшее в мире.
|
||||
|
|
@ -63,7 +63,7 @@ world.set_chunk_data(
|
|||
) -> boolean
|
||||
|
||||
-- Сохраняет данные чанка в регион.
|
||||
-- Изменения будет записаны в файл только после сохранения мира.
|
||||
-- Изменения будут записаны в файл только после сохранения мира.
|
||||
world.save_chunk_data(
|
||||
x: int, z: int,
|
||||
-- сжатые данные чанка
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
*Bytearray* - динамический байтовый массив, реализованный через LuaJIT FFI. По нему можно итерироваться стандартными функциями **pairs** и **ipairs**
|
||||
|
||||
<small>Примечание касаемо условных обозначений в документации: псведотип `posint` означает натуральное (положительное ненулевое целое) число.</small>
|
||||
<small>Примечание касаемо условных обозначений в документации: псевдотип `posint` означает натуральное (положительное ненулевое целое) число.</small>
|
||||
|
||||
## Основное
|
||||
### Создание массива
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
## *core:pathfinding*
|
||||
|
||||
Компонент для построение путей движения мобов.
|
||||
Компонент для построения путей движения мобов.
|
||||
|
||||
```lua
|
||||
local pathfinding = entity:require_component("core:pathfinding")
|
||||
|
|
|
|||
|
|
@ -14,12 +14,12 @@ entity:def_index() -> int
|
|||
-- Возвращает имя определения сущности (строковый ID)
|
||||
entity:def_name() -> str
|
||||
|
||||
-- Возращает имя скелета сущности
|
||||
-- Возвращает имя скелета сущности
|
||||
entity:get_skeleton() -> str
|
||||
-- Заменяет скелет сущности
|
||||
entity:set_skeleton(name: str | nil)
|
||||
|
||||
-- Возращает уникальный идентификатор сущности
|
||||
-- Возвращает уникальный идентификатор сущности
|
||||
entity:get_uid() -> int
|
||||
|
||||
-- Возвращает компонент по имени
|
||||
|
|
@ -33,7 +33,7 @@ entity:require_component(name: str) -> компонент
|
|||
entity:set_enabled(name: str, enable: bool)
|
||||
|
||||
-- Возвращает id игрока, к которому привязана сущность, в ином же случае возвращает -1.
|
||||
-- Во время инициализации компонентов при спавне сущности так же возвращает -1,
|
||||
-- Во время инициализации компонентов при спавне сущности также возвращает -1,
|
||||
-- так как привязка происходит после инициализации.
|
||||
entity:get_player() -> int или nil
|
||||
```
|
||||
|
|
@ -72,9 +72,9 @@ tsf:set_rot(rotation: mat4)
|
|||
-- Сокращение
|
||||
local body = entity.rigidbody
|
||||
|
||||
-- Проверяет, включен ли рассчет физики тела
|
||||
-- Проверяет, включен ли расчет физики тела
|
||||
body:is_enabled() -> bool
|
||||
-- Включает/выключает рассчет физики тела
|
||||
-- Включает/выключает расчет физики тела
|
||||
body:set_enabled(enabled: bool)
|
||||
|
||||
-- Возвращает линейную скорость
|
||||
|
|
@ -137,7 +137,7 @@ body:get_ground_vel() -> vec3
|
|||
|
||||
-- Проверяет свойство 'selectable' у сущности (непрозрачность для лучей)
|
||||
body:is_selectable() -> bool
|
||||
-- Устанавливает значение свойство 'selectable' у сущности
|
||||
-- Устанавливает значение свойства 'selectable' у сущности
|
||||
body:set_selectable(flag: bool)
|
||||
```
|
||||
|
||||
|
|
@ -170,7 +170,7 @@ rig:set_texture(key: str, value: str)
|
|||
-- Возвращает индекс кости по имени или nil
|
||||
rig:index(name: str) -> int
|
||||
|
||||
-- Проверяет статус видимости кости по индесу
|
||||
-- Проверяет статус видимости кости по индексу
|
||||
-- или всего скелета, если индекс не указан
|
||||
rig:is_visible([optional] index: int) -> bool
|
||||
|
||||
|
|
@ -204,7 +204,7 @@ rig:set_color(color: vec3 | vec4, index: int)
|
|||
Для **каждой** сущности, содержащей компонент, создаётся **отдельный экземпляр** со **своим пространством имен** внутри пространства имён пака.
|
||||
Глобальные переменные, объявляемые в нём, играют роль публичных полей компонента (как и глобальные функции).
|
||||
|
||||
Компоненты сущности указываются через [список "components"](../entity-properties.md#cписок-компонентов---components)
|
||||
Компоненты сущности указываются через [список "components"](../entity-properties.md#список-компонентов---components)
|
||||
|
||||
> [!WARNING]
|
||||
> При выходе сущности за пределы зоны прогрузки она удаляется, вызывая события.
|
||||
|
|
|
|||
|
|
@ -212,7 +212,7 @@ function on_open(invid: int, x: int, y: int, z: int)
|
|||
|
||||
Вызывается при добавлении элемента на экран.
|
||||
- При отсутствии привязки к инвентарю invid будет равен 0.
|
||||
- При отсутствии привязки к блоку x, y, z так же будут равны 0.
|
||||
- При отсутствии привязки к блоку x, y, z также будут равны 0.
|
||||
|
||||
```lua
|
||||
function on_close(invid: int)
|
||||
|
|
@ -297,4 +297,4 @@ events.emit(code: str, args...) -> bool
|
|||
events.remove_by_prefix(packid: str)
|
||||
```
|
||||
|
||||
Удаляет все события с префиксом `packid:`. Вы выходе из мира выгружаются события всех паков, включая `core:`.
|
||||
Удаляет все события с префиксом `packid:`. При выходе из мира выгружаются события всех паков, включая `core:`.
|
||||
|
|
|
|||
|
|
@ -85,16 +85,16 @@ end
|
|||
```
|
||||
|
||||
```lua
|
||||
-- Разбивает строку str на части по указанному разделителю/выражению separator и возвращает результат ввиде таблицы из строк. Если withpattern равен true, то параметр separator будет определяться как регулярное выражение.
|
||||
-- Разбивает строку str на части по указанному разделителю/выражению separator и возвращает результат в виде таблицы из строк. Если withpattern равен true, то параметр separator будет определяться как регулярное выражение.
|
||||
string.explode(separator: string, str: string, withpattern: boolean) -> table<string>
|
||||
|
||||
-- Разбивает строку str на части по указанному разделителю delimiter и возвращает результат ввиде таблицы из строк.
|
||||
-- Разбивает строку str на части по указанному разделителю delimiter и возвращает результат в виде таблицы из строк.
|
||||
string.split(str: string, delimiter: string) -> table<string>
|
||||
|
||||
-- Экранирует специальные символы в строке, такие как `()[]+-.$%^?*` в формате `%символ`. Символ `NUL` (`\0`) будет преобразован в `%z`.
|
||||
string.pattern_safe(str: string) -> string
|
||||
|
||||
-- Разбивает секунды на часы, минуты и миллисекунды и форматирует в format с следующим порядком параметров: `минуты, секунды, миллисекунды` и после возвращает результат. Если format не указан, то возвращает таблицу, где:
|
||||
-- Разбивает секунды на часы, минуты и миллисекунды и форматирует в format со следующим порядком параметров: `минуты, секунды, миллисекунды` и после возвращает результат. Если format не указан, то возвращает таблицу, где:
|
||||
-- h - hours,
|
||||
-- m - minutes,
|
||||
-- s - seconds,
|
||||
|
|
@ -152,7 +152,7 @@ string.url_decode(str: string) -> string
|
|||
## Расширения для math
|
||||
|
||||
```lua
|
||||
-- Возвращает _in, если оно находится в диапозоне low <= _in <= high
|
||||
-- Возвращает _in, если оно находится в диапазоне low <= _in <= high
|
||||
-- Иначе возвращает границу, к которой ближе всего находится значение _in.
|
||||
math.clamp(_in: number, low: number, high: number) -> number
|
||||
|
||||
|
|
@ -171,10 +171,10 @@ math.sum(x: number, ... | t: table) -> number
|
|||
-- Возвращает целое число, указывающее знак числа (-1/0/1)
|
||||
math.sign(x: number) -> int
|
||||
|
||||
-- Одномерный шум с значениями в диапазоне [-1..1].
|
||||
-- Одномерный шум со значениями в диапазоне [-1..1].
|
||||
math.noise(x: number, [опционально] octaves: int = 1) -> number
|
||||
|
||||
-- Двумерный шум с значениями в диапазоне [-1..1].
|
||||
-- Двумерный шум со значениями в диапазоне [-1..1].
|
||||
math.noise2d(x: number, y: number [опционально] octaves: int = 1) -> number
|
||||
```
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
## Библиотека *file*
|
||||
|
||||
См. [библиотека file](builtins/libfile.md)
|
||||
См. [библиотеку file](builtins/libfile.md)
|
||||
|
||||
## Библиотека json
|
||||
|
||||
|
|
@ -12,7 +12,7 @@
|
|||
json.tostring(object: table, human_readable: bool=false) -> str
|
||||
```
|
||||
|
||||
Сериализует объект в JSON строку. При значении второго параметра **true** будет использовано многострочное форматирование, удобное для чтения человеком, а не компактное, использующееся по-умолчанию.
|
||||
Сериализует объект в JSON строку. При значении второго параметра **true** будет использовано многострочное форматирование, удобное для чтения человеком, а не компактное, использующееся по умолчанию.
|
||||
|
||||
```python
|
||||
json.parse(code: str) -> table
|
||||
|
|
@ -58,7 +58,7 @@ yaml.parse(code: str) -> table
|
|||
|
||||
Далее XML как тип данных обозначает Lua-таблицу со следующей структурой:
|
||||
- Тег элемента доступен по ключу `#`
|
||||
- XML-аттрибуты доступны как пары ключ = значение
|
||||
- XML-атрибуты доступны как пары ключ = значение
|
||||
- Вложенные элементы доступны по индексу
|
||||
|
||||
Таблица используется как словарь, так и массив.
|
||||
|
|
@ -133,4 +133,4 @@ pack.data_file(id_пака: str, имя_файла: str) -> str
|
|||
Функция возвращает путь к файлу данных по типу: `world:data/id_пака/имя_файла`
|
||||
и создает недостающие директории в пути.
|
||||
|
||||
При использовании путей не соответствующим `data/{packid}/...` возможна потеря данных при перезаписи мира.
|
||||
При использовании путей, не соответствующих `data/{packid}/...` возможна потеря данных при перезаписи мира.
|
||||
|
|
|
|||
|
|
@ -31,7 +31,7 @@
|
|||
|---------------|-------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `"default"` | Прямой режим. `read` может вернуть меньше байт, чем запрошено. `write` сразу отправляет данные в низкоуровневый дескриптор. Нет буферизации. |
|
||||
| `"yield"` | Как `default`, но при нехватке данных в `read(n)` поток будет вызывать `coroutine.yield()`, пока не соберёт ровно `n` байт. Удобно для корутин. |
|
||||
| `"buffered"` | Включает внутренние буферы чтения и записи. `read` берёт данные из буфера , `write` — складывает в буфер. |
|
||||
| `"buffered"` | Включает внутренние буферы чтения и записи. `read` берёт данные из буфера, `write` — складывает в буфер. |
|
||||
|
||||
### flush
|
||||
|
||||
|
|
@ -90,11 +90,11 @@ io_stream:set_flush_mode(string)
|
|||
--[[
|
||||
Читает данные из потока
|
||||
В двоичном режиме:
|
||||
Если arg - int, то читает из потока arg байт и возвращает ввиде Bytearray или таблицы, если use_table = true
|
||||
Если arg - int, то читает из потока arg байт и возвращает в виде Bytearray или таблицы, если use_table = true
|
||||
|
||||
Если arg - string, то функция интерпретирует arg как шаблон для byteutil. Прочитает кол-во байт, которое определено шаблоном, передаст их в byteutil.unpack и вернёт результат
|
||||
В текстовом режиме:
|
||||
Если arg - int, то читает нужное кол-во строк с окончанием CRLF/LF из arg и возвращает ввиде таблицы. Также, если trim_empty_lines = true, то удаляет пустые строки с начала и конца из итоговой таблицы
|
||||
Если arg - int, то читает нужное кол-во строк с окончанием CRLF/LF из arg и возвращает в виде таблицы. Также, если trim_empty_lines = true, то удаляет пустые строки с начала и конца из итоговой таблицы
|
||||
|
||||
Если arg не определён, то читает одну строку с окончанием CRLF/LF и возвращает её.
|
||||
--]]
|
||||
|
|
@ -128,7 +128,7 @@ io_stream:write_line(string)
|
|||
|
||||
--[[
|
||||
В двоичном режиме:
|
||||
Читает все доступные байты из потока и возвращает ввиде Bytearray или table<int>, если use_table = true
|
||||
Читает все доступные байты из потока и возвращает в виде Bytearray или table<int>, если use_table = true
|
||||
|
||||
В текстовом режиме:
|
||||
Читает все доступные строки из потока в table<string> если use_table = true, или в одну строку вместе с окончаниями, если нет
|
||||
|
|
@ -152,7 +152,7 @@ io_stream:available(
|
|||
--[[
|
||||
Устанавливает позицию в потоке (всегда в байтах)
|
||||
Режимы:
|
||||
b - Задаёт позицию относительно начало файла
|
||||
b - Задаёт позицию относительно начала файла
|
||||
c - Задаёт позицию относительно текущей позиции
|
||||
e - Задаёт позицию относительно конца файла
|
||||
|
||||
|
|
@ -201,7 +201,7 @@ io_stream:flush()
|
|||
io_stream.wrap_bytearray(
|
||||
buffer: Bytearray,
|
||||
|
||||
-- по-умолчанию равен true, поскольку функция из вводных аргументов
|
||||
-- по умолчанию равен true, поскольку функция из вводных аргументов
|
||||
-- будет использоваться преимущественно для работы с двоичными данными.
|
||||
[опционально] binary_mode: boolean = true
|
||||
) -> io_stream
|
||||
|
|
|
|||
|
|
@ -95,4 +95,4 @@ function bit_converter.bytes_to_sint32(bytes: table|Bytearray, [опционал
|
|||
```lua
|
||||
function bit_converter.bytes_to_int64(bytes: table|Bytearray, [опционально] order: string) -> int
|
||||
```
|
||||
Конвертирует массив байтов в 8-х байтовое знаковое число
|
||||
Конвертирует массив байтов в 8-и байтовое знаковое число
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# Модуль core:data_buffer
|
||||
|
||||
## Буффер данных
|
||||
## Буфер данных
|
||||
### Хранит в себе массив байтов и позволяет легко получать или добавлять разные значения
|
||||
|
||||
```lua
|
||||
|
|
@ -11,7 +11,7 @@ function data_buffer(
|
|||
)
|
||||
```
|
||||
Создаёт новый экземпляр **data_buffer**.
|
||||
Если **useBytearray** равен **true**, то байты буффера будут хранится ввиде **Bytearray**. Это может снизить производительность, но также и уменьшить размер буффера в памяти
|
||||
Если **useBytearray** равен **true**, то байты буфера будут храниться в виде **Bytearray**. Это может снизить производительность, но также и уменьшить размер буфера в памяти
|
||||
|
||||
```lua
|
||||
function data_buffer:set_order(order: string)
|
||||
|
|
@ -22,62 +22,62 @@ function data_buffer:set_order(order: string)
|
|||
```lua
|
||||
function data_buffer:put_byte(byte: int)
|
||||
```
|
||||
Записывает байт в буффер
|
||||
Записывает байт в буфер
|
||||
|
||||
```lua
|
||||
function data_buffer:put_bytes(bytes: table|Bytearray)
|
||||
```
|
||||
Записывает байты в буффер
|
||||
Записывает байты в буфер
|
||||
|
||||
```lua
|
||||
function data_buffer:put_string(str: string)
|
||||
```
|
||||
Конвертирует строку в байты и записывает их в буффер
|
||||
Конвертирует строку в байты и записывает их в буфер
|
||||
|
||||
```lua
|
||||
function data_buffer:put_bool(bool: boolean)
|
||||
```
|
||||
Конвертирует булевое значение в байт и записывает его в буффер
|
||||
Конвертирует булевое значение в байт и записывает его в буфер
|
||||
|
||||
```lua
|
||||
function data_buffer:put_float32(float: number)
|
||||
```
|
||||
Конвертирует плавающее число одинарной точности в байты и записывает их в буффер
|
||||
Конвертирует плавающее число одинарной точности в байты и записывает их в буфер
|
||||
|
||||
```lua
|
||||
function data_buffer:put_float64(float: number)
|
||||
```
|
||||
Конвертирует плавающее число двойной точности в байты и записывает их в буффер
|
||||
Конвертирует плавающее число двойной точности в байты и записывает их в буфер
|
||||
|
||||
```lua
|
||||
function data_buffer:put_uint16(int: int)
|
||||
```
|
||||
Конвертирует беззнаковое 2-х байтовое число в байты и записывает их в буффер
|
||||
Конвертирует беззнаковое 2-х байтовое число в байты и записывает их в буфер
|
||||
|
||||
```lua
|
||||
function data_buffer:put_uint32(int: int)
|
||||
```
|
||||
Конвертирует беззнаковое 4-х байтовое число в байты и записывает их в буффер
|
||||
Конвертирует беззнаковое 4-х байтовое число в байты и записывает их в буфер
|
||||
|
||||
```lua
|
||||
function data_buffer:put_sint16(int: int)
|
||||
```
|
||||
Конвертирует знаковое 2-х байтовое число в байты и записывает их в буффер
|
||||
Конвертирует знаковое 2-х байтовое число в байты и записывает их в буфер
|
||||
|
||||
```lua
|
||||
function data_buffer:put_sint32(int: int)
|
||||
```
|
||||
Конвертирует знаковое 4-х байтовое число в байты и записывает их в буффер
|
||||
Конвертирует знаковое 4-х байтовое число в байты и записывает их в буфер
|
||||
|
||||
```lua
|
||||
function data_buffer:put_int64(int: int)
|
||||
```
|
||||
Конвертирует знаковое 8-и байтовое число в байты и записывает их в буффер
|
||||
Конвертирует знаковое 8-и байтовое число в байты и записывает их в буфер
|
||||
|
||||
```lua
|
||||
function data_buffer:put_number(num: number)
|
||||
```
|
||||
Конвертирует любое число в байты и записывает их в буффер;
|
||||
Конвертирует любое число в байты и записывает их в буфер;
|
||||
|
||||
Первый байт это тип значения:
|
||||
```lua
|
||||
|
|
@ -93,7 +93,7 @@ sint32 = 8
|
|||
```lua
|
||||
function data_buffer:get_byte() -> int
|
||||
```
|
||||
Возвращает следующий байт из буффера
|
||||
Возвращает следующий байт из буфера
|
||||
|
||||
```lua
|
||||
function data_buffer:get_bytes(n) -> table|Bytearray
|
||||
|
|
@ -103,47 +103,47 @@ function data_buffer:get_bytes(n) -> table|Bytearray
|
|||
```lua
|
||||
function data_buffer:get_string() -> string
|
||||
```
|
||||
Читает следующую строку из буффера
|
||||
Читает следующую строку из буфера
|
||||
|
||||
```lua
|
||||
function data_buffer:get_bool() -> boolean
|
||||
```
|
||||
Читает следующий логический булев из буффера
|
||||
Читает следующий логический булев из буфера
|
||||
|
||||
```lua
|
||||
function data_buffer:get_float32() -> number
|
||||
```
|
||||
Читает следующее плавающее число одинарной точности из буффера
|
||||
Читает следующее плавающее число одинарной точности из буфера
|
||||
|
||||
```lua
|
||||
function data_buffer:get_float64() -> number
|
||||
```
|
||||
Читает следующее плавающее число двойной точности из буффера
|
||||
Читает следующее плавающее число двойной точности из буфера
|
||||
|
||||
```lua
|
||||
function data_buffer:get_uint16() -> int
|
||||
```
|
||||
Читает следующее 2-х байтовое беззнаковое целое число из буффера
|
||||
Читает следующее 2-х байтовое беззнаковое целое число из буфера
|
||||
|
||||
```lua
|
||||
function data_buffer:get_uint32() -> int
|
||||
```
|
||||
Читает следующее 4-х байтовое беззнаковое целое число из буффера
|
||||
Читает следующее 4-х байтовое беззнаковое целое число из буфера
|
||||
|
||||
```lua
|
||||
function data_buffer:get_sint16() -> int
|
||||
```
|
||||
Читает следующее 2-х байтовое знаковое целое число из буффера
|
||||
Читает следующее 2-х байтовое знаковое целое число из буфера
|
||||
|
||||
```lua
|
||||
function data_buffer:get_sint32() -> int
|
||||
```
|
||||
Читает следующее 4-х байтовое знаковое целое число из буффера
|
||||
Читает следующее 4-х байтовое знаковое целое число из буфера
|
||||
|
||||
```lua
|
||||
function data_buffer:get_int64() -> int
|
||||
```
|
||||
Читает следующее 8-х байтовое знаковое целое число из буффера
|
||||
Читает следующее 8-и байтовое знаковое целое число из буфера
|
||||
|
||||
```lua
|
||||
function data_buffer:get_number() -> number
|
||||
|
|
@ -153,14 +153,14 @@ function data_buffer:get_number() -> number
|
|||
```lua
|
||||
function data_buffer:size() -> int
|
||||
```
|
||||
Возвращает размер буффера
|
||||
Возвращает размер буфера
|
||||
|
||||
```lua
|
||||
function data_buffer:set_position(int: pos)
|
||||
```
|
||||
Устанавливает текущую позицию в буффере
|
||||
Устанавливает текущую позицию в буфере
|
||||
|
||||
```lua
|
||||
function data_buffer:set_bytes(table: bytes)
|
||||
```
|
||||
Устанавливает байты в буффер
|
||||
Устанавливает байты в буфер
|
||||
|
|
|
|||
|
|
@ -61,7 +61,7 @@ function vector2:rot(
|
|||
angle: number->rad,
|
||||
--Вращение вектора относительно осей ("x", "y", "z")
|
||||
axis: str,
|
||||
--Если истина, то угол поворота певеодится автоматический из градусы в радианы
|
||||
--Если истина, то угол поворота переводится автоматически из градусов в радианы
|
||||
convert2deg: bool
|
||||
) -> vec2
|
||||
```
|
||||
|
|
@ -162,7 +162,7 @@ function vector3:rot(
|
|||
angle: number->rad,
|
||||
--Вращение вектора относительно осей ("x", "y", "z")
|
||||
axis: str,
|
||||
--Если истина, то угол поворота певеодится автоматический из градусы в радианы
|
||||
--Если истина, то угол поворота переводится автоматически из градусов в радианы
|
||||
convert2deg: bool
|
||||
) -> vec2
|
||||
```
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# Свойства и методы UI элементов
|
||||
|
||||
Обращение к UI элементов в скриптах произодится через экземпляр Document
|
||||
Обращение к UI элементам в скриптах производится через экземпляр Document
|
||||
(глобальная переменная document) по id, указанному в xml.
|
||||
|
||||
Пример: вывод в консоль свойства pos элемента с id: "worlds-panel":
|
||||
|
|
@ -19,7 +19,7 @@ Id элемента не может быть изменен из скрипта.
|
|||
В таблицах далее будут использоваться сокращенные описания типов, такие как:
|
||||
- vec2 - массив из двух дробных чисел.
|
||||
- ivec2 - массив из двух целых чисел.
|
||||
- rgba - массив из четырех дробных чисел в диапазоне `[0..255]` обозначающий RGBA состовляющие цвета.
|
||||
- rgba - массив из четырех дробных чисел в диапазоне `[0..255]` обозначающий RGBA составляющие цвета.
|
||||
|
||||
Методы элементов, согласно особенностям ООП в Lua вызываются с использованием оператора `:` вместо `.`
|
||||
|
||||
|
|
@ -204,8 +204,8 @@ document["worlds-panel"]:clear()
|
|||
| data:unbind_texture() | отвязывает текстуру от холста |
|
||||
| data:mul(*цвет* или Canvas) | умножает цвет на указанный цвет или холст |
|
||||
| data:add(*цвет* или Canvas) | прибавляет цвет или другой холст к цвету |
|
||||
| data:sub(*цвет* или Canvas) | вычитает цвет или другой холст к цвету |
|
||||
| data:encode(format: str) | кодирует изображение в указанный формат и возращает массив байт |
|
||||
| data:sub(*цвет* или Canvas) | вычитает цвет или другой холст из цвета |
|
||||
| data:encode(format: str) | кодирует изображение в указанный формат и возвращает массив байт |
|
||||
|
||||
Для декодирования массива байт в Canvas используйте статический метод:
|
||||
```lua
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# Пользовательский ввод
|
||||
|
||||
Обработка нажатий клавиш и кнопок мыши обрабатываются через привязки (bindings), которые назначаются в паке, в файле `config/bindings.toml` в формате:
|
||||
Нажатия клавиш и кнопок мыши обрабатываются через привязки (bindings), которые назначаются в паке, в файле `config/bindings.toml` в формате:
|
||||
|
||||
```toml
|
||||
packid.binding.name="inputtype:codename"
|
||||
|
|
@ -25,4 +25,4 @@ packid.binding.name="inputtype:codename"
|
|||
|
||||
## Библиотека input
|
||||
|
||||
См. [библиотека *input*](builtins/libinput.md)
|
||||
См. [библиотеку *input*](builtins/libinput.md)
|
||||
|
|
|
|||
|
|
@ -2,9 +2,9 @@
|
|||
|
||||
Текстовый формат анимации, использующий синтаксис [VCM](vcm.md).
|
||||
|
||||
VCA файл состоит из набора директив, порядок следования которых не влияет на порядок применение трансформаций.
|
||||
VCA файл состоит из набора директив, порядок следования которых не влияет на порядок применения трансформаций.
|
||||
|
||||
Директивы применяются к переданной цели, которая может быть скелетом сущности и камерой.
|
||||
Директивы применяются к переданной цели, которая может быть скелетом сущности или камерой.
|
||||
При использовании скелета, в директиве указывается имя кости через атрибут `bone`:
|
||||
|
||||
```vcd
|
||||
|
|
@ -31,9 +31,9 @@ VCA файл состоит из набора директив, порядок
|
|||
|
||||
## Мета-информация
|
||||
|
||||
Информация о анимации в файле настраивается через директиву `configure`:
|
||||
- `fps` - частота кадров, являющаяся делителем при рассчёте длительности
|
||||
- `frames` - число кадров анимации, являющееся делимым при рассчёте длительности
|
||||
Информация об анимации в файле настраивается через директиву `configure`:
|
||||
- `fps` - частота кадров, являющаяся делителем при расчёте длительности
|
||||
- `frames` - число кадров анимации, являющееся делимым при расчёте длительности
|
||||
- `duration` - явно указанная длительность в секундах (требуется указание fps при наличии ключевых кадров)
|
||||
- `rotation-order` - указывает порядок применения углов Эйлера при вращении (так как порядок директив не учитывается форматом). Примеры: XYZ, ZYX, YZX.
|
||||
|
||||
|
|
@ -55,7 +55,7 @@ VCA файл состоит из набора директив, порядок
|
|||
|
||||
Требуется через атрибут `curve` указать тип кривой:
|
||||
- `const` - значения не интерполируются, сменяясь в момент достижения ключевого кадра
|
||||
- `linear` - ломанная линия, используется линейная интерполяция
|
||||
- `linear` - ломаная линия, используется линейная интерполяция
|
||||
- `bezier` - ключевые кадры кривой Безье с явно указанными левой и правой касательными (lx, ly, rx, ry)
|
||||
|
||||
Ключевые кадры описываются в последующем `{...}` блоке в виде упорядоченных `@key` директив:
|
||||
|
|
@ -67,7 +67,7 @@ VCA файл состоит из набора директив, порядок
|
|||
}
|
||||
```
|
||||
|
||||
Ключевой кадр должен содержать номер кадра `frame` и значенин `value`. Для `bezier` кадров также описываются касательные.
|
||||
Ключевой кадр должен содержать номер кадра `frame` и значение `value`. Для `bezier` кадров также описываются касательные.
|
||||
|
||||
Пример для `curve bezier`:
|
||||
```vcd
|
||||
|
|
|
|||
|
|
@ -23,7 +23,7 @@
|
|||
На данный момент существует три вида примитивов: tri, box и rect, а также, part (описывает часть примитива, такую как, например, сторона куба).
|
||||
|
||||
> [!NOTE]
|
||||
> По-умолчанию текстурные координаты определяются размерами примитивов.
|
||||
> По умолчанию текстурные координаты определяются размерами примитивов.
|
||||
> При размерах более 1.0 результат не определён и может измениться в последующих обновлениях.
|
||||
> Используйте `region` или `region-scale` для ручной настройки.
|
||||
|
||||
|
|
@ -35,16 +35,16 @@
|
|||
|
||||
- `a` - точка A. Пример: `a (0,0,0)`
|
||||
- `b` - точка B. Пример: `b (1,0,0)`
|
||||
- `c` - точка С. Пример: `c (1,1,0)`
|
||||
- `c` - точка C. Пример: `c (1,1,0)`
|
||||
- `uv` - нормализованные текстурные координаты точек (6 чисел, по 2 на точку). Пример: `uv (0,0, 1,0, 1,1)`
|
||||
- `texture` - отображаемая текстура. По-умолчанию: `$0`. Пример: `texture "blocks:sand"`
|
||||
- `texture` - отображаемая текстура. По умолчанию: `$0`. Пример: `texture "blocks:sand"`
|
||||
- `region` - UV регион в границах выбранной текстуры, определяется позициями противоположных углов квадрата нормализованных текстурных координат. Пример: `region (0,0,1,1)`
|
||||
- `region-scale` вектор-множитель для UV региона. Пример: `region-scale (0.5,1)`
|
||||
- `shading` определяет возможность затенения на примитиве. Пример: `shading off`
|
||||
- `normal` переопределяет вектор нормали. Пример: `normal (0,1,0)`
|
||||
- `cull-face` - определяет, какая сторона будет отсечена. Пример: `cull-face front` или `cull-face off` (отлючает отсечение сторон)
|
||||
- `cull-face` - определяет, какая сторона будет отсечена. Пример: `cull-face front` или `cull-face off` (отключает отсечение сторон)
|
||||
|
||||
Текстурные координаты по-умолчанию не зависят от формы из размера, в отличие от других примитивов.
|
||||
Текстурные координаты по умолчанию не зависят от формы и размера, в отличие от других примитивов.
|
||||
|
||||
### Свойства `rect`
|
||||
|
||||
|
|
@ -53,13 +53,13 @@
|
|||
- `from` - точка начала примитива. Пример: `from (0,0.5,0.125)`
|
||||
- `right` - вектор X, также определяющий ширину примитива. Пример: `right (1,0,0)`
|
||||
- `up` - вектор Y, также определяющий высоту примитива. Пример: `up (0,1,0)`
|
||||
- `texture` - отображаемая текстура. По-умолчанию: `$0`. Пример: `texture "blocks:sand"`
|
||||
- `texture` - отображаемая текстура. По умолчанию: `$0`. Пример: `texture "blocks:sand"`
|
||||
- `region` - UV регион в границах выбранной текстуры, определяется позициями противоположных углов. Пример: `region (0,0,1,1)`
|
||||
- `region-scale` - вектор-множитель для автоматически выбранного UV региона. Пример: `region-scale (0.5,1)`
|
||||
- `shading` - определяет возможность затенения на примитиве. Пример: `shading off`
|
||||
- `flip` - отражает UV регион по горизонтали или вертикали. Пример: `flip v`
|
||||
- `normal` - переопределяет вектор нормали. Пример: `normal (0,1,0)`
|
||||
- `cull-face` - определяет, какая сторона будет отсечена. Пример: `cull-face front` или `cull-face off` (отлючает отсечение сторон)
|
||||
- `cull-face` - определяет, какая сторона будет отсечена. Пример: `cull-face front` или `cull-face off` (отключает отсечение сторон)
|
||||
|
||||
### Свойства `box`
|
||||
|
||||
|
|
@ -67,9 +67,9 @@
|
|||
|
||||
- `from` - точка начала примитива. Пример: `from (0,0,0)`
|
||||
- `to` - противоположная от начала точка. Пример: `to (1,1,1)`
|
||||
- `origin` - точка, относительно которой будет применено вращение. По-умолчанию: центр примитива. Пример: `origin (0.5,0.5,0.5)`
|
||||
- `origin` - точка, относительно которой будет применено вращение. По умолчанию: центр примитива. Пример: `origin (0.5,0.5,0.5)`
|
||||
- `rotate` - вращение вокруг осей (x,y,z) в градусах, или кватернион (x,y,z,w). Пример: `rotate (45,0,0)` или `rotate (0.3826834, 0, 0, 0.9238795)`
|
||||
- `texture` - отображаемая текстура для всех сторон по-умолчанию.
|
||||
- `texture` - отображаемая текстура для всех сторон по умолчанию.
|
||||
- `shading` - определяет возможность затенения на примитиве. Пример: `shading off`
|
||||
- `delete` - удаляет стороны по именам (top, bottom, east, west, north, south)
|
||||
|
||||
|
|
@ -77,8 +77,8 @@
|
|||
|
||||
Примитив описывает свойства сторон прямоугольного параллелепипеда с указанными тегами (top/bottom/north/south/east/west).
|
||||
|
||||
- `tags` - определяет то, на какаие из сторон будут применены свойства. Пример: `tags (top,bottom)`
|
||||
- `texture` - отображаемая текстура. По-умолчанию: `$индекс_стороны`.
|
||||
- `tags` - определяет то, на какие из сторон будут применены свойства. Пример: `tags (top,bottom)`
|
||||
- `texture` - отображаемая текстура. По умолчанию: `$индекс_стороны`.
|
||||
- `region` - UV регион в границах выбранной текстуры, определяется позициями противоположных углов. Пример: `region (0,0,1,1)`
|
||||
- `region-scale` - вектор-множитель для автоматически выбранного UV региона. Пример: `region-scale (0.5,1)`
|
||||
|
||||
|
|
@ -87,12 +87,12 @@
|
|||
VCM позволяет описывать [скелет](rigging.md) модели. Для этого используется элемент `@bone` (кость).
|
||||
|
||||
Существует два вида костей:
|
||||
- безымянные - используются только для трансформаций на влюженные примитивы, не попадает в итоговый скелет.
|
||||
- именованные - будет включено в итоговый скелет. Имя указывается через атрибут `name`.
|
||||
- безымянные - используются только для трансформаций на вложенные примитивы, не попадают в итоговый скелет.
|
||||
- именованные - будут включены в итоговый скелет. Имя указывается через атрибут `name`.
|
||||
|
||||
Главная кость (`root`) создаётся автоматически для всей модели.
|
||||
При наличии явно указанных костей модель будет разделена на несколько частей именованных в формате `имя_модели.имя_кости`.
|
||||
Так как модель относится к ассетам и не имеет префикса, загруженный скелет получает имя модели, так же, без префикса.
|
||||
Так как модель относится к ассетам и не имеет префикса, загруженный скелет получает имя модели, также без префикса.
|
||||
Загруженный скелет можно использовать у [сущности](entity-properties.md#имя-скелета---skeleton-name) через свойство `skeleton-name`.
|
||||
|
||||
В списке `пак/preload.json` при указании параметра `"squash": true` vcm будет загружен как единая модель, без скелета.
|
||||
|
|
|
|||
|
|
@ -34,7 +34,7 @@
|
|||
Понятия используемые далее по тексту.
|
||||
|
||||
- **Комбинируемый массив/объект** - TOML или JSON файл, который комбинируется из нескольких версий в разных паках, что позволяет добавлять в него данные извне. Поля комбинированного объекта перезаписываются в порядке от первого к последнему, так же, как и другие ресурсы в паках. В случае комбинируемого массива, проверка на дубликаты **не** выполняется.
|
||||
- **Биом** - информация, определяющая то, из каких блоков и какими слоями генерируется ландшафт, а так же набор растений, структур.
|
||||
- **Биом** - информация, определяющая то, из каких блоков и какими слоями генерируется ландшафт, а также набор растений, структур.
|
||||
- **Растение** - случайно расставляемый на поверхности блок.
|
||||
- **Малая структура** - структура, размер которой не превышает размера чанка. Пример: деревья.
|
||||
|
||||
|
|
@ -47,12 +47,12 @@
|
|||
- fragments - директория в которой располагаются файлы фрагментов
|
||||
|
||||
Основные свойства, описываемые в файле конфигурации:
|
||||
- **caption** - отображаемое имя генератора. По-умолчанию генерируется из id.
|
||||
- **biome-parameters** - количество параметров выбора биомов (от 0 до 4). По-умолчанию: 0.
|
||||
- **sea-level** - уровень моря (ниже этого уровня вместо воздуха будут генерироваться слои моря (sea-layers)). По-умолчанию: 0.
|
||||
- **biomes-bpd** - количество блоков на точку карты параметра выбора биомов. По-умолчанию: 4.
|
||||
- **heights-bpd** - количество блоков на точку карты высот. По-умолчанию: 4.
|
||||
- **wide-structs-chunks-radius** - масимальный радиус размещения 'широких' структур, измеряемый в чанках.
|
||||
- **caption** - отображаемое имя генератора. По умолчанию генерируется из id.
|
||||
- **biome-parameters** - количество параметров выбора биомов (от 0 до 4). По умолчанию: 0.
|
||||
- **sea-level** - уровень моря (ниже этого уровня вместо воздуха будут генерироваться слои моря (sea-layers)). По умолчанию: 0.
|
||||
- **biomes-bpd** - количество блоков на точку карты параметра выбора биомов. По умолчанию: 4.
|
||||
- **heights-bpd** - количество блоков на точку карты высот. По умолчанию: 4.
|
||||
- **wide-structs-chunks-radius** - максимальный радиус размещения 'широких' структур, измеряемый в чанках.
|
||||
- **heightmap-inputs** - массив номеров карт параметров, которые будут переданы таблицей inputs в функцию генерации карты высот.
|
||||
- **player-spawn-radius** - радиус зоны спавна игроков.
|
||||
- **player-min-spawn-height**, **player-max-spawn-height** - указание **предпочтительной** вертикальной зоны спавна.
|
||||
|
|
@ -68,7 +68,7 @@
|
|||
|
||||
## Фрагменты
|
||||
|
||||
Фрагмент является сохраненной для дальнейшего использования, областью мира, как и чанк, ограниченную некоторой шириной, высотой и длиной. Фрагмент может содержать данные не только о блоках, попадающих в область, но и о инвентарях блоков области, а так же сущностях. В отличие от чанка, размер фрагмента произволен.
|
||||
Фрагмент является сохраненной для дальнейшего использования, областью мира, как и чанк, ограниченной некоторой шириной, высотой и длиной. Фрагмент может содержать данные не только о блоках, попадающих в область, но и об инвентарях блоков области, а также о сущностях. В отличие от чанка, размер фрагмента произволен.
|
||||
|
||||
На данный момент, фрагмент может быть создан при помощи команды `fragment.save`, либо через функцию `generation.create_fragment`.
|
||||
|
||||
|
|
@ -93,7 +93,7 @@ coal_ore0 = {}
|
|||
|
||||
## Биомы
|
||||
|
||||
Биом определяет то, из каких блоков и какими слоями генерируется ландшафт, а так же набор растений, структур.
|
||||
Биом определяет то, из каких блоков и какими слоями генерируется ландшафт, а также набор растений, структур.
|
||||
|
||||
Биомы объявляются в комбинируемом объекте:
|
||||
`generators/имя_генератора.files/biomes.toml`
|
||||
|
|
@ -149,7 +149,7 @@ structures = [
|
|||
|
||||
Параметр генератора `biome-parameters` определяет количество параметров биомов, используемых при их выборе (примеры: температура, влажность).
|
||||
|
||||
Карты значений параметров биомов генеруются так же, как и карты высот.
|
||||
Карты значений параметров биомов генерируются так же, как и карты высот.
|
||||
|
||||
Требуется реализовать функцию:
|
||||
```lua
|
||||
|
|
@ -275,7 +275,7 @@ map:mixin(value: Heightmap|number, t: Heightmap|number)
|
|||
|
||||
### heightmap:dump(...)
|
||||
|
||||
Метод используемый для отладки, создает изображение на основе карты высот переводя значения из дипазона `[-1.0, 1.0]` в значения яркости `[0, 255]`, сохраняя в указанный файл.
|
||||
Метод используемый для отладки, создает изображение на основе карты высот переводя значения из диапазона `[-1.0, 1.0]` в значения яркости `[0, 255]`, сохраняя в указанный файл.
|
||||
|
||||
```lua
|
||||
map:dump('export:test.png')
|
||||
|
|
@ -287,11 +287,11 @@ map:dump('export:test.png')
|
|||
|
||||
Зерно шума может быть указано в поле `map.noiseSeed`.
|
||||
|
||||
По-умолчанию октавы шума совмещаются через сложение:
|
||||
По умолчанию октавы шума совмещаются через сложение:
|
||||
|
||||
$шум_{результат} = шум_{исходный} + шум_{применяемый} * 2^{-{октава}}$
|
||||
|
||||
Для более получения нормализованного многооктавного шума можно включить флаг `map.normalNoise = true`, меняющий схему на:
|
||||
Для получения более нормализованного многооктавного шума можно включить флаг `map.normalNoise = true`, меняющий схему на:
|
||||
|
||||
$шум_{результат} = шум_{исходный} * (1 - 2^{-{октава}}) + шум_{применяемый} * 2^{-{октава}}$
|
||||
|
||||
|
|
@ -299,11 +299,11 @@ $шум_{результат} = шум_{исходный} * (1 - 2^{-{октав
|
|||
map:noise(
|
||||
-- смещение координат
|
||||
offset: {number, number},
|
||||
-- коэфициент масштабирования координат
|
||||
-- коэффициент масштабирования координат
|
||||
scale: number,
|
||||
-- число октав шума (по-умолчанию: 1)
|
||||
-- число октав шума (по умолчанию: 1)
|
||||
[опционально] octaves: int,
|
||||
-- множитель амплитуды шума (по-умолчанию: 1.0)
|
||||
-- множитель амплитуды шума (по умолчанию: 1.0)
|
||||
[опционально] multiplier: number,
|
||||
-- карта смещений координаты X при генерации шума
|
||||
[опционально] shiftMapX: Heightmap,
|
||||
|
|
@ -355,7 +355,7 @@ map:crop(x, y, ширина, высота)
|
|||
map:at(x, y) -> number
|
||||
```
|
||||
|
||||
Возвращает значение высота на заданной позиции.
|
||||
Возвращает значение высоты на заданной позиции.
|
||||
|
||||
## VoxelFragment (фрагмент)
|
||||
|
||||
|
|
@ -403,7 +403,7 @@ fragment:place(position: vec3, [опционально] rotation:int=0)
|
|||
|
||||
## Генерация карты высот
|
||||
|
||||
По-умолчанию, движок генерирует карту высот, состоящую из нулей.
|
||||
По умолчанию, движок генерирует карту высот, состоящую из нулей.
|
||||
|
||||
Для генерации пользовательских карт высот требуется реализовать функцию:
|
||||
```lua
|
||||
|
|
@ -446,10 +446,10 @@ end
|
|||
```
|
||||
|
||||
Где:
|
||||
- имя_структуры - строка содержащая имя структуры, зарегистрированная в structures.toml.
|
||||
- имя_структуры - строка содержащая имя структуры, зарегистрированной в structures.toml.
|
||||
- позиция_структуры - vec3 (массив из трех чисел).
|
||||
- поворот - число от 0 до 3 обозначающая поворот структуры по оси Y.
|
||||
- приоритет - число определяющее порядок установки структур. Структуры с меньшем приоритетом перекрываются структурами с большим.
|
||||
- поворот - число от 0 до 3, обозначающее поворот структуры по оси Y.
|
||||
- приоритет - число определяющее порядок установки структур. Структуры с меньшим приоритетом перекрываются структурами с большим.
|
||||
|
||||
Тоннель:
|
||||
```lua
|
||||
|
|
@ -523,7 +523,7 @@ function place_structures_wide(
|
|||
|
||||
## Структурный воздух
|
||||
|
||||
`core:struct_air` - блок, которые следует использовать в фрагментах для обозначения пустого пространства, которое не должно заполняться блоками при генерации в мире.
|
||||
`core:struct_air` - блок, который следует использовать во фрагментах для обозначения пустого пространства, которое не должно заполняться блоками при генерации в мире.
|
||||
|
||||
<image src="../../res/textures/blocks/struct_air.png" width="128px" height="128px" style="image-rendering: pixelated">
|
||||
|
||||
|
|
|
|||
|
|
@ -10,12 +10,12 @@
|
|||
- `"0.4,53.01"`
|
||||
- `"0,0"`
|
||||
|
||||
**3D вектор** - три числа, разделенная запятой.
|
||||
**3D вектор** - три числа, разделенные запятой.
|
||||
Примеры:
|
||||
- `"60,30,53"`
|
||||
- `"0.4,0.1,0.753"`
|
||||
|
||||
**4D вектор** - четыре числа, разделенная запятой.
|
||||
**4D вектор** - четыре числа, разделенные запятой.
|
||||
Примеры:
|
||||
- `"10,5,10,3"`
|
||||
- `"0.1,0.5,0.0,0.0"`
|
||||
|
|
@ -47,7 +47,7 @@
|
|||
- `onmiddleclick` - lua функция вызываемая при нажатии средней кнопки мыши на элемент.
|
||||
- `ondoubleclick` - lua функция вызываемая при двойном нажатии на элемент.
|
||||
- `onfocus` - lua функция вызываемая при фокусировке на элемент.
|
||||
- `ondefocus` - lua функция вызываемая при потере фокуса элеметом.
|
||||
- `ondefocus` - lua функция вызываемая при потере фокуса элементом.
|
||||
- `onmouseenter` - lua функция вызываемая при входе курсора в элемент.
|
||||
- `onmouseleave` - lua функция вызываемая при выходе курсора из элемента.
|
||||
- `onmouseover` - lua функция вызываемая при наведении курсора на элемент.
|
||||
|
|
@ -117,7 +117,7 @@
|
|||
- `text-align` - выравнивание текста ("left", "center" или "right"). Тип: строка.
|
||||
- `valign` - вертикальное выравнивание текста: top/center/bottom
|
||||
- `supplier` - поставщик текста (вызывается каждый кадр)
|
||||
- `autoresize` - автоматическое изменение размера элемента (по-умолчанию - false). Не влияет на размер шрифта.
|
||||
- `autoresize` - автоматическое изменение размера элемента (по умолчанию - false). Не влияет на размер шрифта.
|
||||
- `multiline` - разрешает отображение многострочного текста.
|
||||
- `text-wrap` - разрешает автоматический перенос текста (работает только при multiline: "true")
|
||||
- `markup` - язык разметки текста ("md" - Markdown).
|
||||
|
|
@ -144,7 +144,7 @@
|
|||
- `sub-consumer` - lua функция-приемник вводимого текста. Вызывается во время ввода или удаления текста.
|
||||
- `oncontrolkey` - lua функция вызываемая для сочетаний вида (Ctrl + ?). На вход подаётся числовой код второй клавиши.
|
||||
Код клавиши для сравнения можно получить через `input.keycode("имя_клавиши")`
|
||||
- `autoresize` - автоматическое изменение размера элемента (по-умолчанию - false). Не влияет на размер шрифта.
|
||||
- `autoresize` - автоматическое изменение размера элемента (по умолчанию - false). Не влияет на размер шрифта.
|
||||
- `multiline` - разрешает отображение многострочного текста.
|
||||
- `text-wrap` - разрешает автоматический перенос текста (работает только при multiline: "true")
|
||||
- `editable`- определяет возможность редактирования текста.
|
||||
|
|
@ -155,21 +155,21 @@
|
|||
- `validator` - lua функция, проверяющая текст на корректность. Принимает на вход строку, возвращает true если текст корректен.
|
||||
- `onup` - lua функция вызываемая при нажатии стрелки вверх.
|
||||
- `ondown` - lua функция вызываемая при нажатии стрелки вниз.
|
||||
- `syntax` - подстветка синтаксиса ("lua" - Lua).
|
||||
- `syntax` - подсветка синтаксиса ("lua" - Lua).
|
||||
- `markup` - язык разметки текста ("md" - Markdown).
|
||||
|
||||
## Ползунок - *trackbar*
|
||||
|
||||
- `min` - минимальное значение. Тип: число. По-умолчанию: 0
|
||||
- `max` - максимальное значение. Тип: число. По-умолчанию: 1
|
||||
- `value` - изначальное значение. Тип: число. По-умолчанию: 0
|
||||
- `step` - размер деления ползунка. Тип: число. По-умолчанию: 1
|
||||
- `track-width` - ширина указателя (в пикселях). Тип: число. По-умолчанию: 12
|
||||
- `min` - минимальное значение. Тип: число. По умолчанию: 0
|
||||
- `max` - максимальное значение. Тип: число. По умолчанию: 1
|
||||
- `value` - изначальное значение. Тип: число. По умолчанию: 0
|
||||
- `step` - размер деления ползунка. Тип: число. По умолчанию: 1
|
||||
- `track-width` - ширина указателя (в пикселях). Тип: число. По умолчанию: 12
|
||||
- `track-color` - цвет указателя при наведении курсора. Тип: RGBA цвет.
|
||||
- `consumer` - lua функция-приемник установленного значения
|
||||
- `sub-consumer` - lua функция-приемник промежуточных значений (используйте для обновления текста при `change-on-release="true"`)
|
||||
- `supplier` - lua функция-поставщик значения
|
||||
- `change-on-release` - Вызов функции-приемника (consumer) происходит только тогда, когда пользователь отпускает указатель. Тип: логический. По-умолчанию: false
|
||||
- `change-on-release` - Вызов функции-приемника (consumer) происходит только тогда, когда пользователь отпускает указатель. Тип: логический. По умолчанию: false
|
||||
|
||||
## Рамка встраивания - *iframe*
|
||||
|
||||
|
|
@ -192,11 +192,11 @@
|
|||
</select>
|
||||
```
|
||||
|
||||
- `width` - минимальная ширина содержимого. По-умолчанию: 100.
|
||||
- `selected` - изначально выбранное значение. По-умолчанию: "".
|
||||
- `width` - минимальная ширина содержимого. По умолчанию: 100.
|
||||
- `selected` - изначально выбранное значение. По умолчанию: "".
|
||||
- `onselect` - функция, в которую передаётся выбранное пользователем значение
|
||||
- `mode` - режим работы:
|
||||
- `select` - режим по-умолчанию.
|
||||
- `select` - режим по умолчанию.
|
||||
- `button` - режим кнопки: текст не заменяется на выбранную опцию, а элемент выглядит как обычная кнопка.
|
||||
|
||||
## Привязка ввода - *bindbox*
|
||||
|
|
@ -205,7 +205,7 @@
|
|||
|
||||
- `font` - имя шрифта. Тип: строка.
|
||||
- `binding` - имя привязки. Тип: строка.
|
||||
- `padding` - отступ между текстом и границами элемента. Тип: число. По-умолчанию: 6
|
||||
- `padding` - отступ между текстом и границами элемента. Тип: число. По умолчанию: 6
|
||||
|
||||
# Элементы инвентаря
|
||||
|
||||
|
|
@ -217,7 +217,7 @@
|
|||
> Расположение инвентарей управляется движком и не может быть изменено свойствами pos, margin и т.д.
|
||||
|
||||
> [!WARNING]
|
||||
> Слоты без привязки к инвентарю не будут отображаться. Под приязкой к инвентарю понимается связь UI элемента inventory с инвентарём по id. Которая может быть явно создана через `inventory_ui.inventory = inventory_id`. [(см ui.md)](scripting/ui.md#инвентарь-inventory)
|
||||
> Слоты без привязки к инвентарю не будут отображаться. Под привязкой к инвентарю понимается связь UI элемента inventory с инвентарём по id. Которая может быть явно создана через `inventory_ui.inventory = inventory_id`. [(см ui.md)](scripting/ui.md#инвентарь-inventory)
|
||||
|
||||
## Одиночный слот - *slot*
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue