MiniDay/hamster-ball
1
0
Fork 0
Code Issues Pull Requests Actions Releases 9 Activity

docs: 完善文档

Browse Source
This commit is contained in:
叁只仓鼠
2024-01-04 13:51:41 +08:00
parent 44732ba480
commit aa3a62705c
1 changed files with 14 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@@ -134,7 +134,8 @@ dependencies {
在下面这个例子中我将实现一个业务功能：**跨服聊天** 在下面这个例子中我将实现一个业务功能：**跨服聊天**
插件名称为：`GlobalChat` 插件名称为：`GlobalChat`
第一步：监听 Bukkit 的聊天事件（省略通过BukkitAPI注册该监听器的代码） <details>
<summary>第一步：监听 Bukkit 的聊天事件（省略通过BukkitAPI注册该监听器的代码）</summary>
```java ```java
import cn.hamster3.mc.plugin.ball.common.api.BallAPI; import cn.hamster3.mc.plugin.ball.common.api.BallAPI;
@@ -157,10 +158,12 @@ public class ChatListener implements Listener {
event.setCancelled(true); event.setCancelled(true);
} }
} }
``` ```
第二步：监听 MessageReceivedEvent 事件完成业务代码 </details>
<details>
<summary>第二步：监听 MessageReceivedEvent 事件完成业务代码</summary>
```java ```java
import cn.hamster3.mc.plugin.ball.common.data.BallMessage; import cn.hamster3.mc.plugin.ball.common.data.BallMessage;
@@ -199,7 +202,10 @@ public class BallListener {
} }
``` ```
第三步：在插件启动时注册上述两个监听器，并订阅 `GlobalChat` 频道 </details>
<details>
<summary>第三步：在插件启动时注册上述两个监听器，并订阅 `GlobalChat` 频道</summary>
```java ```java
import cn.hamster3.mc.plugin.ball.common.api.BallAPI; import cn.hamster3.mc.plugin.ball.common.api.BallAPI;
@@ -214,8 +220,11 @@ public class GlobalChatPlugin extends JavaPlugin {
// 注册 BallListener 事件监听器 // 注册 BallListener 事件监听器
BallAPI.getInstance().getEventBus().register(new BallListener()); BallAPI.getInstance().getEventBus().register(new BallListener());
// 订阅 GlobalChat 频道 // 订阅 GlobalChat 频道
// 只有在需要收到消息的子服中才需要订阅频道
// 如果一个子服只负责发送消息而不负责处理消息，则可以不用订阅频道
BallAPI.getInstance().subscribe("GlobalChat"); BallAPI.getInstance().subscribe("GlobalChat");
} }
} }
``` ```
</details>