Custom Server Data
概述
Custom Server Data 是一个 Fabric 服务端库模组,为 Minecraft 1.20.6 提供了一个结构化的、持久化的全局数据框架。它允许模组开发者(以及服务器本身)存储数据。
数据以人类可读的 JSON 文件格式存储在世界存档目录内:
world/customserverdata/<modid>/<filename>.json
每个变量都通过 模式系统 (schema system) 定义类型、默认值、约束和空值性,然后通过静态 API 在运行时进行读写。
开发者指南
1. 创建自定义类型
任何你想要存储的自定义对象都必须实现 IJsonSerializable:
import com.google.gson.JsonObject;
import fr.hdi.api.IJsonSerializable;
public class QuestData implements IJsonSerializable {
private int nbPoints;
private String status;
public QuestData() {
this.nbPoints = 0;
this.status = "inactive";
}
public int getNbPoints() { return nbPoints; }
public void setNbPoints(int nbPoints) { this.nbPoints = nbPoints; }
public String getStatus() { return status; }
public void setStatus(String status) { this.status = status; }
@Override
public JsonObject toJson() {
JsonObject json = new JsonObject();
json.addProperty("nb_points", nbPoints);
json.addProperty("status", status);
return json;
}
@Override
public void fromJson(JsonObject json) {
this.nbPoints = json.has("nb_points") ? json.get("nb_points").getAsInt() : 0;
this.status = json.has("status") ? json.get("status").getAsString() : "inactive";
}
}
2. 注册数据
在你的模组的 onInitialize 方法中,使用 ServerSchemaManager 注册你的模式:
import fr.hdi.schema.ServerDataType;
import fr.hdi.schema.ServerSchemaManager;
import fr.hdi.schema.ServerVariableDefinition;
import net.fabricmc.api.ModInitializer;
public class MyMod implements ModInitializer {
public static final String MOD_ID = "mymod";
@Override
public void onInitialize() {
// 注册带有最小/最大约束的整数
ServerSchemaManager.register(MOD_ID, "quests",
ServerVariableDefinition.builder("nb_point")
.type(ServerDataType.INT)
.defaultValue(10)
.min(0)
.max(1000)
.build()
);
// 注册字符串
ServerSchemaManager.register(MOD_ID, "quests",
ServerVariableDefinition.builder("status")
.type(ServerDataType.STRING)
.defaultValue("active")
.build()
);
// 注册布尔值
ServerSchemaManager.register(MOD_ID, "settings",
ServerVariableDefinition.builder("pvp_enabled")
.type(ServerDataType.BOOLEAN)
.defaultValue(false)
.build()
);
// 注册自定义类型
ServerSchemaManager.register(MOD_ID, "quests",
ServerVariableDefinition.builder("quest_data", "QuestData")
.type(ServerDataType.CUSTOM)
.customFactory(QuestData::new)
.nullable(true)
.build()
);
// 注册自定义类型列表
ServerSchemaManager.register(MOD_ID, "warps",
ServerVariableDefinition.builder("warps")
.type(ServerDataType.LIST)
.elementType(ServerDataType.CUSTOM)
.elementFactory(Warp::new)
.defaultValue(List.of())
.build()
);
}
}
这会在磁盘上生成两个 JSON 文件:
world/customserverdata/mymod/quests.jsonworld/customserverdata/mymod/settings.json
3. 读取/写入数据
在服务端线程的任何地方使用静态 ServerDataStore API:
import fr.hdi.store.ServerDataStore;
// 读取数值
int points = ServerDataStore.getInt("mymod", "quests", "nb_point");
String status = ServerDataStore.getString("mymod", "quests", "status");
boolean pvp = ServerDataStore.getBoolean("mymod", "settings", "pvp_enabled");
// 写入数值(根据模式进行验证)
ServerDataStore.setData("mymod", "quests", "nb_point", 42);
ServerDataStore.setData("mymod", "quests", "status", "completed");
ServerDataStore.setData("mymod", "settings", "pvp_enabled", true);
// 自定义对象
QuestData quest = ServerDataStore.getCustom("mymod", "quests", "quest_data");
if (quest != null) {
quest.setNbPoints(100);
ServerDataStore.setData("mymod", "quests", "quest_data", quest);
}
List<Warp> warps = ServerDataStore.getList(EssentialsUtilsCommands.MOD_ID, "warps", "warps");
if (warps != null){
warps.remove(1);
ServerDataStore.setData(EssentialsUtilsCommands.MOD_ID, "warps","warps",warps);
}
你是这个资源的作者?登录后可认领此资源。
相似资源
一个用于收集生物掉落物的多区块模组。
显示你正在注视的方块的信息。(适用于 Minecraft 1.16+ 的 Hwyla/Waila 分支)
查看物品与配方
在游戏画面角落显示附近世界地形、玩家、生物和实体的地图。可创建路径点,帮助你找到标记过的位置。
使用 JavaScript 编辑配方、添加自定义物品、编写世界事件!
适用于 MC 1.18+ 的 Effekseer 加载器
评论 0
登录后参与评分
还没有评论,来抢沙发吧