convert: Refactor AoCModifierSubprocessor into separate files.

Author: heinezen

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

@@ -22,4 +22,5 @@ add_subdirectory(auxiliary)
 add_subdirectory(civ)
 add_subdirectory(effect)
 add_subdirectory(media)
+add_subdirectory(modifier)
 add_subdirectory(resistance)

openage/convert/processor/conversion/aoc/ability/__init__.py

@@ -1,6 +1,5 @@
 # Copyright 2025-2025 the openage authors. See copying.md for legal info.
 
 """
-Derives and adds abilities to game entities created from lines. Subroutine of the
-nyan subprocessor.
+Derives and adds abilities to game entities created from lines.
 """

openage/convert/processor/conversion/aoc/modifier/CMakeLists.txt

@@ -0,0 +1,7 @@
+add_py_modules(
+    __init__.py
+    elevation_attack.py
+    flyover_effect.py
+    gather_rate.py
+    move_speed.py
+)

openage/convert/processor/conversion/aoc/modifier/__init__.py

@@ -0,0 +1,5 @@
+# Copyright 2025-2025 the openage authors. See copying.md for legal info.
+
+"""
+Derives and adds modifiers to lines or civ groups.
+"""

openage/convert/processor/conversion/aoc/modifier/elevation_attack.py

@@ -0,0 +1,31 @@
+# Copyright 2025-2025 the openage authors. See copying.md for legal info.
+
+"""
+nyan conversion routines for the ElevationAttack modifier.
+"""
+from __future__ import annotations
+import typing
+
+if typing.TYPE_CHECKING:
+    from ......nyan.nyan_structs import NyanObject
+    from .....entity_object.conversion.aoc.genie_unit import GenieGameEntityGroup
+
+
+def elevation_attack_modifiers(converter_obj_group: GenieGameEntityGroup) -> list[NyanObject]:
+    """
+    Adds the pregenerated elevation damage multipliers to a line or civ group.
+
+    :param converter_obj_group: ConverterObjectGroup that gets the modifier.
+    :returns: The forward references for the modifier.
+    """
+    dataset = converter_obj_group.data
+    modifiers = [
+        dataset.pregen_nyan_objects[
+            "util.modifier.elevation_difference.AttackHigh"
+        ].get_nyan_object(),
+        dataset.pregen_nyan_objects[
+            "util.modifier.elevation_difference.AttackLow"
+        ].get_nyan_object()
+    ]
+
+    return modifiers

openage/convert/processor/conversion/aoc/modifier/flyover_effect.py

@@ -0,0 +1,26 @@
+# Copyright 2025-2025 the openage authors. See copying.md for legal info.
+
+"""
+nyan conversion routines for the FlyoverEffect modifier.
+"""
+from __future__ import annotations
+import typing
+
+if typing.TYPE_CHECKING:
+    from ......nyan.nyan_structs import NyanObject
+    from .....entity_object.conversion.aoc.genie_unit import GenieGameEntityGroup
+
+
+def flyover_effect_modifier(converter_obj_group: GenieGameEntityGroup) -> NyanObject:
+    """
+    Adds the pregenerated fly-over-cliff damage multiplier to a line or civ group.
+
+    :param converter_obj_group: ConverterObjectGroup that gets the modifier.
+    :returns: The forward reference for the modifier.
+    """
+    dataset = converter_obj_group.data
+    modifier = dataset.pregen_nyan_objects[
+        "util.modifier.flyover_cliff.AttackFlyover"
+    ].get_nyan_object()
+
+    return modifier

openage/convert/processor/conversion/aoc/modifier/gather_rate.py

