feat: make it possible to specify predicate order explicitly when mer…

…ging model overrides

beet/contrib/model_merging.py

@@ -2,40 +2,71 @@
 
 
 __all__ = [
+    "ModelMergingOptions",
+    "ModelOverridesMergePolicy",
     "model_merging",
     "merge_model_overrides",
 ]
 
 
 from copy import deepcopy
-from typing import Dict, List, Tuple, Union
+from dataclasses import dataclass
+from typing import Dict, Sequence, Tuple, Union
 
-from beet import Context, Model, ResourcePack
+from beet import Context, Model, PluginOptions, ResourcePack
 from beet.core.utils import JsonDict
 
 
+class ModelMergingOptions(PluginOptions):
+    predicate_order: Sequence[str] = ()
+
+
 def beet_default(ctx: Context):
     ctx.require(model_merging)
 
 
-def model_merging(ctx: Union[Context, ResourcePack]):
-    pack = ctx.assets if isinstance(ctx, Context) else ctx
-    pack.merge_policy.extend_namespace(Model, merge_model_overrides)
+def model_merging(
+    arg: Union[Context, ResourcePack],
+    *,
+    predicate_order: Sequence[str] = (),
+):
+    if isinstance(arg, Context):
+        pack = arg.assets
+        opts = arg.validate("model_merging", ModelMergingOptions)
+        if not predicate_order:
+            predicate_order = opts.predicate_order
+    else:
+        pack = arg
+
+    pack.merge_policy.extend_namespace(
+        Model, ModelOverridesMergePolicy(predicate_order)
+    )
+
+
+@dataclass
+class ModelOverridesMergePolicy:
+    predicate_order: Sequence[str] = ()
+
+    def __call__(
+        self,
+        pack: ResourcePack,
+        path: str,
+        current: Model,
+        conflict: Model,
+    ) -> bool:
+        return merge_model_overrides(current, conflict, self.predicate_order)
 
 
 def merge_model_overrides(
-    pack: ResourcePack,
-    path: str,
-    current: Model,
-    conflict: Model,
+    current: Model, conflict: Model, predicate_order: Sequence[str] = ()
 ) -> bool:
     merged = deepcopy(conflict.data)
 
     overrides = current.data.get("overrides", [])
     other_overrides = merged.pop("overrides", [])
     concatenated_overrides = overrides + other_overrides
 
-    predicate_cases: List[str] = []
+    predicate_cases = list(predicate_order)
     for override in concatenated_overrides:
         for predicate in override.get("predicate", {}):
             if predicate not in predicate_cases:

examples/load_merge_overrides/beet.yml

@@ -2,6 +2,20 @@ require:
   - beet.contrib.model_merging
 resource_pack:
   load:
+    - assets/minecraft/models/item/elytra.json: elytra1.json
+    - assets/minecraft/models/item/elytra.json: elytra2.json
     - assets/minecraft/models/item/furnace.json: furnace1.json
     - assets/minecraft/models/item/furnace.json: furnace2.json
     - assets/minecraft/models/item/furnace.json: furnace3.json
+pipeline:
+  - require:
+      - beet.contrib.model_merging
+    resource_pack:
+      load:
+        - assets/minecraft/models/item/elytra_custom_predicate_order.json: elytra1.json
+        - assets/minecraft/models/item/elytra_custom_predicate_order.json: elytra2.json
+    meta:
+      model_merging:
+        predicate_order:
+          - custom_model_data
+          - broken

examples/load_merge_overrides/elytra1.json

@@ -0,0 +1,27 @@
+{
+  "parent": "item/generated",
+  "textures": {
+    "layer0": "item/elytra"
+  },
+  "overrides": [
+    {
+      "predicate": {
+        "broken": 1
+      },
+      "model": "minecraft:item/broken_elytra"
+    },
+    {
+      "predicate": {
+        "custom_model_data": 3420113
+      },
+      "model": "gm4_metallurgy:shamir/moneo/elytra"
+    },
+    {
+      "predicate": {
+        "custom_model_data": 3420113,
+        "broken": 1
+      },
+      "model": "gm4_metallurgy:shamir/moneo/broken_elytra"
+    }
+  ]
+}

examples/load_merge_overrides/elytra2.json

@@ -0,0 +1,27 @@
+{
+  "parent": "item/generated",
+  "textures": {
+    "layer0": "item/elytra"
+  },
+  "overrides": [
+    {
+      "predicate": {
+        "broken": 1
+      },
+      "model": "minecraft:item/broken_elytra"
+    },
+    {
+      "predicate": {
+        "custom_model_data": 3420124
+      },
+      "model": "gm4_animi_shamir:shamir/animi/elytra"
+    },
+    {
+      "predicate": {
+        "custom_model_data": 3420124,
+        "broken": 1
+      },
+      "model": "gm4_animi_shamir:shamir/animi/broken_elytra"
+    }
+  ]
+}

tests/snapshots/examples__build_load_merge_overrides__1.resource_pack/assets/minecraft/models/item/elytra.json

@@ -0,0 +1,40 @@
+{
+  "parent": "item/generated",
+  "textures": {
+    "layer0": "item/elytra"
+  },
+  "overrides": [
+    {
+      "predicate": {
+        "custom_model_data": 3420113
+      },
+      "model": "gm4_metallurgy:shamir/moneo/elytra"
+    },
+    {
+      "predicate": {
+        "custom_model_data": 3420124
+      },
+      "model": "gm4_animi_shamir:shamir/animi/elytra"
+    },
+    {
+      "predicate": {
+        "broken": 1
+      },
+      "model": "minecraft:item/broken_elytra"
+    },
+    {
+      "predicate": {
+        "custom_model_data": 3420113,
+        "broken": 1
+      },
+      "model": "gm4_metallurgy:shamir/moneo/broken_elytra"
+    },
+    {
+      "predicate": {
+        "custom_model_data": 3420124,
+        "broken": 1
+      },
+      "model": "gm4_animi_shamir:shamir/animi/broken_elytra"
+    }
+  ]
+}

tests/snapshots/examples__build_load_merge_overrides__1.resource_pack/assets/minecraft/models/item/elytra_custom_predicate_order.json

@@ -0,0 +1,40 @@
+{
+  "parent": "item/generated",
+  "textures": {
+    "layer0": "item/elytra"
+  },
+  "overrides": [
+    {
+      "predicate": {
+        "broken": 1
+      },
+      "model": "minecraft:item/broken_elytra"
+    },
+    {
+      "predicate": {
+        "custom_model_data": 3420113
+      },
+      "model": "gm4_metallurgy:shamir/moneo/elytra"
+    },
+    {
+      "predicate": {
+        "custom_model_data": 3420113,
+        "broken": 1
+      },
+      "model": "gm4_metallurgy:shamir/moneo/broken_elytra"
+    },
+    {
+      "predicate": {
+        "custom_model_data": 3420124
+      },
+      "model": "gm4_animi_shamir:shamir/animi/elytra"
+    },
+    {
+      "predicate": {
+        "custom_model_data": 3420124,
+        "broken": 1
+      },
+      "model": "gm4_animi_shamir:shamir/animi/broken_elytra"
+    }
+  ]
+}