AdvancementInfo

插件

· 作者 CroaBeast

AdvancementInfo 是一个轻量级 API,可让你轻松访问和管理不同服务器实现中的 Minecraft 进度。

0 本站下载 0 关注 更新于 1 年前

最新 1.0 · 1.21.10 · Bukkit / Folia

一键开服(送7天)

AdvancementInfo

AdvancementInfo API 是一个专用库,旨在简化在插件中检索和操作 Minecraft 进度(advancements)的过程。它通过提供统一的接口以及多个使用反射机制来兼容 Bukkit、Paper 和其他服务器内部结构的实现类,抽象了访问进度数据(如标题、描述、图标、标准、奖励和显示设置)的底层复杂性。


概述

该 API 的核心是 AdvancementInfo 接口,它定义了获取进度详细信息的方法。BukkitInfoImpl、ReflectInfoImpl 和 PaperInfoImpl 等实现类通过反射从 Bukkit 的 Advancement 对象中提取数据,并提供:

  • 进度详情: 标题、描述、图标和显示选项。
  • 显示坐标: 进度在界面上的 X 和 Y 位置。
  • 视觉框架: 进度的框架类型(例如 TASK、GOAL、CHALLENGE)。
  • 标准和需求: 定义如何达成进度的数据。
  • 奖励: 完成时获得的奖励信息。

主要功能

  • 统一接口:
    AdvancementInfo 接口提供了访问进度数据的通用 API,无论底层实现如何。

  • 多种实现:
    不同的实现适应各种服务器版本和环境:

    • BukkitInfoImpl: 使用 Bukkit 的标准进度显示方法。
    • ReflectInfoImpl: 利用反射提取高级详细信息。
    • PaperInfoImpl: 专为 Paper 服务器定制,使用 Paper 特定方法和 LegacyComponentSerializer 进行文本转换。
  • 版本兼容性:
    API 会根据服务器的 Minecraft 版本智能选择正确的实现,确保广泛的兼容性。

  • 基于反射:
    反射的使用使 API 能够访问进度的内部字段和方法,即使在 Bukkit API 未直接暴露的情况下也能提供丰富的信息。


使用示例

以下示例展示了如何使用 AdvancementInfo API 检索并显示 Minecraft 进度的信息。

示例:检索进度信息

package com.example.myplugin;

import me.croabeast.advancement.AdvancementInfo;
import org.bukkit.Bukkit;
import org.bukkit.advancement.Advancement;
import org.bukkit.plugin.java.JavaPlugin;

public class MyPlugin extends JavaPlugin {

    @Override
    public void onEnable() {
        // 通过键值检索 Bukkit 进度
        Advancement advancement = Bukkit.getAdvancement(new org.bukkit.NamespacedKey(this, "example_advancement"));

        if (advancement != null) {
            // 使用静态工厂方法从进度创建 AdvancementInfo 实例
            AdvancementInfo info = AdvancementInfo.create(advancement);

            if (info != null) {
                // 将进度详情打印到控制台
                getLogger().info("进度标题: " + info.getTitle());
                getLogger().info("描述: " + info.getDescription());

                // 获取格式化后的描述数组,最大行长度为 40 个字符
                String[] lines = info.getDescriptionArray(40);
                for (String line : lines) {
                    getLogger().info("行: " + line);
                }
            } else {
                getLogger().warning("未能检索进度信息。");
            }
        } else {
            getLogger().warning("未找到进度。");
        }
    }
}

说明

  • 检索进度:
    示例通过键值获取 Bukkit Advancement。

  • 使用工厂方法:
    AdvancementInfo.from(advancement) 会根据服务器版本返回适当的实现(Bukkit、Paper 或 Reflect)。

  • 访问进度数据:
    一旦获得 AdvancementInfo 实例,您就可以访问其标题、描述、标准、奖励和显示设置。

  • 格式化描述:
    示例演示了如何将描述拆分为行数组,确保没有一行超过指定的长度。


Maven / Gradle 安装

要将 AdvancementInfo 包含到项目中,请将以下仓库和依赖项添加到您的构建配置中。将 ${version} 替换为所需的版本标签。

Maven

将仓库和依赖项添加到您的 pom.xml 中:

<repositories>
    <repository>
        <id>croabeast-repo</id>
        <url>https://croabeast.github.io/repo/</url>
    </repository>
</repositories>

<dependencies>
    <dependency>
        <groupId>me.croabeast</groupId>
        <artifactId>AdvancementInfo</artifactId>
        <version>${version}</version>
        <scope>compile</scope>
    </dependency>
</dependencies>

Gradle

将仓库和依赖项添加到您的 build.gradle 中:

repositories {
    maven {
        url "https://croabeast.github.io/repo/"
    }
}

dependencies {
    implementation "me.croabeast:AdvancementInfo:${version}"
}

将 ${version} 替换为相应的模块版本。


结论

AdvancementInfo API 提供了一种强大且统一的方式来访问和处理 Minecraft 进度。它抽象化了反射和服务器版本差异带来的复杂性,让你能够专注于在插件中使用进度数据。无论你是构建自定义进度显示、将进度数据集成到插件逻辑中,还是仅仅记录进度详情,该 API 都能让你以一致的方式更轻松地处理进度。

编码愉快!
— CroaBeast

你是这个资源的作者?登录后可认领此资源。

评论 0

0.0
暂无评分
5 星
0
4 星
0
3 星
0
2 星
0
1 星
0
我的评分

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源