资源条件 26.1.2
让模组的数据有条件加载的指引。
设计与其他模组的融合时，经常需要一种方式来定义模组的资源何时应被加载。 因此，Fabric API 提供了资源条件。
默认情况下，此 API 可用于配方、进度、战利品表、谓词和物品修饰器。
资源条件可以通过数据生成添加，也可手动写 JSON。 关于更多如何通过数据生成添加资源条件的信息，请看数据生成的文档。
加载条件会加到 JSON 文件的根部。
带有条件的配方，仅在标签不为空时加载。
json
{
"fabric:load_conditions": [
{
"condition": "fabric:tags_populated",
"registry": "minecraft:item",
"values": [
"minecraft:dirt"
]
}
],
"type": "minecraft:crafting_shapeless",
"category": "building",
"ingredients": [
"#minecraft:sand"
],
"result": {
"id": "minecraft:sand"
}
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
内置条件
Fabric API 提供了九种内置条件供你的模组使用。
运算符
这些是标准布尔运算符。
真
总是成功：
json
{
"fabric:load_conditions": [
{
"condition": "fabric:true"
}
]
}1
2
3
4
5
6
7
2
3
4
5
6
7
假
总是失败：
json
{
"fabric:load_conditions": [
{
"condition": "fabric:false"
}
]
}1
2
3
4
5
6
7
2
3
4
5
6
7
非
反转 value 中指定的加载条件。 例如，以下内容将失败：
json
{
"fabric:load_conditions": [
{
"condition": "fabric:not",
"value": {
"condition": "fabric:true"
}
}
]
}1
2
3
4
5
6
7
8
9
10
2
3
4
5
6
7
8
9
10
或
若 values 中的条件至少有一个成功，则成功。 例如，以下内容将成功：
json
{
"fabric:load_conditions": [
{
"condition": "fabric:or",
"values": [
{
"condition": "fabric:true"
},
{
"condition": "fabric:not",
"value": {
"condition": "fabric:true"
}
}
]
}
]
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
与
若 values 中的每个条件都成功，则成功。 例如，以下内容将失败：
json
{
"fabric:load_conditions": [
{
"condition": "fabric:and",
"values": [
{
"condition": "fabric:true"
},
{
"condition": "fabric:not",
"value": {
"condition": "fabric:true"
}
}
]
}
]
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
模组全部加载
若 values 中的所有模组都已加载，则成功。 例如，仅当 example-mod 和 another-mod 都加载时，以下内容才会成功：
json
{
"fabric:load_conditions": [
{
"condition": "fabric:all_mods_loaded",
"values": [
"example-mod",
"another-mod"
]
}
]
}1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
模组任一加载
若 values 中的模组至少有一个已加载，则成功。 例如，如果 example-mod 或 another-mod（或两者）加载，以下内容将成功：
json
{
"fabric:load_conditions": [
{
"condition": "fabric:any_mods_loaded",
"values": [
"example-mod",
"another-mod"
]
}
]
}1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
标签非空
若指定的注册表 registry 包含 values 中的所有标签，则成功。 例如，如果加载了物品标签 example-mod:smelly_items，以下内容将成功：
json
{
"fabric:load_conditions": [
{
"condition": "fabric:tags_populated",
"registry": "minecraft:item",
"values": [
"example-mod:smelly_items"
]
}
]
}1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
功能启用
若 features 中的所有功能开关都已启用，则成功。 例如，如果 minecraft:vanilla 和 minecraft:redstone_experiments 都启用，以下内容将成功：
json
{
"fabric:load_conditions": [
{
"condition": "fabric:features_enabled",
"features": [
"minecraft:vanilla",
"minecraft:minecart_improvements"
]
}
]
}1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
注册表包含
若注册表包含 values 中的所有标识符，则成功。 例如，如果注册表中存在 minecraft:cobblestone，以下内容将成功：
json
{
"fabric:load_conditions": [
{
"condition": "fabric:registry_contains",
"registry": "minecraft:block",
"values": [
"minecraft:cobblestone"
]
}
]
}1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
自定义条件
前置知识
在设置自定义资源条件之前，你必须先了解如何创建 Codec。
Fabric API 还提供了创建自定义资源条件的灵活性。
为了演示这一点，我们将创建一个检查当前日期的条件。 这可用于万圣节或愚人节等节日的特殊行为。
准备你的条件
为了简化操作，我们将创建一个辅助方法，通过名称和 MapCodec 来实例化你的资源条件。 你应该将此方法放在名为 ModResourceConditions（或你喜欢的任何名字）的类中。
TIP
Fabric 在其内置条件中也执行了相同的操作；你可以参考 DefaultResourceConditionTypes 类来查看其实际应用。
java
public class ModResourceConditions {
private static <T extends ResourceCondition> ResourceConditionType<T> createResourceConditionType(String name, MapCodec<T> codec) {
return ResourceConditionType.create(Identifier.fromNamespaceAndPath(ExampleMod.MOD_ID, name), codec);
}
}1
2
3
4
5
2
3
4
5
创建你的条件
一个资源条件由三部分组成：
- 一个接收数值的构造函数。
- 一个用于序列化这些数值的
MapCodec。 - 一个使用这些数值来确定条件是否应该通过的
test方法。
我们将为资源条件创建一个名为 DateMatchesResourceCondition 的新类。 首先，创建一个接收代表月份的 int 和代表日期的 int 的新 record：
java
public record DateMatchesResourceCondition(int month, int day) implements ResourceCondition {
}1
2
2
接下来，添加一个反映构造函数所接收内容的 MapCodec：
java
public static final MapCodec<DateMatchesResourceCondition> CODEC = RecordCodecBuilder.<DateMatchesResourceCondition>mapCodec(instance -> instance.group(
ExtraCodecs.POSITIVE_INT.fieldOf("month").forGetter(DateMatchesResourceCondition::month),
ExtraCodecs.POSITIVE_INT.fieldOf("day").forGetter(DateMatchesResourceCondition::day)
).apply(instance, DateMatchesResourceCondition::new)).validate(DateMatchesResourceCondition::validate);1
2
3
4
2
3
4
什么是 validate？
该 Codec 使用 .validate 方法来确保提供的日期切实存在，其使用的是同样名为 validate 的辅助方法中的逻辑：
java
private static DataResult<DateMatchesResourceCondition> validate(DateMatchesResourceCondition o) {
try {
MonthDay.of(o.month(), o.day());
} catch (DateTimeException e) {
return DataResult.error(e::getMessage);
}
return DataResult.success(o);
}1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
这仅与当前示例相关。
接下来，我们将添加一个检查当前日期的 test 方法。 此示例基于原版自身 SpecialDates 中的逻辑。
java
@Override
public boolean test(RegistryOps.@Nullable RegistryInfoLookup registryInfo) {
var monthDay = MonthDay.of(this.month, this.day);
return SpecialDates.dayNow().equals(monthDay);
}1
2
3
4
5
2
3
4
5
注册你的条件
回到 ModResourceConditions 中，我们现在可以注册我们的资源条件了：
java
public static final ResourceConditionType<DateMatchesResourceCondition> DATE_MATCHES =
createResourceConditionType("date_matches", DateMatchesResourceCondition.CODEC);
public static void register() {
ResourceConditions.register(DATE_MATCHES);
}1
2
3
4
5
6
2
3
4
5
6
此条件类型随后也可以在 DateMatchesResourceCondition 中被引用：
java
@Override
public ResourceConditionType<?> getType() {
return ModResourceConditions.DATE_MATCHES;
}1
2
3
4
2
3
4
请务必在你的模组初始化器中调用 ModResourceConditions.register：
java
public class ExampleModResourceConditions implements ModInitializer {
@Override
public void onInitialize() {
ModResourceConditions.register();
}
}1
2
3
4
5
6
2
3
4
5
6
使用你的条件
现在，我们有了一个当系统日期与资源条件中提供的日期相匹配时便会成功的条件。 例如，此条件将仅在愚人节时成功：
json
{
"fabric:load_conditions": [
{
"condition": "example-mod:date_matches",
"day": 1,
"month": 4
}
]
}1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9