voxelcore/doc/ru/scripting/events.md
ostermine 2a01cfc5b1 add can_be_placed block event
can_be_placed(x, y, z, playerid, rotation) is called before a player
places the block, after the built-in checks (replaceability, grounded,
entities). The block is placed only if the function returns true.
rotation is the rotation the block is going to be placed with, so
blocks like ladders can check the block they are attached to.

The event is not called for block.place / block.set.

Closes #909
2026-10-10 15:54:21 +03:00

11 KiB
Raw Blame History

События движка

Содержание

События блоков

Функции для обработки событий, прописываемые в скрипте блока.

Warning

Массовые события, такие как on_block_tick, on_block_present и on_block_removed, при небрежном или чрезмерном использовании, могут привести к проблемам с производительностью.

function on_placed(x, y, z, playerid)

Вызывается после установки блока игроком

function can_be_placed(x, y, z, playerid, rotation) -> bool

Вызывается перед установкой блока игроком, после встроенных проверок (заменяемость, grounded, пересечение с сущностями). Блок устанавливается, только если функция возвращает true. rotation — индекс поворота, с которым будет установлен блок (см. block.get_rotation).

Пример: саженец, который можно посадить только на землю.

function can_be_placed(x, y, z, playerid, rotation)
    return block.name(block.get(x, y - 1, z)) == "base:dirt"
end

Событие не вызывается при установке блока через block.place и block.set.

function on_broken(x, y, z, playerid)

Вызывается после разрушения блока игроком

function on_replaced(x, y, z, playerid)

Вызывается перед заменой блока игроком

function on_interact(x, y, z, playerid) -> bool

Вызывается при нажатии на блок ПКМ. Предотвращает установку блоков, если возвращает true

function on_update(x, y, z)

Вызывается при обновлении блока (если изменился соседний блок)

function on_random_update(x, y, z)

Вызывается в случайные моменты времени (рост травы на блоках земли)

function on_blocks_tick(tps: int)

Вызывается tps (20 / tick-interval) раз в секунду. Используйте 1/tps вместо time.delta().

function on_block_tick(x, y, z, tps: number)

Вызывается tps (20 / tick-interval) раз в секунду для конкретного блока. Используйте 1/tps вместо time.delta().

function on_block_present(x, y, z)

Вызывается для конкретного блока при появлении (генерации/загрузке/размещении). Вызов происходит в течение времени, которое может зависеть от нагрузки очереди событий. При малой нагрузке происходит в течение первого такта блока (tick-interval). До вызова события on_block_tick не вызывается.

function on_block_removed(x, y, z)

Вызывается при выгрузке чанка, в котором находится блок.

События предметов

Функции для обработки событий, прописываемые в скрипте предмета.

function on_use(playerid: int)

Вызывается при нажатии ПКМ не на блок.

function on_use_on_block(x: int, y: int, z: int, playerid: int, normal: vec3)

Вызывается при нажатии ПКМ на блок. Предотвращает установку блока, прописанного в placing-block если возвращает true

function on_block_break_by(x: int, y: int, z: int, playerid: int)

Вызывается при нажатии ЛКМ на блок (в т.ч неразрушимый). Предотвращает разрушение блока, если возвращает true

События мира

События мира для контент-пака прописываются в scripts/world.lua

function on_world_open()

Вызывается при загрузке мира

function on_world_save()

Вызывается перед сохранением мира

function on_world_tick()

Вызывается 20 раз в секунду

function on_world_quit()

Вызывается при выходе из мира (после сохранения)

function on_block_placed(blockid, x, y, z, playerid)

Вызывается после установки блока игроком

function on_block_replaced(blockid, x, y, z, playerid)

Вызывается после замены блока игроком

function on_block_broken(blockid, x, y, z, playerid)

Вызывается после разрушения блока игроком

function on_block_interact(blockid, x, y, z, playerid) -> bool

Вызывается при нажатии на блок ПКМ. Предотвращает установку блоков, если возвращает true

function on_entity_spawn(uid)

Вызывается после спавна сущности

function on_entity_despawn(uid)

Вызывается перед удалением сущности

function on_player_tick(playerid: int, tps: int)

Вызывается tps (20) раз в секунду. Используйте 1/tps вместо time.delta().

События чанков (world.lua)

function on_chunk_present(x: int, z: int, loaded: bool)

Вызывается после генерации/загрузки чанка. В случае загрузки ранее сохраненного чанка loaded будет истинным.

function on_chunk_remove(x: int, z: int)

Вызывается при выгрузке чанка из мира.

События инвентарей (world.lua)

function on_inventory_open(invid: int, playerid: int)

Вызывается при открытии инвентаря. Если инвентарь был открыт не напрямую игроком, playerid будет равен -1.

function on_inventory_closed(invid: int, playerid: int)

Вызывается при закрытии инвентаря.

События макета

События прописываются в файле layouts/имя_макета.xml.lua.

function on_open(invid: int, x: int, y: int, z: int)

Вызывается при добавлении элемента на экран.

  • При отсутствии привязки к инвентарю invid будет равен 0.
  • При отсутствии привязки к блоку x, y, z так же будут равны 0.
function on_close(invid: int)

Вызывается при удалении элемента с экрана.

События контента

События жизненного цикла контент-пака прописываются в файле scripts/content.lua

function on_scripts_loading()

Вызывается перед загрузкой скриптов контент-пака

function on_content_loaded()

Вызывается после того, как контент-пак был полностью загружен

События HUD

События связанные с игровым интерфейсом прописываются в файле scripts/hud.lua

function on_hud_open(playerid: int)

Вызывается после входа в мир, когда становится доступна библиотека hud. Здесь на экран добавляются постоянные элементы.

function on_hud_render()

Вызывается каждый кадр. Используется для клиентских задач, таких как анимация, управление камерой.

function on_hud_close(playerid: int)

Вызывается при выходе из мира, перед его сохранением.

function on_inventory_interact(invid: int, slot: int, action: int, mode: int)

Вызывается при взаимодействии игрока с любым слотом

ACTION / MODE (0) PRIMARY (1) SECONDARY
(0) PUT Кладёт все предметы в слот, если другой предмет в слоте - обмен Кладёт в слот один предмет из слота курсора
(1) TAKE Забирает все предметы из слота Берёт половину предметов из слота (округление вверх)
(2) SHARE Вызывает share ивент у макета инвентаря Не определён

События ECS

События ECS описаны тут

Библиотека events

events.on(code: str, handler: function)

Добавляет обработчик события по его коду, не ограничиваясь стандартными.

events.reset(code: str, [опционально] handler: function)

Удаляет событие, добавляя обработчик, если указан.

events.emit(code: str, args...) -> bool

Генерирует событие по коду. Если событие не существует, ничего не произойдет. Существование события определяется наличием обработчиков.

events.remove_by_prefix(packid: str)

Удаляет все события с префиксом packid:. Вы выходе из мира выгружаются события всех паков, включая core:.