ChunkAPI

模组

· 作者 FalsePattern

轻松管理区块内的自定义数据。

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

需要前置:UniMixins

最新 0.8.4 · 1.7.10 · Forge

一键开服(送7天)

一个用于向区块添加自定义数据的模组,无需编写自定义数据包、事件处理、加载钩子等繁琐操作。

根据 LGPLv3 许可证授权

最初由 FalsePattern 开发

模组标志由 Houstonruss 设计

目标

旨在提供一种无需修改任何原版类即可向区块添加自定义数据的方法。API 还将提供实现自定义数据序列化/反序列化的简便方法,适用于网络传输和 NBT 格式。可选目标是提供为自定义数据注册 DFU(数据修复器)的方法,但这并非优先事项。

非目标

除了保存/加载和网络代码外,本模组不提供任何形式的回调/钩子系统。任何额外的行为都应在使用 ChunkAPI 的模组中自行实现。

API 不提供存储功能,用户需自行实现存储系统。一个好的示例是使用 Mixin 向区块类添加字段,并利用该字段来存储数据。

动机

修改区块数据包涉及不兼容地修改网络数据包、区块类以及安格尔区块加载器,这对于一个简单的功能来说工作量巨大。本模组提供了一种向区块添加自定义数据的方法,而无需你自己修改任何原版类。

API 和规范

API 提供了向区块添加自定义数据的方法,以及为数据注册自定义序列化器的方法。

ChunkDataManager

ChunkDataManager 本身是用于管理注册的主要类,但它本身不实现功能。为此,你需要使用包含在 ChunkDataManager 类中的 PacketDataManager、ChunkNBTDataManager 和 SectionNBTDataManager 接口。

ChunkDataManager.PacketData

此接口用于将数据从服务器同步到客户端。如果你的数据仅需要在服务器上存在,你可以自由跳过实现此接口。

ChunkDataManager.ChunkNBTData

此接口用于从区块 NBT 中保存/加载数据。如果你希望在世界重载之间保留持久数据,这是必需的。注意,如果你在区块中按块存储数据,应改用 SectionNBTData,因为它是针对内部区块格式设计的。

ChunkDataManager.SectionNBTData

此接口与 ChunkNBTData 基本相同,但专为在区块中按块存储数据而设计。它不是每个区块调用一次,而是每个区块段(16x16x16 个方块,即 ExtendedBlockStage 类)调用一次。

ChunkDataRegistry

这是你实际注册管理器的地方。你需要在 init 阶段内完成所有注册。你也可以通过调用 disableDataManager 禁用特定的管理器 ID,但不推荐这样做,仅在你清楚自己在做什么的情况下才使用。你需要在 postInit 阶段内完成所有禁用操作。

数据包规范

ChunkAPI 修改了 S21PacketChunkData 和 S26PacketMapChunkBulk 原版数据包,并覆盖了它们的默认格式。

下表中的所有大小均以字节为单位指定。

S21PacketChunkData 新格式:

大小 (字节) 数据类型 名称
4 int X 坐标
4 int Z 坐标
1 bool 强制更新
2 short ExtendedBlockStorage 掩码
4 int 未压缩数据长度
4 int (n) 压缩数据长度
n byte[n] 压缩数据

S26PacketMapChunkBulk 新格式:

大小 (字节) 数据类型 名称
2 short (n) 数据包中的区块数量
n * 4 int[n] 未压缩区块数据长度
4 int (m) 压缩数据长度
1 1 包含天空光数据
m byte[m] 压缩数据
n * 10 (int, int, short)[n] 区块头部 (x, z, ebs 掩码)

在这两种情况下,压缩数据均通过 ChunkDataRegistryImpl.writeToBuffer 方法填充。此数据的布局如下:

大小 (字节) 数据类型 名称
4 int (n) 管理器数量
n * varying MGRData 管理器数据

管理器数据:

大小 (字节) 数据类型 名称
4 int (n) 管理器名称长度
n UTF-8 str 管理器名称
4 int (m) 管理器数据长度
m byte[m] 管理器数据

依赖项

FalsePatternLib

UniMixins

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

评论 0

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

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源