mirror of
https://github.com/MihailRis/voxelcore.git
synced 2026-10-08 04:21:50 +00:00
Merge branch 'main' into blocks-renderer-and-generator-update-review
This commit is contained in:
MihailRis
commit
1772f0b58c
131 changed files with 2202 additions and 489 deletions
|
|
@ -14,7 +14,7 @@
|
|||
Для создания команды консоли используется следующая функция:
|
||||
|
||||
```python
|
||||
console.add_command(схема: str, исполнитель: function)
|
||||
console.add_command(схема: str, исполнитель: function, чит_команда: bool)
|
||||
```
|
||||
|
||||
Схема имеет следующий синтаксис:
|
||||
|
|
@ -106,7 +106,7 @@ console.add_command(
|
|||
"Teleport object",
|
||||
function (args, kwargs)
|
||||
player.set_pos(unpack(args))
|
||||
end
|
||||
end, true
|
||||
)
|
||||
```
|
||||
|
||||
|
|
@ -114,3 +114,23 @@ console.add_command(
|
|||
- В kwargs передается таблица значений именованных аргументов.
|
||||
|
||||
Проверку и приведение типов интерпретатор команд производит автоматически.
|
||||
|
||||
## Остальные методы
|
||||
|
||||
```lua
|
||||
console.set_cheat(name: String, cheat: Boolean) -> cheatIsChanged: Boolean
|
||||
console.is_cheat(name: String) -> Boolean
|
||||
```
|
||||
Сеттер и геттер статуса "чит" команды
|
||||
|
||||
|
||||
```lua
|
||||
console.log(...) -- Выводит информацию во внутриигровую консоль
|
||||
console.chat(...) -- Выводит информацию во внутриигровой чат
|
||||
console.get_commands_list() -> Table<String> -- Возвращает таблицу со списком команд
|
||||
console.get_command_info(name: String) -> Table -- Возвращает информацию о команде
|
||||
console.execute(command: str) -- Выполняет команду
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,8 +1,9 @@
|
|||
# Документация
|
||||
|
||||
Документация версии 0.30 (в разработке).
|
||||
Документация версии 0.30.
|
||||
|
||||
[Документация 0.29.](https://github.com/MihailRis/voxelcore/blob/release-0.29/doc/ru/main-page.md)
|
||||
> [!WARNING]
|
||||
> Версия находится в разработке. Перейдите к [документации для 0.28](https://github.com/MihailRis/voxelcore/blob/release-0.29/doc/ru/main-page.md)
|
||||
|
||||
## Разделы
|
||||
|
||||
|
|
|
|||
|
|
@ -159,3 +159,35 @@ app.get_setting_info(name: str) -> {
|
|||
```
|
||||
|
||||
Возвращает таблицу с информацией о настройке. Бросает исключение, если настройки не существует.
|
||||
|
||||
```lua
|
||||
app.focus()
|
||||
```
|
||||
|
||||
Переводит окно на передний план и устанавливает фокус ввода.
|
||||
|
||||
app.create_memory_device(
|
||||
-- имя точки входа
|
||||
name: str
|
||||
)
|
||||
```
|
||||
|
||||
Создаёт файловую систему в памяти.
|
||||
|
||||
```lua
|
||||
app.get_content_sources() -> table<string>
|
||||
```
|
||||
|
||||
Возвращает список источников контента (путей), в порядке убывания приоритета.
|
||||
|
||||
```lua
|
||||
app.set_content_sources(sources: table<string>)
|
||||
```
|
||||
|
||||
Устанавливает список источников контента (путей). Указывается в порядке убывания приоритета.
|
||||
|
||||
```lua
|
||||
app.reset_content_sources()
|
||||
```
|
||||
|
||||
Сбрасывает список источников контента.
|
||||
|
|
|
|||
|
|
@ -139,6 +139,12 @@ file.create_zip(директория: str, выходной_файл: str) --> s
|
|||
|
||||
Создаёт ZIP-архив из содержимого указанной директории.
|
||||
|
||||
```lua
|
||||
file.create_memory_device() --> str
|
||||
```
|
||||
|
||||
Создаёт файловую систему в памяти, возвращает имя точки входа. Удаляется при выгрузке контента.
|
||||
|
||||
```lua
|
||||
file.name(путь: str) --> str
|
||||
```
|
||||
|
|
|
|||
|
|
@ -13,7 +13,16 @@ input.mousecode(mousename: str) --> int
|
|||
Возвращает код кнопки мыши по имени, либо -1
|
||||
|
||||
```lua
|
||||
input.add_callback(bindname: str, callback: function)
|
||||
input.add_callback(
|
||||
-- Имя привязки
|
||||
bindname: str,
|
||||
-- Обработчик
|
||||
callback: function
|
||||
-- UI элемент-владелец обработчика (отвечает за срок жизни)
|
||||
[опционально] owner: Element,
|
||||
-- Игнорировать захват ввода UI элементами
|
||||
[опционально] istoplevel: bool
|
||||
)
|
||||
```
|
||||
|
||||
Назначает функцию, которая будет вызываться при активации привязки. Пример:
|
||||
|
|
|
|||
|
|
@ -58,6 +58,9 @@ network.tcp_connect(
|
|||
-- До подключения отправка работать не будет
|
||||
-- Как единственный аргумент передаётся сокет
|
||||
callback: function(Socket)
|
||||
-- Функция, вызываемая при ошибке подключения
|
||||
-- Как аргументы передаются сокет и текст ошибки
|
||||
[опционально] error_callback: function(Socket, str)
|
||||
) --> Socket
|
||||
```
|
||||
|
||||
|
|
@ -79,6 +82,16 @@ socket:recv(
|
|||
-- В случае ошибки возвращает nil (сокет закрыт или несуществует).
|
||||
-- Если данных пока нет, возвращает пустой массив байт.
|
||||
|
||||
-- Асинхронный вариант для использования в корутинах.
|
||||
-- Ожидает получение всего указанного числа байт.
|
||||
-- При закрытии сокета работает как socket:recv
|
||||
socket:recv_async(
|
||||
-- Размер читаемого массива байт
|
||||
length: int,
|
||||
-- Использовать таблицу вместо Bytearray
|
||||
[опционально] usetable: bool=false
|
||||
) -> nil|table|Bytearray
|
||||
|
||||
-- Закрывает соединение
|
||||
socket:close()
|
||||
|
||||
|
|
@ -194,3 +207,10 @@ network.get_total_upload() --> int
|
|||
-- в байтах.
|
||||
network.get_total_download() --> int
|
||||
```
|
||||
|
||||
## Другое
|
||||
|
||||
```lua
|
||||
-- Ищет свободный для использования порт.
|
||||
network.find_free_port() --> int или nil
|
||||
```
|
||||
|
|
|
|||
|
|
@ -40,13 +40,13 @@ player.set_vel(playerid: int, x: number, y: number, z: number)
|
|||
player.get_rot(playerid: int, interpolated: bool=false) -> number, number, number
|
||||
```
|
||||
|
||||
Возвращает x, y, z вращения камеры (в радианах). Интерполяция актуальна в случаях, когда частота обновления вращения ниже частоты кадров.
|
||||
Возвращает x, y, z вращения камеры (в градусах). Интерполяция актуальна в случаях, когда частота обновления вращения ниже частоты кадров.
|
||||
|
||||
```lua
|
||||
player.set_rot(playerid: int, x: number, y: number, z: number)
|
||||
```
|
||||
|
||||
Устанавливает x, y вращения камеры (в радианах)
|
||||
Устанавливает x, y вращения камеры (в градусах)
|
||||
|
||||
```lua
|
||||
player.get_inventory(playerid: int) -> int, int
|
||||
|
|
|
|||
|
|
@ -4,6 +4,10 @@
|
|||
|
||||
Функции для обработки событий, прописываемые в скрипте блока.
|
||||
|
||||
> [!WARNING]
|
||||
> Mass events such as on_block_tick, on_block_present, and on_block_removed,
|
||||
> if used carelessly or excessively, can lead to performance issues.
|
||||
|
||||
```lua
|
||||
function on_placed(x, y, z, playerid)
|
||||
```
|
||||
|
|
@ -53,6 +57,21 @@ function on_block_tick(x, y, z, tps: number)
|
|||
Вызывается tps (20 / tick-interval) раз в секунду для конкретного блока.
|
||||
Используйте 1/tps вместо `time.delta()`.
|
||||
|
||||
```lua
|
||||
function on_block_present(x, y, z)
|
||||
```
|
||||
|
||||
Вызывается для конкретного блока при появлении (генерации/загрузке/размещении).
|
||||
Вызов происходит в течение времени, которое может зависеть от нагрузки очереди событий.
|
||||
При малой нагрузке происходит в течение первого такта блока (tick-interval).
|
||||
До вызова события on_block_tick не вызывается.
|
||||
|
||||
```lua
|
||||
function on_block_removed(x, y, z)
|
||||
```
|
||||
|
||||
Вызывается при выгрузке чанка, в котором находится блок.
|
||||
|
||||
```lua
|
||||
function on_player_tick(playerid: int, tps: int)
|
||||
```
|
||||
|
|
|
|||
|
|
@ -94,6 +94,13 @@ table.sub(arr: table, start: number | nil, stop: number | nil) -> table
|
|||
|
||||
Возвращает обрезанную версию таблицы с индекса **start** до индекса **stop** включительно, при этом пары ключ-значение не сохраняются в новой таблице. При значениях **nil** начинает с **1** и заканчивает **#arr** соответственно.
|
||||
|
||||
```lua
|
||||
table.insert_unique(t: table, val: any)
|
||||
table.insert_unique(t: table, pos: number, val: any)
|
||||
```
|
||||
|
||||
Добавляет значение в таблицу, только если его там не было.
|
||||
|
||||
```lua
|
||||
table.tostring(t: table) -> string
|
||||
```
|
||||
|
|
|
|||
|
|
@ -186,21 +186,31 @@ document["worlds-panel"]:clear()
|
|||
- r: int, g: int, b: int
|
||||
- r: int, g: int, b: int, a: int
|
||||
|
||||
| Метод | Описание |
|
||||
|----------------------------------------------------------|------------------------------------------------------|
|
||||
| data:at(x: int, y: int) | возвращает RGBA пиксель по указанным координатам |
|
||||
| data:set(x: int, y: int, *цвет*) | изменяет RGBA пиксель по указанным координатам |
|
||||
| data:line(x1: int, y1: int, x2: int, y2: int, *цвет*) | рисует линию с указанным RGBA цветом |
|
||||
| data:blit(src: Canvas, dst_x: int, dst_y: int) | рисует src-холст на указанных координатах |
|
||||
| data:clear() | очищает холст |
|
||||
| data:clear(*цвет*) | заполняет холст указанным RGBA цветом |
|
||||
| data:update() | применяет изменения и загружает холст в видеопамять |
|
||||
| data:set_data(data: table<int>) | заменяет данные пикселей (ширина * высота * 4 чисел) |
|
||||
| data:create_texture(name: str) | создаёт и делится текстурой с рендерером |
|
||||
| data:unbind_texture() | отвязывает текстуру от холста |
|
||||
| data:mul(*цвет* или Canvas) | умножает увет на указанный цвет или холст |
|
||||
| data:add(*цвет* или Canvas) | прибавляет цвет или другой холст к цвету |
|
||||
| data:sub(*цвет* или Canvas) | вычитает цвет или другой холст к цвету |
|
||||
| Метод | Описание |
|
||||
|----------------------------------------------------------|-----------------------------------------------------------------|
|
||||
| data:at(x: int, y: int) | возвращает RGBA пиксель по указанным координатам |
|
||||
| data:set(x: int, y: int, *цвет*) | изменяет RGBA пиксель по указанным координатам |
|
||||
| data:line(x1: int, y1: int, x2: int, y2: int, *цвет*) | рисует линию с указанным RGBA цветом |
|
||||
| data:blit(src: Canvas, dst_x: int, dst_y: int) | рисует src-холст на указанных координатах |
|
||||
| data:clear() | очищает холст |
|
||||
| data:clear(*цвет*) | заполняет холст указанным RGBA цветом |
|
||||
| data:rect(x: int, y: int, w: int, h: int, *цвет*) | заполняет прямоугольник указанным RGBA цветом |
|
||||
| data:update() | применяет изменения и загружает холст в видеопамять |
|
||||
| data:set_data(data: bytearray | table<int>) | заменяет данные пикселей (ширина * высота * 4 чисел) |
|
||||
| data:get_data() | создаёт объект Bytearray с пиксельными данными изображения |
|
||||
| data:create_texture(name: str) | создаёт и делится текстурой с рендерером |
|
||||
| data:unbind_texture() | отвязывает текстуру от холста |
|
||||
| data:mul(*цвет* или Canvas) | умножает увет на указанный цвет или холст |
|
||||
| data:add(*цвет* или Canvas) | прибавляет цвет или другой холст к цвету |
|
||||
| data:sub(*цвет* или Canvas) | вычитает цвет или другой холст к цвету |
|
||||
| data:encode(format: str) | кодирует изображение в указанный формат и возращает массив байт |
|
||||
|
||||
Для декодирования массива байт в Canvas используйте статический метод:
|
||||
```lua
|
||||
Canvas.decode(data: Bytearray, format: str) -> Canvas
|
||||
```
|
||||
|
||||
На данный момент, из форматов поддерживается только png.
|
||||
|
||||
## Рамка встраивания (iframe)
|
||||
|
||||
|
|
|
|||
|
|
@ -137,6 +137,7 @@
|
|||
- `text-wrap` - разрешает автоматический перенос текста (работает только при multiline: "true")
|
||||
- `editable`- определяет возможность редактирования текста.
|
||||
- `line-numbers` - включает отображение номеров строк.
|
||||
- `keep-line-selection` - продолжать отображать выбранную строку при потере фокуса.
|
||||
- `error-color` - цвет при вводе некорректных данных (текст не проходит проверку валидатора). Тип: RGBA цвет.
|
||||
- `text-color` - цвет текста. Тип: RGBA цвет.
|
||||
- `validator` - lua функция, проверяющая текст на корректность. Принимает на вход строку, возвращает true если текст корректен.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue