From 97de6201865fdb935c4996e5adf6446679b8bc1a Mon Sep 17 00:00:00 2001
From: Junyan Qin <rockchinq@gmail.com>
Date: Thu, 24 Oct 2024 16:37:21 +0800
Subject: [PATCH] =?UTF-8?q?doc:=20=E6=B7=BB=E5=8A=A0=E5=A4=9A=E4=B8=AA=20?=
 =?UTF-8?q?=E6=8F=92=E4=BB=B6API=20=E5=8F=82=E8=80=83?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 docs/develop/api-ref.md | 30 +++++++++++++++++++++++++++++-
 1 file changed, 29 insertions(+), 1 deletion(-)

diff --git a/docs/develop/api-ref.md b/docs/develop/api-ref.md
index 8cfbf1c8d..76d33f482 100644
--- a/docs/develop/api-ref.md
+++ b/docs/develop/api-ref.md
@@ -6,7 +6,9 @@
 
 ### 回复消息
 
+```python
 ctx.reply(message_chain: mirai.MessageChain)
+```
 
 回复此次事件的发起会话。
 
@@ -16,10 +18,36 @@ ctx.reply(message_chain: mirai.MessageChain)
 
 > 由于 QQ 官方 API 对主动消息的支持性很差，故若用户使用的是 QQ 官方 API，发送主动消息可能会失败
 
+```python
 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 对象](https://yiri-mirai.wybxc.cc/docs/basic/message-chain)，若用户使用的不是 YiriMirai 适配器，程序也能自动转换为目标消息链
\ No newline at end of file
+- `message_chain`：[YiriMirai 的 MessageChain 对象](https://yiri-mirai.wybxc.cc/docs/basic/message-chain)，若用户使用的不是 YiriMirai 适配器，程序也能自动转换为目标消息链
+
+### 阻止事件默认行为
+
+```python
+ctx.prevent_default()
+```
+
+阻止此次事件的默认行为即停止处理流程之后的行为（如私聊收到消息时向接口获取回复、群消息收到消息时向接口获取回复等）。
+
+### 阻止后续插件执行
+
+```python
+ctx.prevent_postorder()
+```
+
+阻止此次事件后续插件的执行。插件的执行顺序请通过`插件介绍`中的`插件管理`介绍的方式修改优先级。
+
+### 添加返回值
+
+```python
+ctx.add_return(name: str, value: Any)
+```
+
+添加返回值，返回值可在事件监听器中通过`ctx.returns[name]`访问。事件返回值均为**可选**的，每个事件支持的返回值请查看`pkg.plugin.events`中的每个事件的注释。