Skip to main content
Декоратор @command — это основной способ регистрации команд, на которые будут реагировать пользователи.

Аргументы декоратора @command

str
Имя команды. Если не указано, используется имя функции.
list[str]
Список (list) строковых псевдонимов для команды. Например, aliases=["e", "exec"].
str
Ключ для строки с описанием команды из словаря strings (или само описание). Это описание будет видно в меню .chelp, в меню установки плагина и в списке плагинов.
str | bool
Позволяет связать состояние команды (включена/выключена) с настройкой плагина.
  • bool: True (по умолчанию) или False.
  • str: Ключ булевой настройки (Switch) из create_settings(). Команда будет активна, только если эта настройка включена.

CactusUtils.Command

В функцию команды всегда передается объект CactusUtils.Command, который содержит всю необходимую информацию о вызове.

Примеры

1. Простая команда с псевдонимами и описанием
pingpong.plugin
Вызов: .ping или .p. В .chelp: .ping - Checks if the plugin is working. или .ping - Проверяет, работает ли плагин. 2. Команда с аргументами
echo.plugin
Вызов: .echo Привет, мир! Ответ: Вы сказали: <b>Привет, мир!</b> 3. Команда, зависящая от настройки
extraX.plugin
Эта команда будет работать, только если пользователь включит опцию “Включить фичу X” в настройках вашего плагина. 4. Команда, которая ожидает отправления сообщения, а после срабатывает
test.plugin