├── README.md
├── src
└── main
│ └── java
│ └── com
│ └── ultikits
│ └── lib
│ ├── common
│ └── CheckResponse.java
│ ├── annotations
│ ├── RunAsync.java
│ ├── CmdCD.java
│ ├── CmdTarget.java
│ ├── CmdSender.java
│ ├── CmdSuggest.java
│ ├── UsageLimit.java
│ ├── CmdExecutor.java
│ ├── CmdMapping.java
│ └── CmdParam.java
│ ├── managers
│ └── CommandManager.java
│ └── abstracts
│ └── AbstractCommendExecutor.java
├── .gitignore
└── pom.xml
/README.md:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/src/main/java/com/ultikits/lib/common/CheckResponse.java:
--------------------------------------------------------------------------------
1 | package com.ultikits.lib.common;
2 |
3 | import lombok.Getter;
4 |
5 | @Getter
6 | public class CheckResponse {
7 | public static CheckResponse SUCCESS = new CheckResponse();
8 | private final String message;
9 | private final boolean success;
10 |
11 | public CheckResponse() {
12 | this.message = "";
13 | this.success = true;
14 | }
15 |
16 | public CheckResponse(String message) {
17 | this.message = message;
18 | this.success = false;
19 | }
20 |
21 | }
22 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | target/
2 | !.mvn/wrapper/maven-wrapper.jar
3 | !**/src/main/**/target/
4 | !**/src/test/**/target/
5 |
6 | ### IntelliJ IDEA ###
7 | .idea/
8 | *.iws
9 | *.iml
10 | *.ipr
11 |
12 | ### Eclipse ###
13 | .apt_generated
14 | .classpath
15 | .factorypath
16 | .project
17 | .settings
18 | .springBeans
19 | .sts4-cache
20 |
21 | ### NetBeans ###
22 | /nbproject/private/
23 | /nbbuild/
24 | /dist/
25 | /nbdist/
26 | /.nb-gradle/
27 | build/
28 | !**/src/main/**/build/
29 | !**/src/test/**/build/
30 |
31 | ### VS Code ###
32 | .vscode/
33 |
34 | ### Mac OS ###
35 | .DS_Store
36 |
--------------------------------------------------------------------------------
/src/main/java/com/ultikits/lib/annotations/RunAsync.java:
--------------------------------------------------------------------------------
1 | package com.ultikits.lib.annotations;
2 |
3 | import java.lang.annotation.ElementType;
4 | import java.lang.annotation.Retention;
5 | import java.lang.annotation.RetentionPolicy;
6 | import java.lang.annotation.Target;
7 |
8 | /**
9 | * Run async annotation.
10 | *
11 | * 指令异步注解。
12 | *
13 | * @see @RunAsync
14 | */
15 | @Target(ElementType.METHOD)
16 | @Retention(RetentionPolicy.RUNTIME)
17 | public @interface RunAsync {
18 | }
19 |
--------------------------------------------------------------------------------
/src/main/java/com/ultikits/lib/annotations/CmdCD.java:
--------------------------------------------------------------------------------
1 | package com.ultikits.lib.annotations;
2 |
3 | import java.lang.annotation.ElementType;
4 | import java.lang.annotation.Retention;
5 | import java.lang.annotation.RetentionPolicy;
6 | import java.lang.annotation.Target;
7 |
8 | /**
9 | * Command cooldown annotation.
10 | *
11 | * 指令冷却注解。
12 | *
13 | * @see Command cooldown
14 | */
15 | @Target(ElementType.METHOD)
16 | @Retention(RetentionPolicy.RUNTIME)
17 | public @interface CmdCD {
18 | /**
19 | * @return cooldown time in seconds
11 | * 指令目标注解。
12 | *
13 | * @see @CmdTarget
14 | */
15 | @Target({ElementType.TYPE, ElementType.METHOD})
16 | @Retention(RetentionPolicy.RUNTIME)
17 | public @interface CmdTarget {
18 | CmdTargetType value();
19 |
20 | enum CmdTargetType {
21 | PLAYER,
22 | CONSOLE,
23 | BOTH
24 | }
25 | }
26 |
--------------------------------------------------------------------------------
/src/main/java/com/ultikits/lib/annotations/CmdSender.java:
--------------------------------------------------------------------------------
1 | package com.ultikits.lib.annotations;
2 |
3 | import java.lang.annotation.ElementType;
4 | import java.lang.annotation.Retention;
5 | import java.lang.annotation.RetentionPolicy;
6 | import java.lang.annotation.Target;
7 |
8 | /**
9 | * Command sender annotation.
11 | * 指令发送者注解。Command Excutor
14 | */
15 | @Target(ElementType.PARAMETER)
16 | @Retention(RetentionPolicy.RUNTIME)
17 | public @interface CmdSender {
18 | }
19 |
--------------------------------------------------------------------------------
/src/main/java/com/ultikits/lib/annotations/CmdSuggest.java:
--------------------------------------------------------------------------------
1 | package com.ultikits.lib.annotations;
2 |
3 | import java.lang.annotation.ElementType;
4 | import java.lang.annotation.Retention;
5 | import java.lang.annotation.RetentionPolicy;
6 | import java.lang.annotation.Target;
7 |
8 | /**
9 | * Command suggest annotation.
10 | *
11 | * 指令建议注解。
12 | *
13 | * @see @CmdSuggest
14 | */
15 | @Target({ElementType.TYPE, ElementType.METHOD})
16 | @Retention(RetentionPolicy.RUNTIME)
17 | public @interface CmdSuggest {
18 | /**
19 | * @return suggest class
21 | * 建议类
11 | * 指令使用限制注解。
12 | *
13 | * @see @UsageLimit
14 | */
15 | @Target(ElementType.METHOD)
16 | @Retention(RetentionPolicy.RUNTIME)
17 | public @interface UsageLimit {
18 | /**
19 | * @return limit type
8 | * 命令标记注释
9 | *
10 | * @author qianmo
11 | * @version 1.0.0
12 | * @see Command Excutor
13 | */
14 | @Documented
15 | @Target(ElementType.TYPE)
16 | @Retention(RetentionPolicy.RUNTIME)
17 | public @interface CmdExecutor {
18 |
19 | /**
20 | * @return permission
11 | * 指令映射注解。
12 | *
13 | * @see Command Excutor
14 | */
15 | @Retention(RetentionPolicy.RUNTIME)
16 | @Target(ElementType.METHOD)
17 | public @interface CmdMapping {
18 | /**
19 | * @return command format
11 | * 指令参数注解。
12 | *
13 | * @see Command Excutor
14 | */
15 | @Retention(RetentionPolicy.RUNTIME)
16 | @Target(ElementType.PARAMETER)
17 | public @interface CmdParam {
18 | /**
19 | * @return parameter name
5 | 4.0.0
6 |
7 | com.ultikits.lib
8 | UltiKits-Command
9 | 1.0.0
10 |
11 |
12 |
13 | wisdomme
14 | xia.erich03@gmail.com
15 | UltiKits
16 | +10
17 |
18 |
19 |
20 |
21 | 17
22 | 17
23 | UTF-8
24 | 5.8.25
25 |
26 |
27 |
28 |
29 | spigotmc-repo
30 | https://hub.spigotmc.org/nexus/content/repositories/snapshots/
31 |
32 |
33 | sonatype
34 | https://oss.sonatype.org/content/groups/public/
35 |
36 |
37 |
38 |
39 |
40 | org.spigotmc
41 | spigot-api
42 | 1.19.3-R0.1-SNAPSHOT
43 | provided
44 |
45 |
46 | org.projectlombok
47 | lombok
48 | 1.18.32
49 | provided
50 |
51 |
52 | org.jetbrains
53 | annotations
54 | 24.0.1
55 |
56 |
57 | cn.hutool
58 | hutool-core
59 | ${hutool.version}
60 |
61 |
62 |
63 |
--------------------------------------------------------------------------------
/src/main/java/com/ultikits/lib/managers/CommandManager.java:
--------------------------------------------------------------------------------
1 | package com.ultikits.lib.managers;
2 |
3 | import com.ultikits.lib.abstracts.AbstractCommendExecutor;
4 | import lombok.Getter;
5 | import org.bukkit.Bukkit;
6 | import org.bukkit.command.Command;
7 | import org.bukkit.command.CommandMap;
8 | import org.bukkit.command.PluginCommand;
9 | import org.bukkit.plugin.Plugin;
10 | import org.bukkit.plugin.SimplePluginManager;
11 |
12 | import java.lang.reflect.Constructor;
13 | import java.lang.reflect.Field;
14 | import java.util.ArrayList;
15 | import java.util.List;
16 |
17 | /**
18 | * Command manager.
19 | *
20 | * 命令管理器
21 | */
22 | public class CommandManager {
23 | private final List commandList = new ArrayList<>();
24 | @Getter
25 | private final Plugin plugin;
26 |
27 | /**
28 | * Constructs a new CommandManager instance.
29 | *
30 | * @param plugin The plugin instance.
31 | */
32 | public CommandManager(Plugin plugin) {
33 | this.plugin = plugin;
34 | }
35 |
36 | /**
37 | * Register command.
38 | *
39 | * 注册命令
40 | *
41 | * @param commandExecutor Command executor
63 | * 注销插件注册的所有命令
64 | */
65 | public void unregisterAll() {
66 | for (Command command : commandList) {
67 | unregister(command.getName());
68 | }
69 | }
70 |
71 | /**
72 | * Creates a new PluginCommand instance using reflection.
73 | *
74 | * @param name The name of the command.
75 | * @param plugin The plugin instance.
76 | * @return A new PluginCommand instance, or null if an error occurred.
77 | */
78 | private PluginCommand getCommand(String name, Plugin plugin) {
79 | PluginCommand command = null;
80 |
81 | try {
82 | Constructor c = PluginCommand.class.getDeclaredConstructor(String.class, Plugin.class);
83 | c.setAccessible(true);
84 |
85 | command = c.newInstance(name, plugin);
86 | } catch (Exception | Error e) {
87 | e.printStackTrace();
88 | }
89 |
90 | return command;
91 | }
92 |
93 | /**
94 | * Retrieves the CommandMap instance using reflection.
95 | *
96 | * @return The CommandMap instance, or null if an error occurred.
97 | */
98 | private CommandMap getCommandMap() {
99 | CommandMap commandMap = null;
100 |
101 | try {
102 | if (Bukkit.getPluginManager() instanceof SimplePluginManager) {
103 | Field f = SimplePluginManager.class.getDeclaredField("commandMap");
104 | f.setAccessible(true);
105 |
106 | commandMap = (CommandMap) f.get(Bukkit.getPluginManager());
107 | }
108 | } catch (Exception | Error e) {
109 | e.printStackTrace();
110 | }
111 |
112 | return commandMap;
113 | }
114 |
115 | }
116 |
--------------------------------------------------------------------------------
/src/main/java/com/ultikits/lib/abstracts/AbstractCommendExecutor.java:
--------------------------------------------------------------------------------
1 | package com.ultikits.lib.abstracts;
2 |
3 | import cn.hutool.core.util.ReflectUtil;
4 | import com.google.common.collect.BiMap;
5 | import com.google.common.collect.HashBiMap;
6 | import com.ultikits.lib.annotations.*;
7 | import com.ultikits.lib.common.CheckResponse;
8 | import lombok.Getter;
9 | import lombok.Setter;
10 | import org.bukkit.Bukkit;
11 | import org.bukkit.ChatColor;
12 | import org.bukkit.Material;
13 | import org.bukkit.OfflinePlayer;
14 | import org.bukkit.command.Command;
15 | import org.bukkit.command.CommandSender;
16 | import org.bukkit.command.TabExecutor;
17 | import org.bukkit.entity.Player;
18 | import org.bukkit.plugin.Plugin;
19 | import org.bukkit.scheduler.BukkitRunnable;
20 | import org.jetbrains.annotations.NotNull;
21 | import org.jetbrains.annotations.Nullable;
22 |
23 | import java.lang.annotation.Annotation;
24 | import java.lang.reflect.Array;
25 | import java.lang.reflect.Method;
26 | import java.lang.reflect.Parameter;
27 | import java.util.*;
28 | import java.util.function.Function;
29 |
30 | /**
31 | * This abstract class represents a command executor.
32 | * It implements the TabExecutor interface from the Bukkit API.
33 | *
34 | * 这个抽象类代表了一个命令执行器。
35 | * 它实现了Bukkit API中的TabExecutor接口。
36 | *
37 | * @see TabExecutor
38 | */
39 | public abstract class AbstractCommendExecutor implements TabExecutor {
40 | private final BiMap mappings = HashBiMap.create();
41 | private final BiMap senderLock = HashBiMap.create();
42 | private final BiMap serverLock = HashBiMap.create();
43 | private final BiMap cmdCoolDown = HashBiMap.create();
44 | @Getter
45 | private final Map>, Function> parsers = new HashMap<>();
46 | @Setter
47 | private Plugin plugin;
48 |
49 | /**
50 | * Constructor that initializes parsers and scans command mappings.
51 | *
52 | * 构造函数，初始化解析器并扫描命令映射。
53 | */
54 | public AbstractCommendExecutor() {
55 | initParsers();
56 | scanCommandMappings();
57 | }
58 |
59 | /**
60 | * Checks whether the sender is valid.
61 | *
62 | * 检查发送者是否有效。
63 | *
64 | * @param sender The sender of the command.
80 | * 从命令中获取参数匹配的映射。
81 | *
82 | * @param args The arguments of the command. getParams(String[] args, String format) {
87 | if (args.length == 0) {
88 | return Collections.emptyMap();
89 | }
90 |
91 | String[] formatArgs = format.split(" ");
92 | Map params = new HashMap<>();
93 | List paramList = new ArrayList<>();
94 | int index = 0;
95 | for (String arg : args) {
96 | String currentFormatArg = formatArgs[index];
97 | if (currentFormatArg.startsWith("<")) {
98 | String paramName = currentFormatArg.substring(1, currentFormatArg.length() - (currentFormatArg.endsWith("...>") ? 4 : 1));
99 | if (currentFormatArg.endsWith("...>")) {
100 | paramList.add(arg);
101 | } else {
102 | params.put(paramName, new String[]{arg});
103 | }
104 | }
105 | index++;
106 | }
107 |
108 | if (!paramList.isEmpty()) {
109 | params.put(formatArgs[index].substring(1, formatArgs[index].length() - 1), paramList.toArray(new String[0]));
110 | }
111 |
112 | return params;
113 | }
114 |
115 | /**
116 | * Gets the instance of the command executor.
117 | *
118 | * 获取命令执行器的实例。
119 | *
120 | * @return The instance of the command executor.
129 | * 初始化解析器。
130 | */
131 | @SuppressWarnings("deprecation")
132 | private void initParsers() {
133 | parsers.put(Arrays.asList(Boolean[].class, Boolean.class, boolean[].class, boolean.class), Boolean::parseBoolean);
134 | parsers.put(Arrays.asList(Double[].class, Double.class, double[].class, double.class), Double::parseDouble);
135 | parsers.put(Arrays.asList(Integer[].class, Integer.class, int[].class, int.class), Integer::parseInt);
136 | parsers.put(Arrays.asList(Float[].class, Float.class, float[].class, float.class), Float::parseFloat);
137 | parsers.put(Arrays.asList(Short[].class, Short.class, short[].class, short.class), Short::parseShort);
138 | parsers.put(Arrays.asList(Short[].class, Short.class, short[].class, short.class), Byte::parseByte);
139 | parsers.put(Arrays.asList(OfflinePlayer[].class, OfflinePlayer.class), Bukkit::getOfflinePlayer);
140 | parsers.put(Arrays.asList(Long[].class, Long.class, long[].class, long.class), Long::parseLong);
141 | parsers.put(Arrays.asList(Material[].class, Material.class), Material::getMaterial);
142 | parsers.put(Arrays.asList(Player[].class, Player.class), Bukkit::getPlayerExact);
143 | parsers.put(Arrays.asList(UUID[].class, UUID.class), UUID::fromString);
144 | parsers.put(Arrays.asList(String[].class, String.class), s -> s);
145 | }
146 |
147 | /**
148 | * Gets the parser of the parameter.
149 | *
150 | * 获取参数的解析器。
151 | *
152 | * @param type The type of the parameter. The type of the parameter. Function getParser(Class type) {
157 | //noinspection unchecked
158 | return (Function) parsers.keySet().stream()
159 | .filter(classes -> classes.stream().anyMatch(clazz -> clazz.isAssignableFrom(type)))
160 | .findFirst()
161 | .map(parsers::get)
162 | .orElse(null);
163 | }
164 |
165 | /**
166 | * Scans the command mappings.
167 | *
168 | * 扫描命令映射。
169 | */
170 | private void scanCommandMappings() {
171 | Class clazz = this.getClass();
172 | Method[] methods = clazz.getDeclaredMethods();
173 | for (Method method : methods) {
174 | if (method.isAnnotationPresent(CmdMapping.class)) {
175 | mappings.put(method.getAnnotation(CmdMapping.class).format(), method);
176 | }
177 | }
178 | }
179 |
180 | /**
181 | * Matches the command.
182 | *
183 | * 匹配命令。
184 | *
185 | * @param args The arguments of the command. entry : mappings.entrySet()) {
193 | String format = entry.getKey();
194 | String[] formatArgs = format.split(" ");
195 |
196 | boolean match = true;
197 |
198 | // 检查参数长度是否一致
199 | if (formatArgs.length != args.length) {
200 | // 参数长度不一致 取可配对参数的最小值
201 | int min = Math.min(formatArgs.length, args.length);
202 |
203 | // 逐个匹配
204 | for (int i = 0; i < min; i++) {
205 | if (!matchesArgument(formatArgs[i], args[i])) {
206 | match = false;
207 | break;
208 | }
209 | }
210 |
211 | // 如果所有参数都匹配，返回这个方法
212 | if (match) {
213 | return entry.getValue();
214 | }
215 |
216 | // 如果不完全匹配，继续下一次循环
217 | continue;
218 | }
219 |
220 | for (int i = 0; i < formatArgs.length - 1; i++) {
221 | if (!matchesArgument(formatArgs[i], args[i])) {
222 | match = false;
223 | break;
224 | }
225 | }
226 |
227 | if (match && matchesLastArgument(formatArgs[formatArgs.length - 1], args[formatArgs.length - 1])) {
228 | return entry.getValue();
229 | }
230 | }
231 | return null;
232 | }
233 |
234 | /**
235 | * Compare the actual argument with the format argument.
236 | *
237 | * 将实际参数与格式参数进行比较。
238 | *
239 | * @param formatArg The format argument.
250 | * 将实际参数与格式参数进行比较。
251 | *
252 | * @param formatArg The format argument.
266 | * 检查发送者是否有效。
267 | *
268 | * @param sender The sender of the command.
289 | * 检查发送者是否有权限。
290 | *
291 | * @param sender The sender of the command.
320 | * 检查发送者是否需要是OP。
321 | *
322 | * @param sender The sender of the command.
346 | * 检查发送者是否需要等待上一条命令执行完毕。
347 | *
348 | * @param sender The sender of the command.
378 | * 检查发送者是否需要等待命令冷却。
379 | *
380 | * @param sender The sender of the command.
395 | * 构建命令的参数。
396 | *
397 | * @param strings The arguments of the command. params = getParams(strings, mappings.inverse().get(method));
404 | Parameter[] parameters = method.getParameters();
405 |
406 | if (parameters.length == 0) {
407 | return new Object[0];
408 | }
409 |
410 | List paramList = new ArrayList<>();
411 |
412 | for (Parameter parameter : parameters) {
413 | Class paramType = parameter.getType();
414 |
415 | if (paramType.equals(Player.class) || paramType.equals(CommandSender.class)) {
416 | boolean isCmdSenderAnnotationPresent = parameter.isAnnotationPresent(CmdSender.class);
417 |
418 | if (paramType.equals(Player.class) && commandSender instanceof Player) {
419 | paramList.add(isCmdSenderAnnotationPresent ? commandSender : null);
420 | } else if (paramType.equals(CommandSender.class)) {
421 | paramList.add(isCmdSenderAnnotationPresent ? commandSender : null);
422 | }
423 |
424 | continue;
425 | }
426 |
427 | if (parameter.isAnnotationPresent(CmdParam.class)) {
428 | CmdParam cmdParam = parameter.getAnnotation(CmdParam.class);
429 | String[] value = params.get(cmdParam.value());
430 | try {
431 | paramList.add(parseType(value, paramType));
432 | } catch (Exception | Error e) {
433 | commandSender.sendMessage(ChatColor.RED + e.getMessage());
434 | //noinspection CallToPrintStackTrace
435 | e.printStackTrace();
436 | return null;
437 | }
438 | } else {
439 | paramList.add(null);
440 | }
441 | }
442 | return paramList.toArray();
443 | }
444 |
445 | /**
446 | * Parses the type of the parameter.
447 | *
448 | * 解析参数的类型。
449 | *
450 | * @param value The value of the parameter. The type of the parameter. Object parseType(String[] value, Class type) {
456 | Function parser = getParser(type);
457 | if (type.isArray()) {
458 | Object array = Array.newInstance(type.getComponentType(), value.length);
459 | for (int i = 0; i < value.length; i++) {
460 | Array.set(array, i, parser.apply(value[i]));
461 | }
462 | return array;
463 | } else {
464 | return parser.apply(value[0]);
465 | }
466 | }
467 |
468 | /**
469 | * Sets the cool down of the command.
470 | *
471 | * 设置命令的冷却。
472 | *
473 | * @param commandSender The sender of the command.
507 | * 处理帮助命令的抽象方法。
508 | *
509 | * @param sender The sender of the command.
517 | * 补全方法。返回指定命令字符串的可能补全列表。
518 | * 通过重写此方法，您可以自定义命令的补全。
519 | *
520 | * @param player The player who will see the suggestions. suggest(Player player, Command command, String[] strings) {
526 | List completions = new ArrayList<>();
527 | if (strings.length == 1) {
528 | for (Map.Entry entry : mappings.entrySet()) {
529 | Method method = entry.getValue();
530 | String format = entry.getKey();
531 | if (!checkPermission(player, method).isSuccess() || !checkOp(player, method).isSuccess()) {
532 | continue;
533 | }
534 | String arg = format.split(" ")[0];
535 | if (arg.startsWith("<") && arg.endsWith(">")) {
536 | getArgSuggestion(player, command, strings, method, arg, completions);
537 | continue;
538 | }
539 | completions.add(arg);
540 | }
541 | return completions;
542 | } else {
543 | List methodsByArg = getMethodsByArg(player, String.join(" ", strings));
544 | for (Method method : methodsByArg) {
545 | String formatByMethod = getFormatByMethod(method);
546 | String arg = getArgAt(formatByMethod, strings.length - 1);
547 | if (arg.startsWith("<") && arg.endsWith(">")) {
548 | getArgSuggestion(player, command, strings, method, arg, completions);
549 | } else {
550 | for (String format : mappings.keySet()) {
551 | String[] args = format.split(" ");
552 | if (args.length < strings.length) {
553 | continue;
554 | }
555 | String sug = args[strings.length - 1];
556 | if (sug.startsWith("<") && sug.endsWith(">")) {
557 | continue;
558 | }
559 | completions.add(sug);
560 | }
561 | }
562 | }
563 | }
564 | return completions;
565 | }
566 |
567 | /**
568 | * Adds suggestion to the list of suggestions. This method is called by the suggest method.
569 | * Fetch the suggestions by invoking the given method.
570 | *
571 | * 将建议添加到建议列表中。此方法由suggest方法调用。
572 | * 通过调用给定的方法获取建议。
573 | *
574 | * @param player The player who will see the suggestions. completions) {
582 | String suggestName = getSuggestName(method, arg.substring(1, arg.length() - 1));
583 | if (suggestName == null) {
584 | return;
585 | }
586 | Method[] suggestMethod = getSuggestMethodByName(suggestName);
587 | if (suggestMethod == null || suggestMethod.length == 0) {
588 | completions.add(suggestName);
589 | return;
590 | }
591 | Class declaringClass = suggestMethod[0].getDeclaringClass();
592 | Collection suggestObject;
593 | if (this.getClass() != declaringClass) {
594 | Object suggestInstance = ReflectUtil.newInstance(declaringClass);
595 | suggestObject = invokeSuggestMethod(suggestInstance, suggestMethod[0], player, command, strings);
596 | } else {
597 | suggestObject = invokeSuggestMethod(this, suggestMethod[0], player, command, strings);
598 | }
599 | if (suggestObject != null) {
600 | for (Object o : suggestObject) {
601 | completions.add(o.toString());
602 | }
603 | }
604 | }
605 |
606 | /**
607 | * Gets the format of the command.
608 | *
609 | * 获取命令的格式。
610 | *
611 | * @param method The method that matches the command.
621 | * 获取指定索引处的参数。
622 | *
623 | * @param format The format of the command.
638 | * 获取参数的建议方法名称。
639 | *
640 | * @param method The method that matches the command.
666 | * 通过建议方法名称获取建议方法数组。
667 | * 如果建议方法名称以()结尾，则去掉()。
668 | * 优先从当前类中获取建议方法集合。
669 | * 如果当前类上有CmdSuggest注解，则从CmdSuggest注解中获取建议方法集合。
670 | *
671 | * @param suggestName The name of the suggest method.
695 | * 通过建议方法名称获取建议方法数组。
696 | *
697 | * @param suggestName The name of the suggest method.
708 | * 从另一个类中通过方法名称获取方法数组。
709 | *
710 | * @param clazz The class of the suggest method.
722 | * 调用建议方法。按照参数类型注入参数。
723 | *
724 | * @param object The object that the method is invoked from.
755 | * 获取匹配命令的方法。
756 | * 优先获取完全匹配的方法，如果没有完全匹配的方法，则获取部分匹配的方法。
757 | * 如果没有完全匹配的方法和部分匹配的方法，则返回空列表。
758 | * 如果有完全匹配的方法，则只返回完全匹配的方法。
759 | *
760 | * @param player The player who will see the suggestions. getMethodsByArg(Player player, String command) {
765 | List perfectMatch = new ArrayList<>();
766 | List methods = new ArrayList<>();
767 | for (Map.Entry entry : mappings.entrySet()) {
768 | Method method = entry.getValue();
769 | String format = entry.getKey();
770 | if (format.startsWith(command.substring(0, command.lastIndexOf(" ")))) {
771 | if (checkPermission(player, method).isSuccess() && checkOp(player, method).isSuccess()) {
772 | perfectMatch.add(method);
773 | }
774 | } else {
775 | String[] formatArgs = format.split(" ");
776 | String[] commandArgs = command.split(" ");
777 | boolean match = true;
778 | for (int i = 0; i < Math.min(commandArgs.length, formatArgs.length); i++) {
779 | if (!matchesArgument(formatArgs[i], commandArgs[i])) {
780 | match = false;
781 | break;
782 | }
783 | }
784 | if (match) {
785 | if (checkPermission(player, method).isSuccess() && checkOp(player, method).isSuccess()) {
786 | methods.add(method);
787 | }
788 | }
789 | }
790 | }
791 | if (!perfectMatch.isEmpty()) {
792 | return perfectMatch;
793 | } else {
794 | return methods;
795 | }
796 | }
797 |
798 | /**
799 | * @return The help command.
809 | * 执行命令，返回是否成功。
810 | *
811 | * @param commandSender Source of the command
967 | * 请求命令参数的可能补全列表。
968 | *
969 | * @param commandSender Source of the command. For players tab-completing a
970 | * command inside of a command block, this will be the player, not
971 | * the command block.
972 | * @param command Command which was executed
973 | * @param s Alias of the command which was used
974 | * @param strings The arguments passed to the command, including final
975 | * partial argument to be completed
976 | * @return A List of possible completions for the final argument, or null
977 | */
978 | @Nullable
979 | @Override
980 | public List onTabComplete(@NotNull CommandSender commandSender, @NotNull Command command, @NotNull String s, @NotNull String[] strings) {
981 | Class clazz = this.getClass();
982 | if (!(commandSender instanceof Player)) {
983 | return null;
984 | }
985 | if (!clazz.isAnnotationPresent(CmdTarget.class)) {
986 | return null;
987 | }
988 | CmdTarget cmdTarget = clazz.getAnnotation(CmdTarget.class);
989 | if (cmdTarget.value().equals(CmdTarget.CmdTargetType.CONSOLE)) {
990 | return null;
991 | }
992 | return suggest((Player) commandSender, command, strings);
993 | }
994 |
995 | /**
996 | * Handles the error when there is a parameter issue.
997 | *
998 | * @param sender The sender of the command.
999 | * @param message The error message to be sent.
1000 | */
1001 | public void handleParameterError(CommandSender sender, String message) {
1002 | sender.sendMessage(ChatColor.RED + message);
1003 | }
1004 |
1005 | /**
1006 | * Handles the error when the sender is invalid.
1007 | *
1008 | * @param sender The sender of the command.
1009 | * @param message The error message to be sent.
1010 | */
1011 | public void handleSenderError(CommandSender sender, String message) {
1012 | sender.sendMessage(ChatColor.RED + message);
1013 | }
1014 |
1015 | /**
1016 | * Handles the error when the sender lacks permission.
1017 | *
1018 | * @param sender The sender of the command.
1019 | * @param message The error message to be sent.
1020 | */
1021 | public void handlePermissionError(CommandSender sender, String message) {
1022 | sender.sendMessage(ChatColor.RED + message);
1023 | }
1024 |
1025 | /**
1026 | * Handles the error when the sender is not an operator (OP).
1027 | *
1028 | * @param sender The sender of the command.
1029 | * @param message The error message to be sent.
1030 | */
1031 | public void handleOpError(CommandSender sender, String message) {
1032 | sender.sendMessage(ChatColor.RED + message);
1033 | }
1034 |
1035 | /**
1036 | * Handles the error when the sender needs to wait for the previous command to finish.
1037 | *
1038 | * @param sender The sender of the command.
1039 | * @param message The error message to be sent.
1040 | */
1041 | public void handleNotLockError(CommandSender sender, String message) {
1042 | sender.sendMessage(ChatColor.RED + message);
1043 | }
1044 |
1045 | /**
1046 | * Handles the error when the sender needs to wait for the command cooldown.
1047 | *
1048 | * @param sender The sender of the command.
1049 | * @param message The error message to be sent.
1050 | */
1051 | public void handleNotInCDError(CommandSender sender, String message) {
1052 | sender.sendMessage(ChatColor.RED + message);
1053 | }
1054 | }
1055 |
--------------------------------------------------------------------------------