LangBot/docs/plugin/api-ref.md

API 参考

以下 API 仅针对 事件插件 可用，组件扩展形式请自行阅读源码。

消息处理

回复消息

ctx.reply(message_chain: mirai.MessageChain)

回复此次事件的发起会话。

• message_chain：YiriMirai 的 MessageChain 对象，若用户使用的不是 YiriMirai 适配器，程序也能自动转换为目标消息链

发送主动消息

由于 QQ 官方 API 对主动消息的支持性很差，故若用户使用的是 QQ 官方 API，发送主动消息可能会失败

ctx.send_message(target_type: str, target_id: str, message_chain: mirai.MessageChain)

发送主动消息给目标。

• target_type：目标类型，可选值："person"、"group"
• target_id：目标 ID（QQ 号或群号）
• message_chain：YiriMirai 的 MessageChain 对象，若用户使用的不是 YiriMirai 适配器，程序也能自动转换为目标消息链

事件处理

阻止事件默认行为

ctx.prevent_default()

阻止此次事件的默认行为即停止处理流程之后的行为（如私聊收到消息时向接口获取回复、群消息收到消息时向接口获取回复等）。

阻止后续插件执行

ctx.prevent_postorder()

阻止此次事件后续插件的执行。插件的执行顺序请通过插件介绍中的插件管理介绍的方式修改优先级。

添加返回值

ctx.add_return(name: str, value: Any)

添加返回值，事件返回值均为可选的，每个事件支持的返回值请查看pkg.plugin.events中的每个事件的注释。