BlockStore - 方块数据存储工具

BlockStore 是一款为 Minecraft 服务器设计的核心插件，它允许其他插件为方块附加持久化的元数据，这些数据在服务器重启后依然存在。这对于需要记录方块状态（如自定义机器、玩家头颅信息）或区分玩家放置与自然生成的方块至关重要。

💡核心功能

• 持久化方块元数据：为任意方块存储自定义数据（字符串、布尔值、数字及其数组），数据在服务器重启后不会丢失。
• 记录方块来源：自动记录每个方块是由玩家放置还是自然生成，可用于实现精确的游戏机制（例如，使“时运”附魔仅对自然生成的矿石生效）。
• 高性能后端：经过深度优化，能高效利用 CPU、内存和存储空间。
• WorldEdit 集成：与新版 WorldEdit 联动，被 WorldEdit 修改的方块会被标记为“自然生成”。
• 开发者 API：提供完整的 API，供其他插件轻松查询和修改方块数据。

🎮安装与使用

如果其他插件要求安装 BlockStore，请按以下步骤操作：

• 下载 BlockStore 插件。
• 将其放入服务器的 plugins 文件夹。
• 重启服务器。

安装完成后，无需额外配置即可正常工作。

命令与权限

• /blockstore check

- 检查一个方块是否由玩家放置，并查看其元数据。

- 所需权限：`blockstore.check`

• /blockstore info

- 获取已加载区块的信息。

- 所需权限：`blockstore.info`

• /blockstore reload

- 重新加载 BlockStore 的配置文件。

- 所需权限：`blockstore.reload`

🔧配置文件

默认配置文件如下，您可以根据注释调整设置

# 预加载模式：
# All - 游戏中加载的每个区块都会被 BlockStore 预加载
# Close - 只有玩家附近的区块会被 BlockStore 预加载
# None - 不进行预加载，区块将在被使用时才加载
preload: 'Close'

# 区块数据被使用后，等待多少秒才卸载（单位：秒）
unload-time: 60

✨开发者指南

依赖与 API 检查

您可以通过以下两种方式在您的插件中使用 BlockStore：

• 在您的 plugin.yml 中将 BlockStore 添加为依赖。
• 在代码中检查 API 是否可用：

    if (Bukkit.getPluginManager().getPlugin("BlockStore") != null) {
        // API 可用
    }

API 方法概览

所有方法均为 BlockStoreApi 类的静态成员。核心方法包括：

• 查询方块来源：

- `boolean isPlaced(Block block)`

- `boolean isPlaced(Location loc)`

- `retrieveIsPlaced(...)` （异步版本）

• 获取/设置元数据：

- `Object getBlockMeta(Block block, Plugin plugin, String key)`

- `setBlockMeta(Block block, Plugin plugin, String key, Object value)`

- `retrieveBlockMeta(...)` （异步版本）

- `getAllBlockMeta(...)` （获取插件所有数据或全部数据）

- `containsBlockMeta(...)` （检查键是否存在）

- `removeBlockMeta(...)` （移除数据）

**使用示例**

String name = (String) BlockStoreApi.getBlockMeta(myBlock, myPlugin, "name");

重要注意事项

• 数据类型限制：元数据值只能是以下类型或其数组形式（如 String[], int[][]）：

- `String`, `boolean`, `byte`, `short`, `int`, `long`, `float`, `double`

• 异步操作警告：在 ChunkLoadEvent 期间或区块加载前获取方块状态，如果该区块未被 BlockStore 预加载，可能会导致线程阻塞。

- **解决方案**：将此逻辑放在异步任务中执行，或使用 API 提供的 `retrieve...` 系列方法，它们会为您处理等待加载的逻辑。

⭐支持与捐赠

BlockStore 的源代码托管在 BitBucket 上。

这款插件完全免费。虽然它设计简洁，但后端投入了大量工作以确保其高效运行。如果它对您的项目或服务器有所帮助，可以考虑通过 捐赠链接 支持开发者。一笔小小的捐赠（例如 5 美元）将极大地鼓励开发者持续维护并创造更多优秀的插件。