1
mirror of https://github.com/CarmJos/EasyPlugin.git synced 2026-06-04 08:38:17 +08:00

feat(papi): 提供便捷的PlaceholderAPI变量实现类。

This commit is contained in:
2023-02-19 03:32:19 +08:00
parent 3019216801
commit a9d26e179c
20 changed files with 154 additions and 20 deletions
+1 -1
View File
@@ -5,7 +5,7 @@
<parent>
<artifactId>easyplugin-parent</artifactId>
<groupId>cc.carm.lib</groupId>
<version>1.4.20</version>
<version>1.5.0</version>
<relativePath>../../pom.xml</relativePath>
</parent>
<modelVersion>4.0.0</modelVersion>
@@ -9,8 +9,10 @@ import org.bukkit.plugin.java.JavaPlugin;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.ArrayList;
import java.util.List;
import java.util.function.Consumer;
import java.util.function.Supplier;
public class EasyPlaceholder extends PlaceholderExpansion {
@@ -108,20 +110,66 @@ public class EasyPlaceholder extends PlaceholderExpansion {
* 处理变量并返回对应内容。
*
* @param identifier 该变量的标识符
* @param handler 该变量的处理器,返回值将会被转换为字符串。
* @param handler 该变量的处理器,返回值将会被转换为字符串。
* @param aliases 该变量的别称
* @return {@link EasyPlaceholder}
*/
public final EasyPlaceholder handle(String identifier, @NotNull PlaceholderHandler handler, @NotNull String... aliases) {
public final EasyPlaceholder handle(@NotNull String identifier, @NotNull PlaceholderHandler handler,
@NotNull String... aliases) {
this.rootExpansion.handle(identifier, handler, aliases);
return this;
}
/**
* 处理变量并返回对应内容。
*
* @param identifier 该变量的标识符
* @param handler 该变量的处理器,返回值将会被转换为字符串。
* @param paramsConsumer 用于提供该变量的可用参数
* @param aliases 该变量的别称
* @return {@link EasyPlaceholder}
*/
public final EasyPlaceholder handle(@NotNull String identifier, @NotNull PlaceholderHandler handler,
@NotNull Consumer<ArrayList<String>> paramsConsumer, @NotNull String... aliases) {
this.rootExpansion.handle(identifier, handler, paramsConsumer, aliases);
return this;
}
/**
* 处理变量并返回对应内容。
*
* @param identifier 该变量的标识符
* @param handler 该变量的处理器,返回值将会被转换为字符串。
* @param availableParams 该变量的可用参数
* @param aliases 该变量的别称
* @return {@link EasyPlaceholder}
*/
public final EasyPlaceholder handle(@NotNull String identifier, @NotNull PlaceholderHandler handler,
@NotNull List<String> availableParams, @NotNull String... aliases) {
this.rootExpansion.handle(identifier, handler, availableParams, aliases);
return this;
}
/**
* 处理变量并返回对应内容。
*
* @param identifier 该变量的标识符
* @param handler 该变量的处理器,返回值将会被转换为字符串。
* @param availableParams 该变量的可用参数
* @param aliases 该变量的别称
* @return {@link EasyPlaceholder}
*/
public final EasyPlaceholder handle(String identifier, @NotNull PlaceholderHandler handler,
@NotNull Supplier<List<String>> availableParams, @NotNull String... aliases) {
this.rootExpansion.handle(identifier, handler, availableParams, aliases);
return this;
}
/**
* 处理一组变量。
*
* @param section 该组变量的标识符
* @param consumer 该组变量的处理器
* @param consumer 该组变量的处理器操作方法
* <br> 在其中可调用 {@link SectionExpansion#handle(String, PlaceholderHandler, String...)} 方法处理子变量,
* <br> 或者调用 {@link SectionExpansion#handleSection(String, Consumer, String...)} 方法处理下一层组变量
* @param aliases 该变量的别称
@@ -61,11 +61,26 @@ public class SectionExpansion implements EasyExpansion {
placeholder.getAliases().forEach(alias -> this.aliasesMap.put(alias.toLowerCase(), name));
}
/**
* 处理变量并返回对应内容。
*
* @param identifier 该变量的标识符
* @param handler 该变量的处理器,返回值将会被转换为字符串。
* @param aliases 该变量的别称
*/
public final void handle(@NotNull String identifier, @NotNull PlaceholderHandler handler,
@NotNull String... aliases) {
handle(identifier, handler, Collections.emptyList(), aliases);
}
/**
* 处理变量并返回对应内容。
*
* @param identifier 该变量的标识符
* @param handler 该变量的处理器,返回值将会被转换为字符串。
* @param paramsConsumer 用于提供该变量的可用参数
* @param aliases 该变量的别称
*/
public final void handle(@NotNull String identifier, @NotNull PlaceholderHandler handler,
@NotNull Consumer<ArrayList<String>> paramsConsumer, @NotNull String... aliases) {
handle(identifier, handler, () -> {
@@ -75,11 +90,27 @@ public class SectionExpansion implements EasyExpansion {
}, aliases);
}
/**
* 处理变量并返回对应内容。
*
* @param identifier 该变量的标识符
* @param handler 该变量的处理器,返回值将会被转换为字符串。
* @param availableParams 该变量的可用参数
* @param aliases 该变量的别称
*/
public final void handle(@NotNull String identifier, @NotNull PlaceholderHandler handler,
@NotNull List<String> availableParams, @NotNull String... aliases) {
handle(identifier, handler, () -> availableParams, aliases);
}
/**
* 处理变量并返回对应内容。
*
* @param identifier 该变量的标识符
* @param handler 该变量的处理器,返回值将会被转换为字符串。
* @param availableParams 该变量的可用参数
* @param aliases 该变量的别称
*/
public final void handle(@NotNull String identifier, @NotNull PlaceholderHandler handler,
@NotNull Supplier<List<String>> availableParams, @NotNull String... aliases) {
register(new SubExpansion<SectionExpansion>(this, identifier, aliases) {
@@ -95,6 +126,15 @@ public class SectionExpansion implements EasyExpansion {
});
}
/**
* 处理一组变量。
*
* @param section 该组变量的标识符
* @param consumer 该组变量的处理器操作方法
* <br> 在其中可调用 {@link SectionExpansion#handle(String, PlaceholderHandler, String...)} 方法处理子变量,
* <br> 或者调用 {@link SectionExpansion#handleSection(String, Consumer, String...)} 方法处理下一层组变量
* @param aliases 该变量的别称
*/
public final void handleSection(@NotNull String section, @NotNull Consumer<SectionExpansion> consumer,
@NotNull String... aliases) {
SectionExpansion sectionExpansion = new SectionExpansion(getRoot(), section, aliases);