@@ -0,0 +1,122 @@
+# Copyright 2025-2025 the openage authors. See copying.md for legal info.
+
+"""
+nyan conversion routines for the GatherRate modifier.
+"""
+
+from .....entity_object.conversion.aoc.genie_unit import GenieGameEntityGroup, \
+    GenieBuildingLineGroup, GenieVillagerGroup, GenieAmbientGroup, GenieVariantGroup
+from .....entity_object.conversion.converter_object import RawAPIObject
+from .....service.conversion import internal_name_lookups
+from .....value_object.conversion.forward_ref import ForwardRef
+
+
+def gather_rate_modifier(converter_obj_group: GenieGameEntityGroup) -> list[ForwardRef]:
+    """
+    Adds Gather modifiers to a line or civ group.
+
+    :param converter_obj_group: ConverterObjectGroup that gets the modifier.
+    :returns: The forward reference for the modifier.
+    """
+    dataset = converter_obj_group.data
+
+    modifiers = []
+
+    if isinstance(converter_obj_group, GenieGameEntityGroup):
+        if isinstance(converter_obj_group, GenieVillagerGroup):
+            gatherers = converter_obj_group.variants[0].line
+
+        else:
+            gatherers = [converter_obj_group.line[0]]
+
+        head_unit_id = converter_obj_group.get_head_unit_id()
+
+        name_lookup_dict = internal_name_lookups.get_entity_lookups(dataset.game_version)
+
+        target_obj_name = name_lookup_dict[head_unit_id][0]
+
+        for gatherer in gatherers:
+            unit_commands = gatherer["unit_commands"].value
+
+            for command in unit_commands:
+                # Find a gather ability.
+                type_id = command["type"].value
+
+                gather_task_ids = internal_name_lookups.get_gather_lookups(
+                    dataset.game_version).keys()
+                if type_id not in gather_task_ids:
+                    continue
+
+                work_value = command["work_value1"].value
+
+                # Check if the work value is 1 (with some rounding error margin)
+                # if not, we have to create a modifier
+                if 0.9999 < work_value < 1.0001:
+                    continue
+
+                # Search for the lines with the matching class/unit id
+                class_id = command["class_id"].value
+                unit_id = command["unit_id"].value
+
+                entity_lines = {}
+                entity_lines.update(dataset.unit_lines)
+                entity_lines.update(dataset.building_lines)
+                entity_lines.update(dataset.ambient_groups)
+                entity_lines.update(dataset.variant_groups)
+
+                if unit_id != -1:
+                    lines = [entity_lines[unit_id]]
+
+                elif class_id != -1:
+                    lines = []
+                    for line in entity_lines.values():
+                        if line.get_class_id() == class_id:
+                            lines.append(line)
+
+                else:
+                    raise ValueError("Gather task has no valid target ID.")
+
+                # Create a modifier for each matching resource spot
+                for resource_line in lines:
+                    head_unit_id = resource_line.get_head_unit_id()
+                    if isinstance(resource_line, GenieBuildingLineGroup):
+                        resource_line_name = name_lookup_dict[head_unit_id][0]
+
+                    elif isinstance(resource_line, GenieAmbientGroup):
+                        resource_line_name = name_lookup_dict[head_unit_id][0]
+
+                    elif isinstance(resource_line, GenieVariantGroup):
+                        resource_line_name = name_lookup_dict[head_unit_id][1]
+
+                    modifier_ref = f"{target_obj_name}.{resource_line_name}GatheringRate"
+                    modifier_raw_api_object = RawAPIObject(modifier_ref,
+                                                           "%sGatheringRate",
+                                                           dataset.nyan_api_objects)
+                    modifier_raw_api_object.add_raw_parent(
+                        "engine.modifier.multiplier.type.GatheringRate")
+                    modifier_location = ForwardRef(converter_obj_group, target_obj_name)
+                    modifier_raw_api_object.set_location(modifier_location)
+
+                    # Multiplier
+                    modifier_raw_api_object.add_raw_member(
+                        "multiplier",
+                        work_value,
+                        "engine.modifier.multiplier.MultiplierModifier"
+                    )
+
+                    # Resource spot
+                    spot_ref = (f"{resource_line_name}.Harvestable."
+                                f"{resource_line_name}ResourceSpot")
+                    spot_forward_ref = ForwardRef(resource_line, spot_ref)
+                    modifier_raw_api_object.add_raw_member(
+                        "resource_spot",
+                        spot_forward_ref,
+                        "engine.modifier.multiplier.type.GatheringRate"
+                    )
+
+                    converter_obj_group.add_raw_api_object(modifier_raw_api_object)
+                    modifier_forward_ref = ForwardRef(converter_obj_group,
+                                                      modifier_raw_api_object.get_id())
+                    modifiers.append(modifier_forward_ref)
+
+    return modifiers

openage/convert/processor/conversion/aoc/modifier/move_speed.py

@@ -0,0 +1,49 @@
+# Copyright 2025-2025 the openage authors. See copying.md for legal info.
+
+"""
+nyan conversion routines for the MoveSpeed modifier.
+"""
+from __future__ import annotations
+import typing
+
+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.aoc.genie_unit import GenieGameEntityGroup
+
+
+def move_speed_modifier(converter_obj_group: GenieGameEntityGroup, value: float) -> ForwardRef:
+    """
+    Adds a MoveSpeed modifier to a line or civ group.
+
+    :param converter_obj_group: ConverterObjectGroup that gets the modifier.
+    :returns: The forward reference for the modifier.
+    """
+    dataset = converter_obj_group.data
+    if isinstance(converter_obj_group, GenieGameEntityGroup):
+        head_unit_id = converter_obj_group.get_head_unit_id()
+        name_lookup_dict = internal_name_lookups.get_entity_lookups(dataset.game_version)
+        target_obj_name = name_lookup_dict[head_unit_id][0]
+
+    else:
+        # Civs
+        civ_lookup_dict = internal_name_lookups.get_civ_lookups(dataset.game_version)
+        target_obj_name = civ_lookup_dict[converter_obj_group.get_id()][0]
+
+    modifier_ref = f"{target_obj_name}.MoveSpeed"
+    modifier_raw_api_object = RawAPIObject(modifier_ref, "MoveSpeed", dataset.nyan_api_objects)
+    modifier_raw_api_object.add_raw_parent("engine.modifier.multiplier.type.MoveSpeed")
+    modifier_location = ForwardRef(converter_obj_group, target_obj_name)
+    modifier_raw_api_object.set_location(modifier_location)
+
+    modifier_raw_api_object.add_raw_member("multiplier",
+                                           value,
+                                           "engine.modifier.multiplier.MultiplierModifier")
+
+    converter_obj_group.add_raw_api_object(modifier_raw_api_object)
+
+    modifier_forward_ref = ForwardRef(converter_obj_group, modifier_raw_api_object.get_id())
+
+    return modifier_forward_ref