События

Что такое событиеСкопировать ссылку

Событие это момент в игре, о котором клиент готов тебе сообщить: наступил новый тик, игрок ударил, сломался блок, пришёл кадр для отрисовки. Ты пишешь функцию и просишь звать её в этот момент.

Без событий скрипт мёртвый: файл один раз выполнится, и на этом всё. Именно события оживляют скрипт и заставляют его работать всё время, пока идёт игра.

Подписка выглядит как строчка @events.имя_события прямо над функцией. Функцию можно называть как угодно, важна строчка сверху.

1
2
3@events.tick
def on_tick(event):
    client.overlay("тик")     # надпись обновляется 20 раз в секунду

Аргумент event обязателен, даже если он не нужен. В нём лежат подробности случившегося, и у каждого события они свои: у удара это цель, у отрисовки холст, у сообщения текст. Спрашивают их методами, например event.getEntity().

Все событияСкопировать ссылку

Событий ровно 50, это всё, что клиент отдаёт скриптам. Придумать своё имя нельзя: подписка на несуществующее событие просто никогда не сработает.

Колонка «Отмена» показывает, можно ли не дать событию случиться. Про это следующий раздел. Имя события в таблице это ссылка: на своей странице у каждого расписано, когда оно приходит, что можно у него спросить, и лежат рабочие примеры.

Отмена и подменаСкопировать ссылку

Событие это не уведомление о том, что всё уже случилось. Это момент, когда ты ещё можешь вмешаться. У событий с пометкой «да» в таблице есть event.cancel(): после него действие просто не произойдёт.

1
2
3
4
5
6
7
8
9
10BAD = ["/login", "/reg", "password"]


@events.send_message
def on_send(event):
    text = event.getMessage()

    if any(word in text.lower() for word in BAD):
        event.cancel()                      # сообщение не уйдёт на сервер
        client.warn("Заблокировано: похоже на пароль")

Кроме отмены бывает подмена: у сообщения есть setMessage, у координат setY и так далее. Ты меняешь значение, и дальше пойдёт уже твоё.

1
2
3
4@events.send_message
def on_send(event):
    text = event.getMessage()
    event.setMessage(text + " (отправлено скриптом)")

Если событие уже отменил кто-то другой, это видно через event.isCancelled(). Пригодится, чтобы не делать лишнюю работу.

Ошибки в обработчикахСкопировать ссылку

Ошибка внутри такой функции обходится дорого: клиент пишет в чат [Python Error] и выгружает весь скрипт целиком, вместе с модулями и всем, что он нарисовал.

Почти все падения случаются по трём причинам.

• Мира ещё нет. Ты в главном меню, а скрипт спрашивает про игрока. Лечится проверкой world.ingame() в начале.
• Объекта уже нет. Моб умер между тиками, цель исчезла. Лечится проверкой на None.
• Что-то снаружи. Сеть, чтение файла, разбор чужих данных. Лечится try / except.

1
2
3
4
5
6
7
8
9
10@events.tick
def on_tick(event):
    if not mod.isEnabled() or not world.ingame():
        return

    target = world.nearest_player()
    if target is None:              # рядом никого, тихо выходим
        return

    client.overlay("ближайший на высоте %.1f" % target.getY())