mirror of
https://github.com/kuitoi/kuitoi-Server.git
synced 2025-08-17 16:25:36 +00:00
Add KuiTio docs
This commit is contained in:
parent
cf0f397465
commit
71df291391
58
docs/ru/plugins/classes.md
Normal file
58
docs/ru/plugins/classes.md
Normal file
@ -0,0 +1,58 @@
|
||||
# Передаваемые классы
|
||||
|
||||
## Стоит ознакомится
|
||||
|
||||
* Что такое `*args` и `**kwargs`? [habr](https://habr.com/ru/companies/ruvds/articles/482464/)
|
||||
|
||||
### KuiToi
|
||||
###### (`kt = KuiToi`)
|
||||
|
||||
#### 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)
|
||||
_`event_name: str` -> Имя ивента, который будет вызван._\
|
||||
_`*args, **kwargs` -> Аргументы, передуваемые во функции._
|
||||
|
||||
#### **async** kt.call_async_event(event_name: str, *args, **kwargs)
|
||||
_`event_name: str` -> Имя ивента, который будет вызван._\
|
||||
_`*args, **kwargs` -> Аргументы, передуваемые во функции._\
|
||||
_Необходимо вызывать с `await`_
|
||||
|
||||
Данные во все ивенты приходят по типу: `{"event_name": event_name, "args": args, "kwargs": kwargs}`\
|
||||
`args: list` -> Представляет из себя массив данных, которые переданы в ивент\
|
||||
`kwargs: dict` -> Представляет из себя словарь данных, которые переданы в ивент
|
||||
###### _Советую ознакомится_, ссылка есть в начале
|
||||
|
||||
#### kt.call_lua_event(event_name: str, *args)
|
||||
_`event_name: str` -> Имя ивента, который будет вызван._\
|
||||
_`*args` -> Аргументы, передуваемые во функции._
|
||||
|
||||
Добавлено для поддержки обратной совместимости.\
|
||||
lua функция вызывается с прямой передачей аргументов `lua_func(*args)`
|
||||
|
||||
### Player (или Client)
|
||||
###### (`pl = Player`)
|
||||
|
||||
#### pl.
|
5
docs/ru/plugins/events_list.md
Normal file
5
docs/ru/plugins/events_list.md
Normal file
@ -0,0 +1,5 @@
|
||||
# Список ивентов
|
||||
|
||||
В большинство ивентов будет приходить `pl = data['kwargs']['player']`, описание можно найти [тут](classes.md)
|
||||
|
||||
###
|
@ -1,5 +1,8 @@
|
||||
# Система плагинов
|
||||
|
||||
### Ивенты: [тут](./events_list)
|
||||
### Классы: [тут](./classes)
|
||||
|
||||
## Установка библиотеки с "Заглушками"
|
||||
###### (Это значит, что не будет работать без сервера, но IDE подскажет API)
|
||||
###### (Библиотека ещё в разработке)
|
||||
|
Loading…
x
Reference in New Issue
Block a user