convert: Remove typedefs from docstrings.

These have been replaced by type hints in the function signature.

Author: heinezen

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

@@ -16,9 +16,7 @@ def active_transform_to_ability(line: GenieGameEntityGroup) -> ForwardRef:
     Adds the ActiveTransformTo ability to a line.
 
     :param line: Unit/Building line that gets the ability.
-    :type line: ...dataformat.converter_object.ConverterObjectGroup
     :returns: The forward reference for the ability.
-    :rtype: ...dataformat.forward_ref.ForwardRef
     """
     # TODO: Implement
     return None

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

@@ -21,9 +21,7 @@ def activity_ability(line: GenieGameEntityGroup) -> ForwardRef:
     Adds the Activity ability to a line.
 
     :param line: Unit/Building line that gets the ability.
-    :type line: ...dataformat.converter_object.ConverterObjectGroup
     :returns: The forward reference for the ability.
-    :rtype: ...dataformat.forward_ref.ForwardRef
     """
     current_unit_id = line.get_head_unit_id()
 

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

@@ -27,9 +27,7 @@ def apply_continuous_effect_ability(
     Adds the ApplyContinuousEffect ability to a line.
 
     :param line: Unit/Building line that gets the ability.
-    :type line: ...dataformat.converter_object.ConverterObjectGroup
     :returns: The forward reference for the ability.
-    :rtype: ...dataformat.forward_ref.ForwardRef
     """
     if isinstance(line, GenieVillagerGroup):
         current_unit = line.get_units_with_command(command_id)[0]

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

@@ -28,9 +28,7 @@ def apply_discrete_effect_ability(
     Adds the ApplyDiscreteEffect ability to a line.
 
     :param line: Unit/Building line that gets the ability.
-    :type line: ...dataformat.converter_object.ConverterObjectGroup
     :returns: The forward reference for the ability.
-    :rtype: ...dataformat.forward_ref.ForwardRef
     """
     if isinstance(line, GenieVillagerGroup):
         current_unit = line.get_units_with_command(command_id)[0]

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

@@ -21,9 +21,7 @@ def attribute_change_tracker_ability(line: GenieGameEntityGroup) -> ForwardRef:
     Adds the AttributeChangeTracker ability to a line.
 
     :param line: Unit/Building line that gets the ability.
-    :type line: ...dataformat.converter_object.ConverterObjectGroup
     :returns: The forward reference for the ability.
-    :rtype: ...dataformat.forward_ref.ForwardRef
     """
     current_unit = line.get_head_unit()
     current_unit_id = line.get_head_unit_id()

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

@@ -20,9 +20,7 @@ def collect_storage_ability(line: GenieGameEntityGroup) -> ForwardRef:
     Adds the CollectStorage ability to a line.
 
     :param line: Unit/Building line that gets the ability.
-    :type line: ...dataformat.converter_object.ConverterObjectGroup
     :returns: The forward reference for the ability.
-    :rtype: ...dataformat.forward_ref.ForwardRef
     """
     current_unit_id = line.get_head_unit_id()
     dataset = line.data

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

@@ -20,9 +20,7 @@ def collision_ability(line: GenieGameEntityGroup) -> ForwardRef:
     Adds the Collision ability to a line.
 
     :param line: Unit/Building line that gets the ability.
-    :type line: ...dataformat.converter_object.ConverterObjectGroup
     :returns: The forward reference for the ability.
-    :rtype: ...dataformat.forward_ref.ForwardRef
     """
     current_unit = line.get_head_unit()
     current_unit_id = line.get_head_unit_id()

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

@@ -22,9 +22,7 @@ def constructable_ability(line: GenieGameEntityGroup) -> ForwardRef:
     Adds the Constructable ability to a line.
 
     :param line: Unit/Building line that gets the ability.
-    :type line: ...dataformat.converter_object.ConverterObjectGroup
     :returns: The forward reference for the ability.
-    :rtype: ...dataformat.forward_ref.ForwardRef
     """
     current_unit = line.get_head_unit()
     current_unit_id = line.get_head_unit_id()

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

@@ -20,9 +20,7 @@ def create_ability(line: GenieGameEntityGroup) -> ForwardRef:
     Adds the Create ability to a line.
 
     :param line: Unit/Building line that gets the ability.
-    :type line: ...dataformat.converter_object.ConverterObjectGroup
     :returns: The forward reference for the ability.
-    :rtype: ...dataformat.forward_ref.ForwardRef
     """
     current_unit_id = line.get_head_unit_id()
     dataset = line.data

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

@@ -24,9 +24,7 @@ def death_ability(line: GenieGameEntityGroup) -> ForwardRef:
     based on a condition.
 
     :param line: Unit/Building line that gets the ability.
-    :type line: ...dataformat.converter_object.ConverterObjectGroup
     :returns: The forward reference for the ability.
-    :rtype: ...dataformat.forward_ref.ForwardRef
     """
     current_unit = line.get_head_unit()
     current_unit_id = line.get_head_unit_id()

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

@@ -17,12 +17,11 @@
 
 def delete_ability(line: GenieGameEntityGroup) -> ForwardRef:
     """
-    Adds a PassiveTransformTo ability to a line that is used to make entities deletable.
+    Adds a PassiveTransformTo ability to a line that is used to make entities deletable,
+    i.e. die on command.
 
     :param line: Unit/Building line that gets the ability.
-    :type line: ...dataformat.converter_object.ConverterObjectGroup
     :returns: The forward reference for the ability.
-    :rtype: ...dataformat.forward_ref.ForwardRef
     """
     current_unit = line.get_head_unit()
     current_unit_id = line.get_head_unit_id()

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

@@ -21,9 +21,7 @@ def despawn_ability(line: GenieGameEntityGroup) -> ForwardRef:
     Adds the Despawn ability to a line.
 
     :param line: Unit/Building line that gets the ability.
-    :type line: ...dataformat.converter_object.ConverterObjectGroup
     :returns: The forward reference for the ability.
-    :rtype: ...dataformat.forward_ref.ForwardRef
     """
     current_unit = line.get_head_unit()
     current_unit_id = line.get_head_unit_id()

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

@@ -23,9 +23,7 @@ def drop_resources_ability(line: GenieGameEntityGroup) -> ForwardRef:
     Adds the DropResources ability to a line.
 
     :param line: Unit/Building line that gets the ability.
-    :type line: ...dataformat.converter_object.ConverterObjectGroup
     :returns: The forward reference for the ability.
-    :rtype: ...dataformat.forward_ref.ForwardRef
     """
     if isinstance(line, GenieVillagerGroup):
         gatherers = line.variants[0].line

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

@@ -20,9 +20,7 @@ def drop_site_ability(line: GenieGameEntityGroup) -> ForwardRef:
     Adds the DropSite ability to a line.
 
     :param line: Unit/Building line that gets the ability.
-    :type line: ...dataformat.converter_object.ConverterObjectGroup
     :returns: The forward reference for the ability.
-    :rtype: ...dataformat.forward_ref.ForwardRef
     """
     current_unit_id = line.get_head_unit_id()
     dataset = line.data

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

@@ -21,9 +21,7 @@ def enter_container_ability(line: GenieGameEntityGroup) -> ForwardRef:
     Adds the EnterContainer ability to a line.
 
     :param line: Unit/Building line that gets the ability.
-    :type line: ...dataformat.converter_object.ConverterObjectGroup
     :returns: The forward reference for the ability. None if no valid containers were found.
-    :rtype: ...dataformat.forward_ref.ForwardRef, None
     """
     current_unit_id = line.get_head_unit_id()
     dataset = line.data

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

@@ -20,9 +20,7 @@ def exchange_resources_ability(line: GenieGameEntityGroup) -> ForwardRef:
     Adds the ExchangeResources ability to a line.
 
     :param line: Unit/Building line that gets the ability.
-    :type line: ...dataformat.converter_object.ConverterObjectGroup
     :returns: The forward reference for the ability.
-    :rtype: ...dataformat.forward_ref.ForwardRef
     """
     current_unit_id = line.get_head_unit_id()
     dataset = line.data

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

@@ -21,9 +21,7 @@ def exit_container_ability(line: GenieGameEntityGroup) -> ForwardRef:
     Adds the ExitContainer ability to a line.
 
     :param line: Unit/Building line that gets the ability.
-    :type line: ...dataformat.converter_object.ConverterObjectGroup
     :returns: The forward reference for the ability. None if no valid containers were found.
-    :rtype: ...dataformat.forward_ref.ForwardRef, None
     """
     current_unit_id = line.get_head_unit_id()
     dataset = line.data

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

@@ -20,9 +20,7 @@ def formation_ability(line: GenieGameEntityGroup) -> ForwardRef:
     Adds the Formation ability to a line.
 
     :param line: Unit/Building line that gets the ability.
-    :type line: ...dataformat.converter_object.ConverterObjectGroup
     :returns: The forward reference for the ability.
-    :rtype: ...dataformat.forward_ref.ForwardRef
     """
     current_unit_id = line.get_head_unit_id()
     dataset = line.data

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

@@ -21,11 +21,8 @@ def foundation_ability(line: GenieGameEntityGroup, terrain_id: int = -1) -> Forw
     terrain ID.
 
     :param line: Unit/Building line that gets the ability.
-    :type line: ...dataformat.converter_object.ConverterObjectGroup
     :param terrain_id: Force this terrain ID as foundation
-    :type terrain_id: int
     :returns: The forward references for the abilities.
-    :rtype: ...dataformat.forward_ref.ForwardRef
     """
     current_unit = line.get_head_unit()
     current_unit_id = line.get_head_unit_id()

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

@@ -20,9 +20,7 @@ def game_entity_stance_ability(line: GenieGameEntityGroup) -> ForwardRef:
     Adds the GameEntityStance ability to a line.
 
     :param line: Unit/Building line that gets the ability.
-    :type line: ...dataformat.converter_object.ConverterObjectGroup
     :returns: The forward reference for the ability.
-    :rtype: ...dataformat.forward_ref.ForwardRef
     """
     current_unit = line.get_head_unit()
     current_unit_id = line.get_head_unit_id()

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

@@ -19,15 +19,13 @@
     from .....value_object.conversion.forward_ref import ForwardRef
 
 
-def gather_ability(line: GenieGameEntityGroup) -> ForwardRef:
+def gather_ability(line: GenieGameEntityGroup) -> list[ForwardRef]:
     """
     Adds the Gather abilities to a line. Unlike the other methods, this
     creates multiple abilities.
 
     :param line: Unit/Building line that gets the ability.
-    :type line: ...dataformat.converter_object.ConverterObjectGroup
     :returns: The forward references for the abilities.
-    :rtype: list
     """
     if isinstance(line, GenieVillagerGroup):
         gatherers = line.variants[0].line

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

@@ -21,9 +21,7 @@ def harvestable_ability(line: GenieGameEntityGroup) -> ForwardRef:
     Adds the Harvestable ability to a line.
 
     :param line: Unit/Building line that gets the ability.
-    :type line: ...dataformat.converter_object.ConverterObjectGroup
     :returns: The forward reference for the ability.
-    :rtype: ...dataformat.forward_ref.ForwardRef
     """
     current_unit = line.get_head_unit()
     current_unit_id = line.get_head_unit_id()

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

@@ -20,9 +20,7 @@ def herd_ability(line: GenieGameEntityGroup) -> ForwardRef:
     Adds the Herd ability to a line.
 
     :param line: Unit/Building line that gets the ability.
-    :type line: ...dataformat.converter_object.ConverterObjectGroup
     :returns: The forward reference for the ability.
-    :rtype: ...dataformat.forward_ref.ForwardRef
     """
     current_unit_id = line.get_head_unit_id()
     dataset = line.data

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

@@ -20,9 +20,7 @@ def herdable_ability(line: GenieGameEntityGroup) -> ForwardRef:
     Adds the Herdable ability to a line.
 
     :param line: Unit/Building line that gets the ability.
-    :type line: ...dataformat.converter_object.ConverterObjectGroup
     :returns: The forward reference for the ability.
-    :rtype: ...dataformat.forward_ref.ForwardRef
     """
     current_unit_id = line.get_head_unit_id()
     dataset = line.data

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

@@ -21,9 +21,7 @@ def idle_ability(line: GenieGameEntityGroup) -> ForwardRef:
     Adds the Idle ability to a line.
 
     :param line: Unit/Building line that gets the ability.
-    :type line: ...dataformat.converter_object.ConverterObjectGroup
     :returns: The forward reference for the ability.
-    :rtype: ...dataformat.forward_ref.ForwardRef
     """
     current_unit = line.get_head_unit()
     current_unit_id = line.get_head_unit_id()

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

@@ -20,9 +20,7 @@ def line_of_sight_ability(line: GenieGameEntityGroup) -> ForwardRef:
     Adds the LineOfSight ability to a line.
 
     :param line: Unit/Building line that gets the ability.
-    :type line: ...dataformat.converter_object.ConverterObjectGroup
     :returns: The forward reference for the ability.
-    :rtype: ...dataformat.forward_ref.ForwardRef
     """
     current_unit = line.get_head_unit()
     current_unit_id = line.get_head_unit_id()

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

@@ -21,9 +21,7 @@ def live_ability(line: GenieGameEntityGroup) -> ForwardRef:
     Adds the Live ability to a line.
 
     :param line: Unit/Building line that gets the ability.
-    :type line: ...dataformat.converter_object.ConverterObjectGroup
     :returns: The forward reference for the ability.
-    :rtype: ...dataformat.forward_ref.ForwardRef
     """
     current_unit = line.get_head_unit()
     current_unit_id = line.get_head_unit_id()

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

@@ -21,9 +21,7 @@ def move_ability(line: GenieGameEntityGroup) -> ForwardRef:
     Adds the Move ability to a line.
 
     :param line: Unit/Building line that gets the ability.
-    :type line: ...dataformat.converter_object.ConverterObjectGroup
     :returns: The forward reference for the ability.
-    :rtype: ...dataformat.forward_ref.ForwardRef
     """
     current_unit = line.get_head_unit()
     current_unit_id = line.get_head_unit_id()
@@ -220,9 +218,7 @@ def move_projectile_ability(line: GenieGameEntityGroup, position: int = -1) -> F
     Adds the Move ability to a projectile of the specified line.
 
     :param line: Unit/Building line that gets the ability.
-    :type line: ...dataformat.converter_object.ConverterObjectGroup
     :returns: The forward reference for the ability.
-    :rtype: ...dataformat.forward_ref.ForwardRef
     """
     dataset = line.data
     api_objects = dataset.nyan_api_objects

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

@@ -21,9 +21,7 @@ def named_ability(line: GenieGameEntityGroup) -> ForwardRef:
     Adds the Named ability to a line.
 
     :param line: Unit/Building line that gets the ability.
-    :type line: ...dataformat.converter_object.ConverterObjectGroup
     :returns: The forward reference for the ability.
-    :rtype: ...dataformat.forward_ref.ForwardRef
     """
     current_unit = line.get_head_unit()
     current_unit_id = line.get_head_unit_id()

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

@@ -20,9 +20,7 @@ def overlay_terrain_ability(line: GenieGameEntityGroup) -> ForwardRef:
     Adds the OverlayTerrain to a line.
 
     :param line: Unit/Building line that gets the ability.
-    :type line: ...dataformat.converter_object.ConverterObjectGroup
     :returns: The forward references for the abilities.
-    :rtype: ...dataformat.forward_ref.ForwardRef
     """
     current_unit = line.get_head_unit()
     current_unit_id = line.get_head_unit_id()

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

@@ -20,9 +20,7 @@ def pathable_ability(line: GenieGameEntityGroup) -> ForwardRef:
     Adds the Pathable ability to a line.
 
     :param line: Unit/Building line that gets the ability.
-    :type line: ...dataformat.converter_object.ConverterObjectGroup
     :returns: The forward reference for the ability.
-    :rtype: ...dataformat.forward_ref.ForwardRef
     """
     current_unit_id = line.get_head_unit_id()
     dataset = line.data

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

@@ -20,9 +20,7 @@ def production_queue_ability(line: GenieGameEntityGroup) -> ForwardRef:
     Adds the ProductionQueue ability to a line.
 
     :param line: Unit/Building line that gets the ability.
-    :type line: ...dataformat.converter_object.ConverterObjectGroup
     :returns: The forward reference for the ability.
-    :rtype: ...dataformat.forward_ref.ForwardRef
     """
     current_unit_id = line.get_head_unit_id()
     dataset = line.data

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

@@ -23,11 +23,8 @@ def projectile_ability(line: GenieGameEntityGroup, position: int = 0) -> Forward
     be added is determined by the 'position' argument.
 
     :param line: Unit/Building line that gets the ability.
-    :type line: ...dataformat.converter_object.ConverterObjectGroup
-    :param position: When 0, gives the first projectile its ability. When 1, the second...
-    :type position: int
+    :param position: Index of the projectile to add (0 or 1 for AoC).
     :returns: The forward reference for the ability.
-    :rtype: ...dataformat.forward_ref.ForwardRef
     """
     current_unit = line.get_head_unit()
     current_unit_id = line.get_head_unit_id()

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

@@ -15,17 +15,13 @@
     from .....entity_object.conversion.aoc.genie_unit import GenieGameEntityGroup
     from .....value_object.conversion.forward_ref import ForwardRef
 
-# ASDF: remove type hints in docstring
-
 
 def provide_contingent_ability(line: GenieGameEntityGroup) -> ForwardRef:
     """
     Adds the ProvideContingent ability to a line.
 
     :param line: Unit/Building line that gets the ability.
-    :type line: ...dataformat.converter_object.ConverterObjectGroup
     :returns: The forward reference for the ability.
-    :rtype: ...dataformat.forward_ref.ForwardRef
     """
     current_unit = line.get_head_unit()
     if isinstance(line, GenieStackBuildingGroup):

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

@@ -20,9 +20,7 @@ def rally_point_ability(line: GenieGameEntityGroup) -> ForwardRef:
     Adds the RallyPoint ability to a line.
 
     :param line: Unit/Building line that gets the ability.
-    :type line: ...dataformat.converter_object.ConverterObjectGroup
     :returns: The forward reference for the ability.
-    :rtype: ...dataformat.forward_ref.ForwardRef
     """
     current_unit_id = line.get_head_unit_id()
     dataset = line.data

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

@@ -20,9 +20,7 @@ def regenerate_attribute_ability(line: GenieGameEntityGroup) -> ForwardRef:
     Adds the RegenerateAttribute ability to a line.
 
     :param line: Unit/Building line that gets the ability.
-    :type line: ...dataformat.converter_object.ConverterObjectGroup
     :returns: The forward references for the ability.
-    :rtype: list
     """
     current_unit_id = line.get_head_unit_id()
     dataset = line.data