ScriptIrc

Chunky Plugin API 知识文档

2026年1月9日 ·

Chunky Plugin API Documentation

概述

Chunky 是一个 Minecraft 服务器插件，用于生成世界区块。本文档提供了 Chunky 插件的 API 接口说明，版本 1.3.41。

包结构

1. org.popcraft.chunky.api

主 API 包，包含核心接口。

2. org.popcraft.chunky.api.event.task

事件包，包含生成任务相关的事件类。

核心接口

ChunkyAPI 接口

public interface ChunkyAPI

Chunky 插件的主要 API 接口，提供了控制世界生成任务的所有方法。

方法列表

1. int version()

获取当前 API 版本。

返回值：

  • int – API 版本号
2. boolean isRunning(String world)

检查指定世界中是否有生成任务正在运行。

参数：

  • world – 世界标识符（字符串）

返回值：

  • boolean – 如果该世界中有任务正在运行则返回 true
3. boolean startTask(String world, String shape, double centerX, double centerZ, double radiusX, double radiusZ, String pattern)

在指定世界中启动一个生成任务。

参数：

  • world – 世界标识符
  • shape – 选择形状
  • centerX – 中心 X 坐标
  • centerZ – 中心 Z 坐标
  • radiusX – 主半径（X 轴）
  • radiusZ – 次半径（Z 轴）（仅用于某些形状）
  • pattern – 生成模式

返回值：

  • boolean – 如果任务创建并启动成功则返回 true
4. boolean pauseTask(String world)

暂停指定世界中的生成任务。

参数：

  • world – 世界标识符

返回值：

  • boolean – 如果任务被暂停则返回 true
5. boolean continueTask(String world)

继续指定世界中的生成任务。

参数：

  • world – 世界标识符

返回值：

  • boolean – 如果任务被继续则返回 true
6. boolean cancelTask(String world)

取消指定世界中的生成任务。

参数：

  • world – 世界标识符

返回值：

  • boolean – 如果任务被取消则返回 true
7. void onGenerationProgress(Consumer<GenerationProgressEvent> listener)

注册生成进度事件监听器。

参数：

  • listener – 监听器（Consumer）
8. void onGenerationComplete(Consumer<GenerationCompleteEvent> listener)

注册生成完成事件监听器。

参数：

  • listener – 监听器（Consumer）

事件类

GenerationProgressEvent

public record GenerationProgressEvent

当生成任务计算进度时触发的事件。

构造函数：

  • GenerationProgressEvent(String world, double progress)

方法：

  • String world() – 获取世界标识符
  • double progress() – 获取进度（0.0 到 1.0）

GenerationCompleteEvent

public record GenerationCompleteEvent

当生成任务完成时触发的事件。

构造函数：

  • GenerationCompleteEvent(String world)

方法：

  • String world() – 获取世界标识符

使用示例

获取 ChunkyAPI 实例

ChunkyAPI chunky = Bukkit.getServicesManager().load(ChunkyAPI.class);

检查任务状态

if (chunky.isRunning("world")) {
    // 任务正在运行
}

启动生成任务

boolean success = chunky.startTask(
    "world",      // 世界名称
    "square",     // 形状
    0.0,          // 中心 X
    0.0,          // 中心 Z
    100.0,        // 半径 X
    100.0,        // 半径 Z
    "concentric"  // 模式
);

注册事件监听器

chunky.onGenerationProgress(event -> {
    String world = event.world();
    double progress = event.progress();
    // 处理进度事件
});

chunky.onGenerationComplete(event -> {
    String world = event.world();
    // 处理完成事件
});

注意事项

  1. API 版本：使用 version() 方法检查 API 版本以确保兼容性
  2. 世界标识符：所有方法都需要世界标识符作为参数
  3. 事件监听：事件监听器使用 Java 的 Consumer 接口
  4. 任务控制：任务可以启动、暂停、继续和取消
  5. 形状和模式：具体的形状和模式参数请参考 Chunky 插件的文档

版本信息

  • API 版本：1.3.41
  • 文档生成时间：基于官方 Javadoc 生成
  • 包结构：org.popcraft.chunky.api 和 org.popcraft.chunky.api.event.task

此文档基于 Chunky 插件的官方 API 文档生成，适用于 AI 开发参考。