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