Пространство имён

hook.add

Подписывает функцию на событие.

hook.add(event, id, fn)

Аргументы

#	имя	тип
1	`event`	string	имя события; своё обязано содержать точку
2	`id`	string	уникален внутри этого плагина
3	`fn`	function	получает объект события

Возвращает

Ничего.

Пример

hook.add("player:spawn", "myplugin.armor", function(e)
	e.player:armor(100)
end)

Повторная регистрация той же пары (event, id) заменяет обработчик. Это то, что не даёт lua_reload <plugin> удвоить подписки. Id уникален внутри плагина — два разных плагина спокойно называют свои "init".

Приём сетевых сообщений — `msg:Name`

Особый вид имени, без точки: hook.add("msg:TextMsg", id, fn) подписывается на сетевые сообщения, которые движок отправляет клиентам — приёмная сторона к msg.send. Свои подробности — у msg.

Порядок вызова

Обработчики идут в порядке загрузки плагинов. Обычно это неважно, но на отменяемом событии решает, кто выиграет: e:cancel() обрывает цепочку. Числа приоритета в hook.add тут не помогли бы: как только их начнут ставить все, они снова перестанут что-либо значить. Порядком распоряжается владелец сервера — через addons/lua/load_order.txt:

# грузятся первыми и в этом порядке
godmode
damager
stats

Всё, чего в файле нет, идёт после по алфавиту, поэтому список не обязан быть полным. Текущий порядок видно в lua_list и lua_hooks.

Неизвестное имя без точки и без msg: — ошибка со списком движковых событий. Так ловится опечатка, которая иначе дала бы молча неработающую подписку.

Смотри также

hook.remove

Снимает подписку по имени события и id.

hook.remove(event, id)

Аргументы

#	имя	тип
1	`event`	string	имя события
2	`id`	string	id, под которым подписывались

Возвращает

тип
`boolean`	`true`, если обработчик был

Снимает только собственный обработчик плагина: один плагин не может тихо отписать чужой.

hook.run

Запускает своё событие плагина.

hook.run(event[, data])

Аргументы

#	имя	тип
1	`event`	string	имя, обязательно с точкой
2	`data`	table \| nil	становится объектом события

Возвращает

тип
`table`	та же таблица — из неё читается результат

Пример

local e = hook.run("shop.buying", { player = p, item = item })
if e.cancelled then return end

Точка в имени обязательна: она отличает своё событие от опечатки в движковом. Движковое событие через hook.run запустить нельзя — это делает модуль.

Смотри также

export / import

hook.list

Возвращает список подписок в порядке вызова.

hook.list([event])

Аргументы

#	имя	тип
1	`event`	string \| nil	только по одному событию

Возвращает

тип
`table`	массив `{ event = , id = , plugin = }`

Консольная обёртка — lua_hooks.

Документация

Справочник API

hook — Пространство имён

Пространство имён

hook.add

Аргументы

Возвращает

Пример

Приём сетевых сообщений — `msg:Name`

Порядок вызова

Смотри также

hook.remove

Аргументы

Возвращает

hook.run

Аргументы

Возвращает

Пример

Смотри также

hook.list

Аргументы

Возвращает

​Пространство имён

​hook.add

​Аргументы

​Возвращает

​Пример

​Приём сетевых сообщений — msg:Name

​Порядок вызова

​Смотри также

​hook.remove

​Аргументы

​Возвращает

​hook.run

​Аргументы

​Возвращает

​Пример

​Смотри также

​hook.list

​Аргументы

​Возвращает

Пространство имён

hook.add

Аргументы

Возвращает

Пример

Приём сетевых сообщений — `msg:Name`

Порядок вызова

Смотри также

hook.remove

Аргументы

Возвращает

hook.run

Аргументы

Возвращает

Пример

Смотри также

hook.list

Аргументы

Возвращает