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