3.7 KiB
Передаваемые классы
Стоит ознакомится
- Что такое
*argsи**kwargs? -> Пост на habr
KuiToi
kt = KuiToi("PluginName"")
kt.log
Константа
Вернёт преднастроенный логгер
kt.name
Константа
Вернёт имя плагина
kt.dir
Константа
Вернёт папку плагина
kt.open()
Параметры как у open()
Открывает файл в kt.dir
kt.register_event(event_name: str, event_func: function)
event_name: str -> Имя ивента, по которому будет вызвана event_func.
event_func: function -> Функция, которая будет вызвана.
В event_func можно передавать как обычную функцию, так и async - await не нужно делать заранее.
Ивенты можно создавать так же свои, со своим именем.
Зарегистрировать можно не ограниченное кол-во ивентов.
kt.call_event(event_name: str, *args, **kwargs) -> list:
event_name: str -> Имя ивента, который будет вызван.
*args, **kwargs -> Аргументы, передаваемые во функции.
async kt.call_async_event(event_name: str, *args, **kwargs) -> list:
event_name: str -> Имя ивента, который будет вызван.
*args, **kwargs -> Аргументы, передаваемые во функции.
Необходимо вызывать с await
Советую ознакомиться с *args, **kwargs, ссылка есть в начале
Данные во все ивенты приходят по типу: {"event_name": event_name, "args": args, "kwargs": kwargs}
args: list -> Представляет из себя массив данных, которые переданы в ивент
kwargs: dict -> Представляет из себя словарь данных, которые переданы в ивент
Данные вернутся от всех удачных волнений в массиве.
kt.call_lua_event(event_name: str, *args) -> list:
event_name: str -> Имя ивента, который будет вызван.
*args -> Аргументы, передаваемые во функции.
Добавлено для поддержки обратной совместимости.
lua функция вызывается с прямой передачей аргументов lua_func(*args)
kt.get_player([pid: int], [nick: str]) -> Player | None:
pid: int -> Player ID - Идентификатор игрока.
nick: str -> Player Nick - Ник игрока.
Метод возвращает объект игрока по его pid, nick.
Если не удалось найти игрока вернётся None.
kt.get_players() -> List[Player] | list:
Метод возвращает массив со всеми игроками.
Массив будет пустой, если игроков нет.
kt.players_counter() -> int:
Метод возвращает количество игроков, которые сейчас онлайн.
kt.is_player_connected([pid: int], [nick: str]) -> bool:
pid: int -> Player ID - Идентификатор игрока.
nick: str -> Player Nick - Ник игрока.
Метод возвращает объект игрока по его pid, nick.
Player (или Client)
pl = kt.get_player()
pl = event_data['kwargs']['player']\