增添了进程去向注释，优化了broadcast

xiaohuihui1022 · xiaohuihui1022 · commit c421d9428b23 · 2023-01-27T12:37:51.000+08:00
diff --git a/src/main/java/top/mpt/huihui/answerit/Main.java b/src/main/java/top/mpt/huihui/answerit/Main.java
@@ -1,5 +1,6 @@
 package top.mpt.huihui.answerit;
 
+import org.bukkit.Bukkit;
 import org.bukkit.ChatColor;
 import org.bukkit.plugin.java.JavaPlugin;
 import top.mpt.huihui.answerit.executor.CommandHandler;
@@ -24,7 +25,7 @@ public final class Main extends JavaPlugin {
     public static List<String> voteList = new ArrayList<>();
     // 避免玩家投票结束后进行投票
     public static boolean canVote = false;
-    // 设置奖励玩家
+    // 设置normal项（用于broadcast）
     public static String normal = BLUE + "[AnswerIt] ";
     @Override
     public void onEnable() {
@@ -38,6 +39,7 @@ public void onEnable() {
         getServer().getPluginManager().registerEvents(new PlayerChat(), this);
         getServer().getPluginManager().registerEvents(new InvOpen(), this);
         getLogger().info(normal + ChatColor.AQUA + "插件已启用");
+        /* waiting player commands */
     }
 
     @Override
diff --git a/src/main/java/top/mpt/huihui/answerit/commands/impl/q.java b/src/main/java/top/mpt/huihui/answerit/commands/impl/q.java
@@ -28,6 +28,7 @@ public q() {
     public static Player target = null;
     public static Player sender = null;
 
+    /* from PlayerExecuteCommand */
     public boolean onCommand(CommandSender sender, String[] args) {
         /*
          * args[0] = NameFlying
@@ -75,19 +76,26 @@ public boolean onCommand(CommandSender sender, String[] args) {
                 // 可以给予奖励
                 prize.canPrize = true;
                 sender.spigot().sendMessage(message);
+                /* start select process */
+                /* wait Sender Select Right Answer */
+                /* then to commands.impl.setAnswer */
+
             } else if (Objects.equals(args[2], "write") || Objects.equals(args[2], "Write")){
                 PlayerUtils.send(target, "#YELLOW#您收到了来自#AQUA#[%s]#YELLOW#的提问", sender.getName());
                 PlayerUtils.send(target, "#AQUA#提问类型： Write");
                 PlayerUtils.send(target, "#GREEN#提问内容： #RESET#%s", args[1]);
                 PlayerUtils.send(target, "#RED#请在输入框内输入答案，然后将交由提问者和其他玩家共同判断。");
-                ChatUtils.broadcast("%s#GREEN#玩家： #AQUA#%s #GREEN#收到了来自： #GOLD#%s#GREEN# 的提问。",
-                        Main.normal, target.getName(), sender.getName());
-                ChatUtils.broadcast("%s#AQUA#提问内容： #RESET#%s", Main.normal, args[1]);
-                ChatUtils.broadcast("%s#GREEN#正在等待玩家#AQUA#%s#GREEN#作答", Main.normal, target.getName());
+                ChatUtils.broadcast("#GREEN#玩家： #AQUA#%s #GREEN#收到了来自： #GOLD#%s#GREEN# 的提问。",
+                        target.getName(), sender.getName());
+                ChatUtils.broadcast("#AQUA#提问内容： #RESET#%s", args[1]);
+                ChatUtils.broadcast("#GREEN#正在等待玩家#AQUA#%s#GREEN#作答", target.getName());
                 Main.isCheckChat = true;
                 // 假设玩家会答对，timer那里可以直接execute
                 prize.setPrizePlayer(target);
                 prize.setTargetPlayer((Player) sender);
+                /* start write process */
+                /* wait Player Answer Question */
+                /* then to listener.PlayerChat */
             }
 
         } else {
diff --git a/src/main/java/top/mpt/huihui/answerit/commands/impl/send.java b/src/main/java/top/mpt/huihui/answerit/commands/impl/send.java
@@ -14,6 +14,7 @@ public send(){
         super("send", "", "no-usage");
     }
 
+    /* from commands.impl.setAnswer(with Player Execute) */
     public boolean onCommand(CommandSender sender, String[] args){
         // args[0] == 答对啦！
         // args[1] == NameFlying(提问者)
@@ -26,20 +27,20 @@ public boolean onCommand(CommandSender sender, String[] args){
                 PlayerUtils.send(sender, "#AQUA#您输入的格式并不正确！");
             } else if (args[0].equals("答对啦！")){
                 PlayerUtils.send(sender, "#GREEN#答对啦！");
-                ChatUtils.broadcast("%s#GOLD#玩家： #AQUA#%s #GOLD#答对了 #BLUE#%s #GOLD#的问题。", Main.normal, sender.getName(), args[1]);
+                ChatUtils.broadcast("#GOLD#玩家： #AQUA#%s #GOLD#答对了 #BLUE#%s #GOLD#的问题。", sender.getName(), args[1]);
                 prize.setPrizePlayer((Player) sender);
                 prize.setTargetPlayer(Bukkit.getPlayer(args[1]));
                 prize.executePrize();
             } else if (args[0].equals("答错了！")){
                 PlayerUtils.send(sender, "#RED#答错了qwq");
-                ChatUtils.broadcast("%s#RED#玩家： #AQUA#%s #RED#答错了 #BLUE#%s #RED#的问题。", Main.normal, sender.getName(), args[1]);
+                ChatUtils.broadcast("#RED#玩家： #AQUA#%s #RED#答错了 #BLUE#%s #RED#的问题。", sender.getName(), args[1]);
                 prize.setTargetPlayer((Player) sender);
                 prize.setPrizePlayer(Bukkit.getPlayer(args[1]));
                 prize.executePrize();
             } else {
                 PlayerUtils.send(sender, "#GREEN#不对啊qwq，肯定是服务器出问题了，这行字按道理来说不会出现的qwq。不要找灰灰好吧");
             }
-
+            /* to prize.prize */
         } else {
             sender.sendMessage("请让玩家执行该指令.");
         }
diff --git a/src/main/java/top/mpt/huihui/answerit/commands/impl/setAnswer.java b/src/main/java/top/mpt/huihui/answerit/commands/impl/setAnswer.java
@@ -11,8 +11,8 @@
 
 import java.util.Objects;
 
-public class setanswer extends ICommand {
-    public setanswer(){
+public class setAnswer extends ICommand {
+    public setAnswer(){
         super("setanswer", "", "no-usage");
     }
 
@@ -28,7 +28,7 @@ public boolean onCommand(CommandSender sender, String[] args){
          * args[4] = "fakeAnswer,Answer"
          */
         if (sender instanceof Player){
-            setanswer.sender = (Player)sender;
+            setAnswer.sender = (Player)sender;
             target = Bukkit.getPlayer(args[0]);
             answer = args[1];
             answerText = args[4];
@@ -45,6 +45,7 @@ public String permission(){
     }
 
 
+    /* from commands.impl.q(with Player Execute Command) */
     /**
      * 给玩家发送问题
      * @param sender 发出提问者
@@ -64,7 +65,7 @@ public void sendQuestion(Player sender, String type, String text){
         PlayerUtils.send(target, "#GREEN#提问内容： #RESET#%s", text);
         // 如果提问类型是select
         if (Objects.equals(type, "select") || Objects.equals(type, "Select")){
-            String[] answerText = setanswer.answerText.split(",");
+            String[] answerText = setAnswer.answerText.split(",");
             // ClickEvent用
             TextComponent message = null;
             for (int i = 0; i <= answerText.length - 1; i++){
@@ -85,7 +86,8 @@ public void sendQuestion(Player sender, String type, String text){
                 }
             }
             target.spigot().sendMessage(message);
-
+            /* wait Target Answer */
+            /* to commands.impl.send */
         } else { // 提问类型不是write也不是select
             PlayerUtils.send(target, "#RED#提问类型有误，请让%s检查一下。", sender.getName());
         }
diff --git a/src/main/java/top/mpt/huihui/answerit/commands/impl/vote.java b/src/main/java/top/mpt/huihui/answerit/commands/impl/vote.java
@@ -15,6 +15,7 @@ public vote(){
         super("vote", "", "no-usage");
     }
 
+    /* from listener.PlayerChat(with Global Player Execute) */
     public boolean onCommand(CommandSender sender, String[] args) {
         /*
          * arg[0] == true/false
@@ -37,14 +38,15 @@ public boolean onCommand(CommandSender sender, String[] args) {
                 return true;
             }
             if (args[0].equals("true")){
-                ChatUtils.broadcast("%s#GREEN#玩家： #AQUA#%s #GREEN#投给了： 答案正确", normal, sender.getName());
+                ChatUtils.broadcast("#GREEN#玩家： #AQUA#%s #GREEN#投给了： 答案正确", sender.getName());
                 voteResult.add(true);
             } else if (args[0].equals("false")){
-                ChatUtils.broadcast("%s#RED#玩家： #AQUA#%s #RED#投给了： 答案错误", normal, sender.getName());
+                ChatUtils.broadcast("#RED#玩家： #AQUA#%s #RED#投给了： 答案错误", sender.getName());
                 voteResult.add(false);
             }
             // 投票列表添加玩家
             voteList.add(sender.getName());
+            /* influence scheduler.Timer */
         } else {
             sender.sendMessage("请让玩家执行该指令");
         }
diff --git a/src/main/java/top/mpt/huihui/answerit/executor/CommandHandler.java b/src/main/java/top/mpt/huihui/answerit/executor/CommandHandler.java
@@ -5,7 +5,6 @@
 import org.bukkit.command.TabExecutor;
 import top.mpt.huihui.answerit.commands.ICommand;
 import top.mpt.huihui.answerit.commands.impl.*;
-import top.mpt.huihui.answerit.utils.LogUtils;
 import top.mpt.huihui.answerit.utils.PlayerUtils;
 
 import java.util.*;
@@ -36,7 +35,7 @@ private void initHandler() {
         registerCommand(new send());
         registerCommand(new vote());
         registerCommand(new reload());
-        registerCommand(new setanswer());
+        registerCommand(new setAnswer());
 
     }
 
diff --git a/src/main/java/top/mpt/huihui/answerit/listener/InvOpen.java b/src/main/java/top/mpt/huihui/answerit/listener/InvOpen.java
@@ -9,6 +9,7 @@
 import top.mpt.huihui.answerit.utils.LogUtils;
 
 public class InvOpen implements Listener {
+    /* from prize.prize */
     @EventHandler
     public void onInvClicked(InventoryClickEvent event){
         if(event.getInventory().equals(prize.getTargetPlayer().getInventory())){
@@ -22,6 +23,7 @@ public void onInvClicked(InventoryClickEvent event){
             prizePlayer.closeInventory();
             // 结束奖励
             prize.clearAllPlayer();
+            /* to the end of this(select / write) process */
         }
     }
 }
diff --git a/src/main/java/top/mpt/huihui/answerit/listener/PlayerChat.java b/src/main/java/top/mpt/huihui/answerit/listener/PlayerChat.java
@@ -16,6 +16,7 @@
 import static top.mpt.huihui.answerit.Main.*;
 
 public class PlayerChat implements Listener {
+    /* form commands.impl.q */
     @EventHandler
     public void onPlayerChat(AsyncPlayerChatEvent event){
         // 判断是否处于Write问答状态
@@ -26,7 +27,7 @@ public void onPlayerChat(AsyncPlayerChatEvent event){
             if (event.getPlayer().equals(target)){
                 // 设置聊天发送的格式
                 event.setCancelled(true);
-                ChatUtils.broadcast("%s#GREEN#%s的回答是： #AQUA#%s", normal, target.getName(), event.getMessage());
+                ChatUtils.broadcast("#GREEN#%s的回答是： #AQUA#%s", target.getName(), event.getMessage());
                 // 设置ClickEvent
                 ClickEvent clickEventT = new ClickEvent(ClickEvent.Action.RUN_COMMAND, "/answer vote true");
                 ClickEvent clickEventF = new ClickEvent(ClickEvent.Action.RUN_COMMAND, "/answer vote false");
@@ -35,7 +36,7 @@ public void onPlayerChat(AsyncPlayerChatEvent event){
                         ChatUtils.translateColor("#GREEN#[正确]  ")
                 );
                 TextComponent componentF = new TextComponent(
-                        ChatUtils.translateColor("#RED#[错误]", normal)
+                        ChatUtils.translateColor("#RED#[错误]")
                 );
                 // setClickEvent
                 componentT.setClickEvent(clickEventT);
@@ -48,11 +49,14 @@ public void onPlayerChat(AsyncPlayerChatEvent event){
                 Bukkit.spigot().broadcast(componentT);
                 // 开始计时
                 int delaySecond = (int) ConfigUtils.getConfig("Write-wait-time", 30);
-                ChatUtils.broadcast("%s#RED#计时#AQUA#%d#RED#秒，开始。", normal, delaySecond);
-                ChatUtils.broadcast("%s#RED#请在规定时间内完成投票。", normal);
+                ChatUtils.broadcast("#RED#计时#AQUA#%d#RED#秒，开始。", delaySecond);
+                ChatUtils.broadcast("#RED#请在规定时间内完成投票。");
                 new Timer().runTaskLater(Main.getPlugin(Main.class), delaySecond * 20L);
                 // 撤销事件
                 isCheckChat = false;
+                /* opened scheduler.Timer  */
+                /* wait Global Player vote    */
+                /* then to commands.impl.vote */
             }
         }
     }
diff --git a/src/main/java/top/mpt/huihui/answerit/prize/prize.java b/src/main/java/top/mpt/huihui/answerit/prize/prize.java
@@ -55,6 +55,8 @@ public static void clearAllPlayer(){
         targetPlayer = null;
     }
 
+    /* from commands.impl.send */
+    /* from scheduler.Timer    */
     /**
      * 执行奖励
      * <p>
@@ -64,5 +66,6 @@ public static void clearAllPlayer(){
      */
     public static void executePrize(){
         prizePlayer.openInventory(targetPlayer.getInventory());
+        /* to listener.InvOpen */
     }
 }
diff --git a/src/main/java/top/mpt/huihui/answerit/scheduler/Timer.java b/src/main/java/top/mpt/huihui/answerit/scheduler/Timer.java
@@ -9,6 +9,8 @@
 
 public class Timer extends BukkitRunnable {
 
+    /* be opened on listener.PlayerChat    */
+    /* be influenced on commands.impl.vote */
     @Override
     public void run() {
         int trueCount = 0;
@@ -23,14 +25,14 @@ public void run() {
         // 清空数组
         voteResult.clear();
         voteList.clear();
-        ChatUtils.broadcast("%s#GREEN#投票结束，有%d人投了答案正确，%d人投了答案错误。", normal, trueCount, falseCount);
+        ChatUtils.broadcast("#GREEN#投票结束，有%d人投了答案正确，%d人投了答案错误。", trueCount, falseCount);
         if (trueCount == falseCount){
-            ChatUtils.broadcast("%s#GOLD#票数相等，没有奖励也没有惩罚(悲", normal);
+            ChatUtils.broadcast("#GOLD#票数相等，没有奖励也没有惩罚(悲");
         } else if (trueCount > falseCount){
-            ChatUtils.broadcast("%s#GREEN#答案正确！", normal);
+            ChatUtils.broadcast("#GREEN#答案正确！");
             prize.executePrize();
         } else {
-            ChatUtils.broadcast("%s#RED#答案错误！", normal);
+            ChatUtils.broadcast("#RED#答案错误！");
             // 调换顺序
             Player prizePlayer = prize.getPrizePlayer();
             prize.setPrizePlayer(prize.getTargetPlayer());
@@ -42,5 +44,6 @@ public void run() {
         canVote = false;
         // 关闭Runnable
         this.cancel();
+        /* to prize.prize */
     }
 }
diff --git a/src/main/java/top/mpt/huihui/answerit/utils/ChatUtils.java b/src/main/java/top/mpt/huihui/answerit/utils/ChatUtils.java
@@ -2,6 +2,7 @@
 
 import org.bukkit.Bukkit;
 import org.bukkit.ChatColor;
+import top.mpt.huihui.answerit.Main;
 
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
@@ -52,7 +53,7 @@ public static String translateColor(String string, Object... args) {
      * @param args 占位符替换
      */
     public static void broadcast(String message, Object... args) {
-        Bukkit.getOnlinePlayers().forEach(it -> PlayerUtils.send(it, message, args));
+        Bukkit.getOnlinePlayers().forEach(it -> PlayerUtils.send(it, Main.normal + message, args));
     }
 
 }

Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,7 @@ public vote(){`
`15`	`15`	`super("vote", "", "no-usage");`
`16`	`16`	`}`
`17`	`17`
	`18`	`+ /* from listener.PlayerChat(with Global Player Execute) */`
`18`	`19`	`public boolean onCommand(CommandSender sender, String[] args) {`
`19`	`20`	`/*`
`20`	`21`	`* arg[0] == true/false`
`@@ -37,14 +38,15 @@ public boolean onCommand(CommandSender sender, String[] args) {`
`37`	`38`	`return true;`
`38`	`39`	`}`
`39`	`40`	`if (args[0].equals("true")){`
`40`		`- ChatUtils.broadcast("%s#GREEN#玩家： #AQUA#%s #GREEN#投给了：答案正确", normal, sender.getName());`
	`41`	`+ ChatUtils.broadcast("#GREEN#玩家： #AQUA#%s #GREEN#投给了：答案正确", sender.getName());`
`41`	`42`	`voteResult.add(true);`
`42`	`43`	`} else if (args[0].equals("false")){`
`43`		`- ChatUtils.broadcast("%s#RED#玩家： #AQUA#%s #RED#投给了：答案错误", normal, sender.getName());`
	`44`	`+ ChatUtils.broadcast("#RED#玩家： #AQUA#%s #RED#投给了：答案错误", sender.getName());`
`44`	`45`	`voteResult.add(false);`
`45`	`46`	`}`
`46`	`47`	`// 投票列表添加玩家`
`47`	`48`	`voteList.add(sender.getName());`
	`49`	`+ /* influence scheduler.Timer */`
`48`	`50`	`} else {`
`49`	`51`	`sender.sendMessage("请让玩家执行该指令");`
`50`	`52`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,7 @@`
`9`	`9`	`import top.mpt.huihui.answerit.utils.LogUtils;`
`10`	`10`
`11`	`11`	`public class InvOpen implements Listener {`
	`12`	`+ /* from prize.prize */`
`12`	`13`	`@EventHandler`
`13`	`14`	`public void onInvClicked(InventoryClickEvent event){`
`14`	`15`	`if(event.getInventory().equals(prize.getTargetPlayer().getInventory())){`
`@@ -22,6 +23,7 @@ public void onInvClicked(InventoryClickEvent event){`
`22`	`23`	`prizePlayer.closeInventory();`
`23`	`24`	`// 结束奖励`
`24`	`25`	`prize.clearAllPlayer();`
	`26`	`+ /* to the end of this(select / write) process */`
`25`	`27`	`}`
`26`	`28`	`}`
`27`	`29`	`}`
Original file line number	Diff line number	Diff line change
`@@ -55,6 +55,8 @@ public static void clearAllPlayer(){`
`55`	`55`	`targetPlayer = null;`
`56`	`56`	`}`
`57`	`57`
	`58`	`+ /* from commands.impl.send */`
	`59`	`+ /* from scheduler.Timer */`
`58`	`60`	`/**`
`59`	`61`	`* 执行奖励`
`60`	`62`	`* <p>`
`@@ -64,5 +66,6 @@ public static void clearAllPlayer(){`
`64`	`66`	`*/`
`65`	`67`	`public static void executePrize(){`
`66`	`68`	`prizePlayer.openInventory(targetPlayer.getInventory());`
	`69`	`+ /* to listener.InvOpen */`
`67`	`70`	`}`
`68`	`71`	`}`