ParticleNativeAPI [1.7+]

插件

· 作者 Fierioziy

一个用于 Spigot 和 Bukkit 服务器的快速跨版本粒子 API。

0 本站下载 0 关注 更新于 11 个月前

最新 ParticleNativeAPI 4.5.1 · 1.21.11

一键开服(送7天)

关于 3.x.x 版本的详细信息,请查看 从 3.x.x 迁移到 4.x.x 部分。

ParticleNativeAPI

ParticleNativeAPI 是一个专为 Spigot 和 Bukkit 服务器设计的粒子生成 API,旨在:

  • 快速(性能可与原生 Java 代码相媲美!),
  • 跨版本兼容,支持至 MC 1.7(包含已移除的粒子!),
  • 使用灵活,
  • 相对简单且易于使用。

此外,该粒子 API 支持生成特定类型的粒子:

  • 方块粒子,
  • 物品粒子,
  • 带颜色(每个数据包仅 1 个粒子),
  • 带颜色和大小,
  • 带过渡颜色和大小,
  • 带特定运动轨迹(每个数据包仅 1 个粒子)
  • 带角度
  • 带延迟

……同时保持高速以及在 Minecraft 更新之间的跨版本兼容性。

colors

整个 API 结构旨在反映 Minecraft 发送数据包的方式,但它采用强类型设计且不依赖反射(Reflection)来实现这一目标!

使用方法

生成粒子的过程通过非常简单的链式方法完成:

  • 从 API -> 获取粒子列表 -> 获取粒子
  • 选择粒子的属性
  • 生成粒子数据包
  • 使用粒子列表发送数据包。

就这么简单。

// 从插件实例获取 API
ParticleNativeAPI api = ParticleNativePlugin.getAPI();

// ... 或者使用核心模块生成它(“this” 是你的插件实例) particleApi = ParticleNativeCore.loadAPI(this);

Player player = ...; Location loc = player.getLocation();

// 如此简单即可 particleApi.LIST_1_8.FLAME // 从所需列表中获取粒子 .packet(true, loc) // 生成粒子数据包 .sendTo(player); // 发送给特定的玩家

将数据包发送给谁或在什么条件下发送由你决定。如需了解更多关于上述粒子列表的信息,我鼓励你阅读我 GitHub 仓库中的详细教程 此处。

为什么它很快

它在内部使用 ObjectWeb 的 ASM 库来生成与版本相关的 Java 代码,而不是使用反射。
反射仅用于识别在服务器启动阶段应生成哪个 Minecraft 版本的 API。

简易基准测试

我在本地主机上进行了测试,以测量在我的角色周围随机位置生成 400,000 个粒子的执行时间。

notable 环境配置:
  • 本地主机服务器 MC 1.17
  • JDK 17
  • Intel i5-12600
  • 32 GB RAM DDR4
所有测试均在经过广泛的预热后执行,即多次运行以允许 JVM 优化频繁使用的代码。

然而,这仍然是一个简单的基准测试(并非 JMH 或其他专业工具),因此结果仅供参考,请谨慎看待。


用于测试的所有代码均可在我的仓库中找到 此处。


测试包含 4 种发送粒子的方法:

  • nms - 直接使用 NMS 和 OBC 发送数据包,
  • particle_native_api - 使用本 API 通过简单方法发送粒子,
  • spigot_api - 使用 Spigot API 的 spawnParticle 方法(针对玩家)发送效果,
  • reflection - 使用具有可访问性设置为 true 的 NMS 和 OBC 反射类来发送粒子。这些类/方法/字段会被缓存以供多次使用。

Test

正如你所见,至少在我的机器上,ParticleNativeAPI 的性能与 Spigot API 相当,并且非常接近特定版本实现的速度。

最小化使用示例概述 

public class PluginName extends JavaPlugin {
// 加载的粒子 API
private ParticleNativeAPI particleApi;

@Override
public void onEnable() {
    // 加载 API 并存储以备后用
    particleApi = ParticleNativeCore.loadAPI(this);

    // 或者从正在运行的插件 API 实例中获取它
    // 检查其状态是否正常
  
    // if (ParticelNativePlugin.isValid()) {
    //     particleApi = ParticleNativePlugin.getAPI();
    // }
    // else {
    //     getLogger().log(Level.SEVERE, "加载依赖时发生错误。");
    //     this.setEnabled(false);
    //     return;
    // }
}

// 使用示例
@Override
public boolean onCommand(CommandSender sender, Command command, String label, String[] args) {
    if (!command.getName().equalsIgnoreCase("somecmd")) return true;

    if (!(sender instanceof Player)) {
        sender.sendMessage(ChatColor.RED + "你必须是一名玩家才能使用此命令!");
        return true;
    }

    Player pSender = (Player) sender;
    Location loc = pSender.getLocation();

    // 粒子生成

particleApi.LIST_1_8.FLAME // 从列表中选择粒子 .packet(true, loc) // 创建粒子数据包 .sendInRadiusTo(player, 30D); // 如果玩家在 30 格半径内,则向其发送

    return true;
}

}

