convert: Refactor SWGBCCPregenSubprocessor into separate files.

Author: heinezen

openage/convert/processor/conversion/aoc/pregen/effect.py

@@ -7,11 +7,12 @@
 import typing
 
 from ......nyan.nyan_structs import MemberSpecialValue
-from .....entity_object.conversion.converter_object import RawAPIObject, ConverterObjectGroup
+from .....entity_object.conversion.converter_object import RawAPIObject
 from .....service.conversion import internal_name_lookups
 from .....value_object.conversion.forward_ref import ForwardRef
 
 if typing.TYPE_CHECKING:
+    from .....entity_object.conversion.converter_object import ConverterObjectGroup
     from .....entity_object.conversion.aoc.genie_object_container import GenieObjectContainer
 
 ATTRIBUTE_CHANGE_PARENT = "engine.util.attribute_change_type.AttributeChangeType"
@@ -45,9 +46,9 @@ def generate_effect_types(
     :param full_data_set: Storage for all converted objects and metadata.
     :param pregen_converter_group: Stores all pregenerated nyan objects.
     """
-    _generate_attribute_change_types(full_data_set, pregen_converter_group)
-    _generate_construct_types(full_data_set, pregen_converter_group)
-    _generate_convert_types(full_data_set, pregen_converter_group)
+    generate_attribute_change_types(full_data_set, pregen_converter_group)
+    generate_construct_types(full_data_set, pregen_converter_group)
+    generate_convert_types(full_data_set, pregen_converter_group)
 
 
 def generate_misc_effect_objects(
@@ -67,7 +68,7 @@ def generate_misc_effect_objects(
     _generate_repair_property(full_data_set, pregen_converter_group)
 
 
-def _generate_attribute_change_types(
+def generate_attribute_change_types(
     full_data_set: GenieObjectContainer,
     pregen_converter_group: ConverterObjectGroup
 ) -> None:
@@ -156,7 +157,7 @@ def _generate_attribute_change_types(
         pregen_nyan_objects.update({type_ref_in_modpack: type_raw_api_object})
 
 
-def _generate_construct_types(
+def generate_construct_types(
     full_data_set: GenieObjectContainer,
     pregen_converter_group: ConverterObjectGroup
 ) -> None:
@@ -189,7 +190,7 @@ def _generate_construct_types(
         pregen_nyan_objects.update({type_ref_in_modpack: type_raw_api_object})
 
 
-def _generate_convert_types(
+def generate_convert_types(
     full_data_set: GenieObjectContainer,
     pregen_converter_group: ConverterObjectGroup
 ) -> None:

openage/convert/processor/conversion/aoc/pregen/exchange.py

@@ -6,10 +6,11 @@
 from __future__ import annotations
 import typing
 
-from .....entity_object.conversion.converter_object import RawAPIObject, ConverterObjectGroup
+from .....entity_object.conversion.converter_object import RawAPIObject
 from .....value_object.conversion.forward_ref import ForwardRef
 
 if typing.TYPE_CHECKING:
+    from .....entity_object.conversion.converter_object import ConverterObjectGroup
     from .....entity_object.conversion.aoc.genie_object_container import GenieObjectContainer
 
 BUY_MODE_PARENT = "engine.util.exchange_mode.type.Buy"
@@ -30,13 +31,13 @@ def generate_exchange_objects(
     :param full_data_set: Storage for all converted objects and metadata.
     :param pregen_converter_group: Stores all pregenerated nyan objects.
     """
-    _generate_exchange_modes(full_data_set, pregen_converter_group)
-    _generate_exchange_rates(full_data_set, pregen_converter_group)
-    _generate_price_pools(full_data_set, pregen_converter_group)
-    _generate_price_modes(full_data_set, pregen_converter_group)
+    generate_exchange_modes(full_data_set, pregen_converter_group)
+    generate_exchange_rates(full_data_set, pregen_converter_group)
+    generate_price_pools(full_data_set, pregen_converter_group)
+    generate_price_modes(full_data_set, pregen_converter_group)
 
 
-def _generate_exchange_modes(
+def generate_exchange_modes(
     full_data_set: GenieObjectContainer,
     pregen_converter_group: ConverterObjectGroup
 ) -> None:
@@ -88,7 +89,7 @@ def _generate_exchange_modes(
     pregen_nyan_objects.update({exchange_mode_ref_in_modpack: exchange_mode_raw_api_object})
 
 
-def _generate_exchange_rates(
+def generate_exchange_rates(
     full_data_set: GenieObjectContainer,
     pregen_converter_group: ConverterObjectGroup
 ) -> None:
@@ -219,7 +220,7 @@ def _generate_exchange_rates(
     pregen_nyan_objects.update({exchange_rate_ref_in_modpack: exchange_rate_raw_api_object})
 
 
-def _generate_price_pools(
+def generate_price_pools(
     full_data_set: GenieObjectContainer,
     pregen_converter_group: ConverterObjectGroup
 ) -> None:
@@ -275,7 +276,7 @@ def _generate_price_pools(
     pregen_nyan_objects.update({exchange_pool_ref_in_modpack: exchange_pool_raw_api_object})
 
 
-def _generate_price_modes(
+def generate_price_modes(
     full_data_set: GenieObjectContainer,
     pregen_converter_group: ConverterObjectGroup
 ) -> None:
@@ -299,7 +300,7 @@ def _generate_price_modes(
     price_mode_raw_api_object.set_filename("market_trading")
     price_mode_raw_api_object.add_raw_parent(PRICE_MODE_PARENT)
 
-    # Min price
+    # Change value
     price_mode_raw_api_object.add_raw_member("change_value",
                                              0.03,
                                              PRICE_MODE_PARENT)
@@ -328,7 +329,7 @@ def _generate_price_modes(
     price_mode_raw_api_object.set_filename("market_trading")
     price_mode_raw_api_object.add_raw_parent(PRICE_MODE_PARENT)
 
-    # Min price
+    # Change value
     price_mode_raw_api_object.add_raw_member("change_value",
                                              -0.03,
                                              PRICE_MODE_PARENT)

openage/convert/processor/conversion/aoc/pregen/resource.py

@@ -15,6 +15,7 @@
 
 RESOURCE_PARENT = "engine.util.resource.Resource"
 RESOURCE_CONTINGENT_PARENT = "engine.util.resource.ResourceContingent"
+NAME_VALUE_PARENT = "engine.util.language.translated.type.TranslatedString"
 RESOURCES_LOCATION = "data/util/resource/"
 
 
@@ -28,14 +29,14 @@ def generate_resources(
     :param full_data_set: Storage for all converted objects and metadata.
     :param pregen_converter_group: Stores all pregenerated nyan objects.
     """
-    _generate_food_resource(full_data_set, pregen_converter_group)
-    _generate_wood_resource(full_data_set, pregen_converter_group)
-    _generate_stone_resource(full_data_set, pregen_converter_group)
-    _generate_gold_resource(full_data_set, pregen_converter_group)
-    _generate_population_resource(full_data_set, pregen_converter_group)
+    generate_food_resource(full_data_set, pregen_converter_group)
+    generate_wood_resource(full_data_set, pregen_converter_group)
+    generate_stone_resource(full_data_set, pregen_converter_group)
+    generate_gold_resource(full_data_set, pregen_converter_group)
+    generate_population_resource(full_data_set, pregen_converter_group)
 
 
-def _generate_food_resource(
+def generate_food_resource(
     full_data_set: GenieObjectContainer,
     pregen_converter_group: ConverterObjectGroup
 ) -> None:
@@ -62,13 +63,12 @@ def _generate_food_resource(
                                        MemberSpecialValue.NYAN_INF,
                                        RESOURCE_PARENT)
 
-    name_value_parent = "engine.util.language.translated.type.TranslatedString"
     food_name_ref_in_modpack = "util.attribute.types.Food.FoodName"
     food_name_value = RawAPIObject(food_name_ref_in_modpack, "FoodName",
                                    api_objects, RESOURCES_LOCATION)
     food_name_value.set_filename("types")
-    food_name_value.add_raw_parent(name_value_parent)
-    food_name_value.add_raw_member("translations", [], name_value_parent)
+    food_name_value.add_raw_parent(NAME_VALUE_PARENT)
+    food_name_value.add_raw_member("translations", [], NAME_VALUE_PARENT)
 
     name_forward_ref = ForwardRef(pregen_converter_group,
                                   food_name_ref_in_modpack)
@@ -80,7 +80,7 @@ def _generate_food_resource(
     pregen_nyan_objects.update({food_name_ref_in_modpack: food_name_value})
 
 
-def _generate_wood_resource(
+def generate_wood_resource(
     full_data_set: GenieObjectContainer,
     pregen_converter_group: ConverterObjectGroup
 ) -> None:
@@ -107,13 +107,12 @@ def _generate_wood_resource(
                                        MemberSpecialValue.NYAN_INF,
                                        RESOURCE_PARENT)
 
-    name_value_parent = "engine.util.language.translated.type.TranslatedString"
     wood_name_ref_in_modpack = "util.attribute.types.Wood.WoodName"
     wood_name_value = RawAPIObject(wood_name_ref_in_modpack, "WoodName",
                                    api_objects, RESOURCES_LOCATION)
     wood_name_value.set_filename("types")
-    wood_name_value.add_raw_parent(name_value_parent)
-    wood_name_value.add_raw_member("translations", [], name_value_parent)
+    wood_name_value.add_raw_parent(NAME_VALUE_PARENT)
+    wood_name_value.add_raw_member("translations", [], NAME_VALUE_PARENT)
 
     name_forward_ref = ForwardRef(pregen_converter_group,
                                   wood_name_ref_in_modpack)
@@ -125,7 +124,7 @@ def _generate_wood_resource(
     pregen_nyan_objects.update({wood_name_ref_in_modpack: wood_name_value})
 
 
-def _generate_stone_resource(
+def generate_stone_resource(
     full_data_set: GenieObjectContainer,
     pregen_converter_group: ConverterObjectGroup
 ) -> None:
@@ -152,13 +151,12 @@ def _generate_stone_resource(
                                         MemberSpecialValue.NYAN_INF,
                                         RESOURCE_PARENT)
 
-    name_value_parent = "engine.util.language.translated.type.TranslatedString"
     stone_name_ref_in_modpack = "util.attribute.types.Stone.StoneName"
     stone_name_value = RawAPIObject(stone_name_ref_in_modpack, "StoneName",
                                     api_objects, RESOURCES_LOCATION)
     stone_name_value.set_filename("types")
-    stone_name_value.add_raw_parent(name_value_parent)
-    stone_name_value.add_raw_member("translations", [], name_value_parent)
+    stone_name_value.add_raw_parent(NAME_VALUE_PARENT)
+    stone_name_value.add_raw_member("translations", [], NAME_VALUE_PARENT)
 
     name_forward_ref = ForwardRef(pregen_converter_group,
                                   stone_name_ref_in_modpack)
@@ -170,7 +168,7 @@ def _generate_stone_resource(
     pregen_nyan_objects.update({stone_name_ref_in_modpack: stone_name_value})
 
 
-def _generate_gold_resource(
+def generate_gold_resource(
     full_data_set: GenieObjectContainer,
     pregen_converter_group: ConverterObjectGroup
 ) -> None:
@@ -197,13 +195,12 @@ def _generate_gold_resource(
                                        MemberSpecialValue.NYAN_INF,
                                        RESOURCE_PARENT)
 
-    name_value_parent = "engine.util.language.translated.type.TranslatedString"
     gold_name_ref_in_modpack = "util.attribute.types.Gold.GoldName"
     gold_name_value = RawAPIObject(gold_name_ref_in_modpack, "GoldName",
                                    api_objects, RESOURCES_LOCATION)
     gold_name_value.set_filename("types")
-    gold_name_value.add_raw_parent(name_value_parent)
-    gold_name_value.add_raw_member("translations", [], name_value_parent)
+    gold_name_value.add_raw_parent(NAME_VALUE_PARENT)
+    gold_name_value.add_raw_member("translations", [], NAME_VALUE_PARENT)
 
     name_forward_ref = ForwardRef(pregen_converter_group,
                                   gold_name_ref_in_modpack)
@@ -215,7 +212,7 @@ def _generate_gold_resource(
     pregen_nyan_objects.update({gold_name_ref_in_modpack: gold_name_value})
 
 
-def _generate_population_resource(
+def generate_population_resource(
     full_data_set: GenieObjectContainer,
     pregen_converter_group: ConverterObjectGroup
 ) -> None:
@@ -238,13 +235,12 @@ def _generate_population_resource(
     pregen_converter_group.add_raw_api_object(pop_raw_api_object)
     pregen_nyan_objects.update({pop_ref_in_modpack: pop_raw_api_object})
 
-    name_value_parent = "engine.util.language.translated.type.TranslatedString"
     pop_name_ref_in_modpack = "util.attribute.types.PopulationSpace.PopulationSpaceName"
     pop_name_value = RawAPIObject(pop_name_ref_in_modpack, "PopulationSpaceName",
                                   api_objects, RESOURCES_LOCATION)
     pop_name_value.set_filename("types")
-    pop_name_value.add_raw_parent(name_value_parent)
-    pop_name_value.add_raw_member("translations", [], name_value_parent)
+    pop_name_value.add_raw_parent(NAME_VALUE_PARENT)
+    pop_name_value.add_raw_member("translations", [], NAME_VALUE_PARENT)
 
     name_forward_ref = ForwardRef(pregen_converter_group,
                                   pop_name_ref_in_modpack)

openage/convert/processor/conversion/swgbcc/CMakeLists.txt

@@ -16,3 +16,4 @@ add_subdirectory(ability)
 add_subdirectory(auxiliary)
 add_subdirectory(civ)
 add_subdirectory(nyan)
+add_subdirectory(pregen)

openage/convert/processor/conversion/swgbcc/pregen/CMakeLists.txt

@@ -0,0 +1,6 @@
+add_py_modules(
+	__init__.py
+	effect.py
+	exchange.py
+	resource.py
+)

openage/convert/processor/conversion/swgbcc/pregen/__init__.py

@@ -0,0 +1,6 @@
+# Copyright 2025-2025 the openage authors. See copying.md for legal info.
+
+"""
+Creates nyan objects for things that are hardcoded into the Genie Engine,
+but configurable in openage, e.g. HP.
+"""