[Incomplete] Move item-def handling to Templates

Author: SpecialBuilder32

gm4/plugins/resource_pack.py

@@ -31,16 +31,18 @@ meta:
         reference: item/enderpuff
       - item: elytra
         reference: item/captains_wings
-        model:
-          type: condition_broken
-          unbroken: item/elytra/captains_wings
-          broken: item/elytra/broken_captains_wings
+        template:
+          name: condition
+          property: minecraft:broken
+          on_true: item/elytra/broken_captains_wings
+          on_false: item/elytra/captains_wings
       - item: elytra
         reference: item/ravaged_wings
-        model:
-          type: condition_broken
-          unbroken: item/elytra/ravaged_wings
-          broken: item/elytra/broken_ravaged_wings
+        template:
+          name: condition
+          property: minecraft:broken
+          on_true: item/elytra/broken_ravaged_wings
+          on_false: item/elytra/ravaged_wings
       - item: fishing_rod
         reference: gui/advancement/end_fishing
         template: advancement

gm4_end_fishing/beet.yaml

@@ -1,13 +1,13 @@
 from beet import Context, Model, NamespaceProxy, ListOption, ResourcePack
 from beet.contrib.vanilla import Vanilla, ClientJar
 from beet.contrib.optifine import OptifineProperties
-from typing import Any, ClassVar, Literal, Optional
+from typing import Any, ClassVar, Literal
 from itertools import product, chain, count
 import re
 import logging
 from copy import deepcopy
 
-from gm4.plugins.resource_pack import ModelData, TemplateOptions, ItemModelOptions
+from gm4.plugins.resource_pack import ModelData, TemplateOptions, JsonType
 from gm4.utils import add_namespace, MapOption
 
 parent_logger = logging.getLogger("gm4."+__name__)
@@ -63,15 +63,18 @@ class ShamirTemplate(TemplateOptions):
     textures_path: str = "" # directory of texture files to use for shamirs, falling back to the default metallurgy textures
     metal: Literal["aluminium", "barimium", "barium", "bismuth", "curies_bismium", "thorium"] # the metallurgy metal this shamir is made of
 
+    _item_def_map: dict[str, JsonType] = {}
+    _model_overrides_1_21_3: dict[str, list[JsonType]] = {} # NOTE to be removed in 1.21.5
+
     bound_ctx: ClassVar[Context]
     metallurgy_assets: ClassVar[ResourcePack] = ResourcePack(path="gm4_metallurgy") # load metallurgy textures so expansion shamirs can fall back on their
     vanilla_models_jar: ClassVar[ClientJar]
     vanilla_models_jar_1_21_3: ClassVar[ClientJar]
 
-    def process(self, config: ModelData, models_container: NamespaceProxy[Model]) -> list[Model]:
+    def create_models(self, config: ModelData, models_container: NamespaceProxy[Model]) -> list[Model]:
         logger = parent_logger.getChild(self.bound_ctx.project_id)
         models_loc = f"{config.reference}"
-        models: dict[str, str|ItemModelOptions] = {} # the value of config.models to be applied after going through special cases
+        models: dict[str, str] = {} # the value of config.models to be applied after going through special cases
         ret_list: list[Model] = []
 
         for item in config.item.entries():
@@ -165,7 +168,7 @@ def recursive_extract_variants(json: dict[str, Any]) -> tuple[list[str], list[An
                 itemdef_compound["model"] = variant_path # update our copy to point to the new model
 
             # 1.21.3 Backwards Comparability - Remove in 1.21.5!
-            variants: Any = [{"model": f"{models_loc}/{item}"}]
+            variants: list[JsonType] = [{"model": f"{models_loc}/{item}"}]
             for override in self.vanilla_models_jar_1_21_3.assets.models[f"minecraft:item/{item}"].data.get('overrides', []):
                 item_variant = override['model'].split('/')[-1]
 
@@ -175,7 +178,9 @@ def recursive_extract_variants(json: dict[str, Any]) -> tuple[list[str], list[An
                 })
 
             if item_variants:
-                models.update({item: ComplexBypass(payload=mutatable_itemdef_copy, payload_1_21_3=variants)})
+                self._item_def_map[item] = mutatable_itemdef_copy
+                self._model_overrides_1_21_3[item] = variants
+                models.update({item: "NULL"}) # actual model paths contained within itemdef compound
             else:
                 models.update({item: f"{models_loc}/{item}"})
 
@@ -209,6 +214,10 @@ def recursive_extract_variants(json: dict[str, Any]) -> tuple[list[str], list[An
         config.model = MapOption(__root__=models)
         return ret_list
 
+    def get_item_def_entry(self, config: ModelData, item: str) -> None|JsonType:
+        # TODO fill me out, replacing ComplexBypass
+        return self._item_def_map.get(item)
+    
     def mutate_config(self, config: ModelData):
         expanded_items = set(chain.from_iterable([GROUP_LOOKUP.get(group, [group]) for group in config.item.entries()])) | {"player_head"}
         config.item = ListOption(__root__=list(expanded_items))
@@ -218,17 +227,6 @@ def mutate_config(self, config: ModelData):
         else: # isinstance(.., dict):
             config.textures = MapOption(__root__={"band": f"gm4_metallurgy:item/band/{self.metal}_band"}|config.textures.__root__)
 
-class ComplexBypass(ItemModelOptions):
-    """Generator for item model definitions on trimed armor, compasses with complex vanilla display conditions.
-    NOT INTENDED FOR USAGE IN CONFIG FILES. Used by config-mutating templates to pass item-model-def variants upstream to the file creation stage"""
-    # NOTE should this be in the base resource_pack file? Depends if any other modules use this approach
-    type = "_complex_bypass"
-    payload: dict[str, Any]
-    payload_1_21_3: Optional[Any] = [] # NOTE backwards compatability field. Will be removed in 1.21.5 update
-
-    def generate_json(self) -> dict[str, Any]:
-        return self.payload
-
 def optifine_armor_properties_merging(pack: ResourcePack, path: str, current: OptifineProperties, conflict: OptifineProperties) -> bool:
     if not path.startswith("gm4_metallurgy:cit"): # only apply this rule to metallurgy files
         return False

gm4_metallurgy/shamir_model_template.py

@@ -9,7 +9,7 @@ class PneumaTemplate(TemplateOptions):
     """model template to generate the models for shards and essences"""
     name = "pneuma"
 
-    def process(self, config: ModelData, models_container: NamespaceProxy[Model]):
+    def create_models(self, config: ModelData, models_container: NamespaceProxy[Model]):
         pneuma = config.reference.split("/")[-1] # eg agile, anchoring ect...
         shard = models_container[f"gm4_orb_of_ankou:item/shards/{pneuma}"] = Model({
             "parent": "item/generated",

gm4_orb_of_ankou/pneuma_model_template.py

@@ -14,7 +14,7 @@ class OreDisplayTemplate(TemplateOptions):
         )
     ]
 
-    def process(self, config: ModelData, models_container: NamespaceProxy[Model]):
+    def create_models(self, config: ModelData, models_container: NamespaceProxy[Model]):
         model_name = ensure_single_model_config(self.name, config)
         reference = config.reference.split('/')[-1]
         m = models_container[model_name] = Model({

gm4_smelteries/ore_display.py

@@ -66,7 +66,9 @@ model_data:
       forward: item/bottled_magicol/temperate_potion
   - item: clock
     reference: gui/advancement/zauber_cauldrons_make_magicol
-    template: advancement
+    template: 
+      name: advancement
+      forward: minecraft:clock_00
   - item: grass_block
     reference: gui/advancement/zauber_cauldrons_paint_biome
     template: advancement