mirror of
https://github.com/kuitoi/kuitoi-Server.git
synced 2025-08-18 00:35:36 +00:00
Update KuiToi Class docs
This commit is contained in:
parent
25ac16c300
commit
17b8be1b9d
@ -2,28 +2,28 @@
|
|||||||
|
|
||||||
## Стоит ознакомится
|
## Стоит ознакомится
|
||||||
|
|
||||||
* Что такое `*args` и `**kwargs`? [habr](https://habr.com/ru/companies/ruvds/articles/482464/)
|
1. Что такое `*args` и `**kwargs`? -> [Пост на habr](https://habr.com/ru/companies/ruvds/articles/482464/)
|
||||||
|
|
||||||
### KuiToi
|
## KuiToi
|
||||||
###### (`kt = KuiToi`)
|
_`kt = KuiToi("PluginName"")`_
|
||||||
|
|
||||||
#### kt.log
|
### kt.log
|
||||||
_Константа_\
|
_Константа_\
|
||||||
Вернёт преднастроенный логгер
|
Вернёт преднастроенный логгер
|
||||||
|
|
||||||
#### kt.name
|
### kt.name
|
||||||
_Константа_\
|
_Константа_\
|
||||||
Вернёт имя плагина
|
Вернёт имя плагина
|
||||||
|
|
||||||
#### kt.dir
|
### kt.dir
|
||||||
_Константа_\
|
_Константа_\
|
||||||
Вернёт папку плагина
|
Вернёт папку плагина
|
||||||
|
|
||||||
#### kt.open()
|
### kt.open()
|
||||||
_Параметры как у open()_\
|
_Параметры как у open()_\
|
||||||
Открывает файл в kt.dir
|
Открывает файл в kt.dir
|
||||||
|
|
||||||
#### kt.register_event(event_name: str, event_func: function)
|
### kt.register_event(event_name: str, event_func: function)
|
||||||
_`event_name: str` -> Имя ивента, по которому будет вызвана `event_func`._\
|
_`event_name: str` -> Имя ивента, по которому будет вызвана `event_func`._\
|
||||||
_`event_func: function` -> Функция, которая будет вызвана._
|
_`event_func: function` -> Функция, которая будет вызвана._
|
||||||
|
|
||||||
@ -31,28 +31,52 @@ _`event_func: function` -> Функция, которая будет вызва
|
|||||||
Ивенты можно создавать так же свои, со своим именем.\
|
Ивенты можно создавать так же свои, со своим именем.\
|
||||||
Зарегистрировать можно не ограниченное кол-во ивентов.
|
Зарегистрировать можно не ограниченное кол-во ивентов.
|
||||||
|
|
||||||
#### kt.call_event(event_name: str, *args, **kwargs)
|
### kt.call_event(event_name: str, *args, **kwargs) -> list:
|
||||||
_`event_name: str` -> Имя ивента, который будет вызван._\
|
_`event_name: str` -> Имя ивента, который будет вызван._\
|
||||||
_`*args, **kwargs` -> Аргументы, передуваемые во функции._
|
_`*args, **kwargs` -> Аргументы, передаваемые во функции._
|
||||||
|
|
||||||
#### **async** kt.call_async_event(event_name: str, *args, **kwargs)
|
### **async** kt.call_async_event(event_name: str, *args, **kwargs) -> list:
|
||||||
_`event_name: str` -> Имя ивента, который будет вызван._\
|
_`event_name: str` -> Имя ивента, который будет вызван._\
|
||||||
_`*args, **kwargs` -> Аргументы, передуваемые во функции._\
|
_`*args, **kwargs` -> Аргументы, передаваемые во функции._\
|
||||||
_Необходимо вызывать с `await`_
|
_Необходимо вызывать с `await`_
|
||||||
|
|
||||||
|
###### _Советую ознакомиться с *args, **kwargs_, ссылка есть в начале
|
||||||
Данные во все ивенты приходят по типу: `{"event_name": event_name, "args": args, "kwargs": kwargs}`\
|
Данные во все ивенты приходят по типу: `{"event_name": event_name, "args": args, "kwargs": kwargs}`\
|
||||||
`args: list` -> Представляет из себя массив данных, которые переданы в ивент\
|
`args: list` -> Представляет из себя массив данных, которые переданы в ивент\
|
||||||
`kwargs: dict` -> Представляет из себя словарь данных, которые переданы в ивент
|
`kwargs: dict` -> Представляет из себя словарь данных, которые переданы в ивент
|
||||||
###### _Советую ознакомится_, ссылка есть в начале
|
Данные вернутся от всех удачных волнений в массиве.
|
||||||
|
|
||||||
#### kt.call_lua_event(event_name: str, *args)
|
### kt.call_lua_event(event_name: str, *args) -> list:
|
||||||
_`event_name: str` -> Имя ивента, который будет вызван._\
|
_`event_name: str` -> Имя ивента, который будет вызван._\
|
||||||
_`*args` -> Аргументы, передуваемые во функции._
|
_`*args` -> Аргументы, передаваемые во функции._
|
||||||
|
|
||||||
Добавлено для поддержки обратной совместимости.\
|
Добавлено для поддержки обратной совместимости.\
|
||||||
lua функция вызывается с прямой передачей аргументов `lua_func(*args)`
|
lua функция вызывается с прямой передачей аргументов `lua_func(*args)`
|
||||||
|
|
||||||
### Player (или Client)
|
### kt.get_player([pid: int], [nick: str]) -> Player | None:
|
||||||
###### (`pl = Player`)
|
_`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']`_\
|
||||||
|
|
||||||
#### pl.
|
#### pl.
|
||||||
|
Loading…
x
Reference in New Issue
Block a user