Velocity 适配器

Warning

本文描述的是上游 PenguinClient 的 Velocity 适配器。HuHoBotPenguin 分支当前仅支持 Spigot/Paper。

本文介绍如何为 Velocity 编写 HuHoBotPenguin Proxy 附属插件。

Note

BungeeCord 和 Velocity 共用 HuHoBot-Penguin_Proxy-x.y.z.jar，但事件包名和平台注册方式不同。本页只介绍 Velocity。

引入 SDK

dependencies {
    compileOnly(files("libs/HuHoBot-Penguin_Proxy-x.y.z.jar"))
    compileOnly("com.velocitypowered:velocity-api:3.4.0-SNAPSHOT")
    kapt("com.velocitypowered:velocity-api:3.4.0-SNAPSHOT")
}

velocity-plugin.json：

{
  "id": "my-huhobot-addon",
  "name": "MyHuHoBotAddon",
  "version": "1.0.0",
  "main": "com.example.myaddon.MyHuHoBotAddon",
  "dependencies": [
    { "id": "huhobot", "optional": false }
  ]
}

监听 QQ 群消息

事件类：

cn.huohuas001.huhobotPenguin.velocity.events.OnBotRecvMsg

Velocity 没有通用的 Cancellable 接口，HuHoBot 事件提供 isCancelled() 和 setCancelled(boolean) 方法。

import cn.huohuas001.huhobotPenguin.velocity.events.OnBotRecvMsg;
import com.velocitypowered.api.event.Subscribe;

public final class BotListener {
    @Subscribe
    public void onBotMessage(OnBotRecvMsg event) {
        if (event.getMessage().getContent().equalsIgnoreCase("/hello")) {
            event.replyText("你好");
            event.setCancelled(true);
        }
    }
}

注册监听器：

server.getEventManager().register(this, new BotListener());

自定义命令事件

事件类：

cn.huohuas001.huhobotPenguin.velocity.events.OnBotCommand

@Subscribe
public void onBotCommand(OnBotCommand event) {
    if ("hello".equals(event.getMessage().getCommandKey())) {
        event.replyText("参数: " + event.getMessage().getCommandArguments());
        event.setCancelled(true);
    }
}

获取主插件实例

Velocity 的插件实例通常由 Guice 注入。如果需要从插件管理器查找：

server.getPluginManager()
    .getPlugin("huhobot")
    .flatMap(container -> container.getInstance())
    .filter(instance -> instance instanceof HuHoBotVelocity)
    .map(instance -> (HuHoBotVelocity) instance);

更推荐在附属插件初始化时保存由依赖注入或平台生命周期提供的实例。

查询认证 QQ 号

String qq = bot.getAuthenticatedQq(groupOpenId, openId);
// 未认证时 qq == null

注册命令和发送消息

bot.registerBotCommand("hello", "say Hello {params}", 0, true);
bot.sendBotText("发送到配置中的所有群");
bot.sendBotText(groupOpenId, "发送到指定群");
bot.sendBotMarkdown("# Markdown");
bot.sendBotMarkdown(groupOpenId, markdown, keyboard);
bot.unregisterBotCommand("hello");

Proxy 共享 API：

import cn.huohuas001.huhobotPenguin.proxy.api.ProxyBotApi;

ProxyBotApi.registerBotCommand("hello", "say Hello {params}");
ProxyBotApi.sendBotText(bot, "发送到配置群");
ProxyBotApi.sendBotText(groupOpenId, "发送到指定群");

回复事件

event.replyText("普通文本");
event.replyMarkdown("Markdown 内容");
event.replyMarkdown("Markdown 内容", keyboard);

注意事项

HuHoBot 使用 server.getEventManager().fire(event).get() 等待 Velocity 事件完成后读取取消状态。监听器中不要执行长时间阻塞操作；异步工作完成后，如需取消事件，应在事件 Future 完成前设置取消状态。