服务器管理员须知

如果您是通过其他插件被重定向到此页面,只需将该插件的 jar 文件放入 plugins 文件夹即可。
除了启动阶段外,该库本身不会执行任何操作。它可以作为其他插件的依赖项使用。

插件开发者须知
详细的教程和各种示例可以在我的 GitHub 仓库中找到:这里。

核心 API 的 Maven 配置及示例设置(官方仓库):

   <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-shade-plugin</artifactId>
                <version>3.2.0</version>
                <executions>
                    <execution>
                        <phase>package</phase>
                        <goals>
                            <goal>shade</goal>
                        </goals>
                    &lt;configuration&gt;
                        &lt;!-- 用主构件替换阴影版本 --&gt;
                        &lt;shadedArtifactAttached&gt;false&lt;/shadedArtifactAttached&gt;

                        &lt;!-- 重定位 API 类以避免与使用此核心 API 的其他插件产生相同类路径冲突 --&gt;
                        &lt;relocations&gt;
                            &lt;relocation&gt;
                                &lt;pattern&gt;com.github.fierioziy.particlenativeapi&lt;/pattern&gt;
                                &lt;shadedPattern&gt;me.yourpluginpackage.particleapi&lt;/shadedPattern&gt;
                            &lt;/relocation&gt;
                        &lt;/relocations&gt;
                    &lt;/configuration&gt;
                &lt;/execution&gt;
            &lt;/executions&gt;
        &lt;/plugin&gt;
      
        &lt;!-- 其他插件 ... --&gt;
    &lt;/plugins&gt;
  
    &lt;!-- 其他构建配置 ... --&gt;
&lt;/build&gt;
&lt;dependencies&gt;
    &lt;dependency&gt;
        &lt;groupId&gt;com.github.fierioziy.particlenativeapi&lt;/groupId&gt;
        &lt;artifactId&gt;ParticleNativeAPI-core&lt;/artifactId&gt;
        &lt;version&gt;4.5.0&lt;/version&gt;
        &lt;scope&gt;compile&lt;/scope&gt;
    &lt;/dependency&gt;

    &lt;!-- 其他依赖 --&gt;
&lt;/dependencies&gt;</pre>

插件引用设置的 Maven 配置(官方仓库):

    <dependencies>
        <dependency>
            <groupId>com.github.fierioziy.particlenativeapi</groupId>
            <artifactId>ParticleNativeAPI-plugin</artifactId>
            <version>4.5.0</version>
            <scope>provided</scope>
        </dependency>
    &lt;!-- 其他依赖 --&gt;
&lt;/dependencies&gt;</pre>

请求功能或报告问题

如果您发现了错误或想要请求新功能,请使用我 GitHub 上的 Issue 追踪器:这里。

源代码

所有插件的源代码都在我的 GitHub 仓库中:这里。

对于 3.x.x 版本,当前源代码位于 master-v3 分支:这里。

兼容性
已测试的 Spigot 版本:1.7.10, 1.8.8, 1.12, 1.14.3, 1.15.2, 1.16.5, 1.17, 1.18, 1.19, 1.19.3, 1.20.2, 1.20.6
, 1.21.1, 1.21.3, 1.21.4, 1.21.10.

已测试的 Paper-Spigot 版本(自 1.20.6 起内部存在与 Spigot 的差异):1.20.6, 1.21.3, 1.21.4, 1.21.10.

目前,插件应至少兼容 MC 1.7 到 MC 1.21.10 之间的版本。

它也应该能在 Bukkit (CraftBukkit) 上运行。

只有在添加新功能/修复错误,或者未来版本的 Minecraft 在数据包处理方面发生变化时,才需要更新。

请注意,本 API 将优先考虑向后兼容性
即优先支持 MC 版本范围内的向后兼容,而非自身的前向兼容。

通常情况下,这将以新主要版本的形式发布(例如从 3.x.x 到 4.x.x)

话虽如此,接下来的 API 更新有时可能会迫使您修改代码
以再次与新版本的 API 保持兼容。

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

评论 0

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

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源