fix docs typos and other trash

This commit is contained in:
MihailRis 2026-10-16 00:20:25 +03:00
parent 9744407599
commit ef61e28f50
88 changed files with 359 additions and 358 deletions

View file

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

View file

@ -51,7 +51,7 @@ assets.parse_animation(
-- Создаёт холст (Canvas) из загруженной текстуры
assets.to_canvas(
-- Имя загруженной текстуры.
-- Поддерживается как отдельные ("имя_текстуры"),
-- Поддерживаются как отдельные ("имя_текстуры"),
-- так и находящиеся в атласе ("атлас:имя_текстуры").
name: string
) -> Canvas

View file

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

View file

@ -24,7 +24,7 @@ byteutil.tpack(format: string, ...) -> table
Символы значений описывают тип и размер.
| Символ | Аналог в С++ | Тип Lua | Размер |
| Символ | Аналог в C++ | Тип Lua | Размер |
| --------- | --------------- | -------- | ------- |
| `b` | int8_t | number | 1 байт |
| `B` | uint8_t | number | 1 байт |

View file

@ -29,7 +29,7 @@ cam:get_pos() -> vec3
-- устанавливает позицию камеры
cam:set_pos(pos: vec3)
-- возращает вращение камеры
-- возвращает вращение камеры
cam:get_rot() -> mat4
-- устанавливает вращение камеры
cam:set_rot(rot: mat4)

View file

@ -1,6 +1,6 @@
# Библиотека *compression*
Библиотека функций для работы сжатия/разжатия массивов байт
Библиотека функций для сжатия/разжатия массивов байт
```lua
-- Сжимает массив байт.

View file

@ -1,8 +1,8 @@
# Библиотека *ctypes*
Библиотека для безопасной работы с типами языка С.
Библиотека для безопасной работы с типами языка C.
| ctypes.\<name\> | С-тип | Минимум | Максимум |
| ctypes.\<name\> | C-тип | Минимум | Максимум |
| ------------- | -------- | -------------------- | -------------------- |
| uint8 | uint8_t | 0 | 255 |
| uint16 | uint16_t | 0 | 65535 |

View file

@ -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 даст некорректные результаты, так как возвращаемая таблица не является массивом.

View file

@ -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
-- Размонтирует точку входа.

View file

@ -33,7 +33,7 @@ skeleton:get_texture(key: string) -> string
-- Назначает текстуру по ключу
skeleton:set_texture(key: string, value: string)
-- Проверяет статус видимости кости по индесу
-- Проверяет статус видимости кости по индексу
-- или всего скелета, если индекс не указан
skeleton:is_visible([опционально] index: int) -> boolean

View file

@ -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 | Таблица настроек частиц всплесков от осадков | {} |

View file

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

View file

@ -20,7 +20,7 @@ hud.open(
[опционально] invid: int
) -> int
-- Возвращает true если указаный макет UI открыт.
-- Возвращает true если указанный макет UI открыт.
hud.is_open(
layoutid: string
) -> boolean

View file

@ -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}
-- Возвращает вертикальное смещение колеса мыши, накопленное за текущий кадр.

View file

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

View file

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

View file

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

View file

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

View file

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

View file

@ -2,7 +2,7 @@
Библиотека для работы с кватернионами.
Кватернионы задаюся таблицей, состоящей из 4 компонентов:
Кватернионы задаются таблицей, состоящей из 4 компонентов:
`{w, x, y, z}`
## Кватернион из матрицы - *quat.from_mat4(...)*

View file

@ -1,6 +1,6 @@
# Библиотека *random*
Библиотека функций для генерации случайный чисел.
Библиотека функций для генерации случайных чисел.
## Недетерминированные числа

View file

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

View file

@ -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
-- Переводит строку в нижний регистр

View file

@ -18,7 +18,7 @@
> [!WARNING]
>
> Аннотации типов являются частью документации и не указываются при вызове использовании.
> Аннотации типов являются частью документации и не указываются при вызове.
## Операции с векторами

View file

@ -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,
-- сжатые данные чанка

View file

@ -2,7 +2,7 @@
*Bytearray* - динамический байтовый массив, реализованный через LuaJIT FFI. По нему можно итерироваться стандартными функциями **pairs** и **ipairs**
<small>Примечание касаемо условных обозначений в документации: псведотип `posint` означает натуральное (положительное ненулевое целое) число.</small>
<small>Примечание касаемо условных обозначений в документации: псевдотип `posint` означает натуральное (положительное ненулевое целое) число.</small>
## Основное
### Создание массива

View file

@ -2,7 +2,7 @@
## *core:pathfinding*
Компонент для построение путей движения мобов.
Компонент для построения путей движения мобов.
```lua
local pathfinding = entity:require_component("core:pathfinding")

View file

@ -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]
> При выходе сущности за пределы зоны прогрузки она удаляется, вызывая события.

View file

@ -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:`.

View file

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

View file

@ -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}/...` возможна потеря данных при перезаписи мира.

View file

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

View file

@ -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-и байтовое знаковое число

View file

@ -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)
```
Устанавливает байты в буффер
Устанавливает байты в буфер

View file

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

View file

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

View file

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