Update to 0.2.14 from 'dev' branch

KSneijders · Jan 11, 2025 · 56c53e6 · 56c53e6
2 parents a76de15 + 59f4e48
commit 56c53e6
Show file tree

Hide file tree

Showing 43 changed files with 142 additions and 43 deletions.
diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml
@@ -14,9 +14,10 @@ jobs:
 
       - name: Remove testing and other doc artifacts (As much as feasible at the moment)
         run: |
-             find AoE2ScenarioParser/datasets -maxdepth 2 -name '*.py' -exec sed -i 's/    >>> .*//' {} + 
-             find AoE2ScenarioParser/datasets -maxdepth 2 -name '*.py' -exec sed -i 's/    <.*: .*>//' {} + 
-             find AoE2ScenarioParser/datasets -maxdepth 2 -name '*.py' -exec sed -i 's/    \*\*\(?:\|Examples\|Methods\|Inherited\)\*\*:\?//' {} + 
+             find AoE2ScenarioParser/datasets -maxdepth 2 -name '*.py' -exec perl -pie 's/    >>> .*//' {} +
+             find AoE2ScenarioParser/datasets -maxdepth 2 -name '*.py' -exec perl -pie 's/    <.*: .*>//' {} +
+             find AoE2ScenarioParser/datasets -maxdepth 2 -name '*.py' -exec perl -pie 's/    \*\*\(?:\|Examples\|Methods\|Inherited\)\*\*:\?//' {} +
+             find AoE2ScenarioParser/datasets -maxdepth 2 -name '*.py' -exec perl -pie 's/\[([A-Za-z0-9 ]*)\]\((?!https)[^(]+\)/$1/g' {} +
 
       - name: Deploy docs
         uses: mhausenblas/mkdocs-deploy-gh-pages@master

diff --git a/AoE2ScenarioParser/objects/managers/de/map_manager_de.py b/AoE2ScenarioParser/objects/managers/de/map_manager_de.py
@@ -1,5 +1,6 @@
 from typing import List
 
+from AoE2ScenarioParser.datasets.trigger_lists import ColorMood
 from AoE2ScenarioParser.helper.printers import warn
 from AoE2ScenarioParser.objects.data_objects.terrain_tile import TerrainTile
 from AoE2ScenarioParser.objects.managers.map_manager import MapManager
@@ -32,6 +33,9 @@ def __init__(self,
                  ):
         super().__init__(map_width, map_height, terrain, **kwargs)
 
+        if map_color_mood.upper() in ColorMood.__members__:
+            map_color_mood = ColorMood[map_color_mood.upper()]
+
         self.map_color_mood: str = map_color_mood
         self.collide_and_correct: bool = collide_and_correct
         self.villager_force_drop: bool = villager_force_drop

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ---
 
+## 0.2.14 - 2025-Januari-11
+
+[Datasets documentation](https://ksneijders.github.io/AoE2ScenarioParser/api_docs/datasets/trigger_lists/action_type/) has been improved:
+
+- Ordering of attributes within datasets has been matched to source instead of alphabetically.
+  - So (for example) the order of ages is no longer: "Castle Age, Dark Age, Feudal Age, Imperial Age"
+- Invalid links from UGC site have been filtered out
+
+### Changed
+
+- `MapManager.map_color_mood` will now return the `ColorMood` enum when possible
+
+---
+
 ## 0.2.13 - 2024-December-31
 
 Datasets are now in the API docs! [They should appear here](https://ksneijders.github.io/AoE2ScenarioParser/api_docs/datasets/trigger_lists/action_type/)!  

diff --git a/docs/api_docs/datasets/trigger_lists/action_type.md b/docs/api_docs/datasets/trigger_lists/action_type.md
@@ -1 +1,3 @@
-::: AoE2ScenarioParser.datasets.trigger_lists.action_type.ActionType
+::: AoE2ScenarioParser.datasets.trigger_lists.action_type.ActionType
+    options:
+      members_order: 'source'
diff --git a/docs/api_docs/datasets/trigger_lists/age.md b/docs/api_docs/datasets/trigger_lists/age.md
@@ -1 +1,3 @@
-::: AoE2ScenarioParser.datasets.trigger_lists.age.Age
+::: AoE2ScenarioParser.datasets.trigger_lists.age.Age
+    options:
+      members_order: 'source'
diff --git a/docs/api_docs/datasets/trigger_lists/attack_stance.md b/docs/api_docs/datasets/trigger_lists/attack_stance.md
@@ -1 +1,3 @@
-::: AoE2ScenarioParser.datasets.trigger_lists.attack_stance.AttackStance
+::: AoE2ScenarioParser.datasets.trigger_lists.attack_stance.AttackStance
+    options:
+      members_order: 'source'
diff --git a/docs/api_docs/datasets/trigger_lists/attribute.md b/docs/api_docs/datasets/trigger_lists/attribute.md
@@ -1 +1,3 @@
-::: AoE2ScenarioParser.datasets.trigger_lists.attribute.Attribute
+::: AoE2ScenarioParser.datasets.trigger_lists.attribute.Attribute
+    options:
+      members_order: 'source'
diff --git a/docs/api_docs/datasets/trigger_lists/blast_level.md b/docs/api_docs/datasets/trigger_lists/blast_level.md
@@ -1 +1,3 @@
-::: AoE2ScenarioParser.datasets.trigger_lists.blast_level.BlastLevel
+::: AoE2ScenarioParser.datasets.trigger_lists.blast_level.BlastLevel
+    options:
+      members_order: 'source'
diff --git a/docs/api_docs/datasets/trigger_lists/blockage_class.md b/docs/api_docs/datasets/trigger_lists/blockage_class.md
@@ -1 +1,3 @@
-::: AoE2ScenarioParser.datasets.trigger_lists.blockage_class.BlockageClass
+::: AoE2ScenarioParser.datasets.trigger_lists.blockage_class.BlockageClass
+    options:
+      members_order: 'source'
diff --git a/docs/api_docs/datasets/trigger_lists/button_location.md b/docs/api_docs/datasets/trigger_lists/button_location.md
@@ -1 +1,3 @@
-::: AoE2ScenarioParser.datasets.trigger_lists.button_location.ButtonLocation
+::: AoE2ScenarioParser.datasets.trigger_lists.button_location.ButtonLocation
+    options:
+      members_order: 'source'
diff --git a/docs/api_docs/datasets/trigger_lists/charge_event.md b/docs/api_docs/datasets/trigger_lists/charge_event.md
@@ -1 +1,3 @@
-::: AoE2ScenarioParser.datasets.trigger_lists.charge_event.ChargeEvent
+::: AoE2ScenarioParser.datasets.trigger_lists.charge_event.ChargeEvent
+    options:
+      members_order: 'source'
diff --git a/docs/api_docs/datasets/trigger_lists/charge_type.md b/docs/api_docs/datasets/trigger_lists/charge_type.md
@@ -1 +1,3 @@
-::: AoE2ScenarioParser.datasets.trigger_lists.charge_type.ChargeType
+::: AoE2ScenarioParser.datasets.trigger_lists.charge_type.ChargeType
+    options:
+      members_order: 'source'
diff --git a/docs/api_docs/datasets/trigger_lists/color_mood.md b/docs/api_docs/datasets/trigger_lists/color_mood.md
@@ -1 +1,3 @@
-::: AoE2ScenarioParser.datasets.trigger_lists.color_mood.ColorMood
+::: AoE2ScenarioParser.datasets.trigger_lists.color_mood.ColorMood
+    options:
+      members_order: 'source'
diff --git a/docs/api_docs/datasets/trigger_lists/combat_ability.md b/docs/api_docs/datasets/trigger_lists/combat_ability.md
@@ -1 +1,3 @@
-::: AoE2ScenarioParser.datasets.trigger_lists.combat_ability.CombatAbility
+::: AoE2ScenarioParser.datasets.trigger_lists.combat_ability.CombatAbility
+    options:
+      members_order: 'source'
diff --git a/docs/api_docs/datasets/trigger_lists/comparison.md b/docs/api_docs/datasets/trigger_lists/comparison.md
@@ -1 +1,3 @@
-::: AoE2ScenarioParser.datasets.trigger_lists.comparison.Comparison
+::: AoE2ScenarioParser.datasets.trigger_lists.comparison.Comparison
+    options:
+      members_order: 'source'
diff --git a/docs/api_docs/datasets/trigger_lists/damage_class.md b/docs/api_docs/datasets/trigger_lists/damage_class.md
@@ -1 +1,3 @@
-::: AoE2ScenarioParser.datasets.trigger_lists.damage_class.DamageClass
+::: AoE2ScenarioParser.datasets.trigger_lists.damage_class.DamageClass
+    options:
+      members_order: 'source'
diff --git a/docs/api_docs/datasets/trigger_lists/difficulty_level.md b/docs/api_docs/datasets/trigger_lists/difficulty_level.md
@@ -1 +1,3 @@
-::: AoE2ScenarioParser.datasets.trigger_lists.difficulty_level.DifficultyLevel
+::: AoE2ScenarioParser.datasets.trigger_lists.difficulty_level.DifficultyLevel
+    options:
+      members_order: 'source'
diff --git a/docs/api_docs/datasets/trigger_lists/diplomacy_state.md b/docs/api_docs/datasets/trigger_lists/diplomacy_state.md
@@ -1 +1,3 @@
-::: AoE2ScenarioParser.datasets.trigger_lists.diplomacy_state.DiplomacyState
+::: AoE2ScenarioParser.datasets.trigger_lists.diplomacy_state.DiplomacyState
+    options:
+      members_order: 'source'
diff --git a/docs/api_docs/datasets/trigger_lists/fog_visibility.md b/docs/api_docs/datasets/trigger_lists/fog_visibility.md
@@ -1 +1,3 @@
-::: AoE2ScenarioParser.datasets.trigger_lists.fog_visibility.FogVisibility
+::: AoE2ScenarioParser.datasets.trigger_lists.fog_visibility.FogVisibility
+    options:
+      members_order: 'source'
diff --git a/docs/api_docs/datasets/trigger_lists/garrison_type.md b/docs/api_docs/datasets/trigger_lists/garrison_type.md
@@ -1 +1,3 @@
-::: AoE2ScenarioParser.datasets.trigger_lists.garrison_type.GarrisonType
+::: AoE2ScenarioParser.datasets.trigger_lists.garrison_type.GarrisonType
+    options:
+      members_order: 'source'
diff --git a/docs/api_docs/datasets/trigger_lists/hero_status_flag.md b/docs/api_docs/datasets/trigger_lists/hero_status_flag.md
@@ -1 +1,3 @@
-::: AoE2ScenarioParser.datasets.trigger_lists.hero_status_flag.HeroStatusFlag
+::: AoE2ScenarioParser.datasets.trigger_lists.hero_status_flag.HeroStatusFlag
+    options:
+      members_order: 'source'
diff --git a/docs/api_docs/datasets/trigger_lists/hotkey.md b/docs/api_docs/datasets/trigger_lists/hotkey.md
@@ -1 +1,3 @@
-::: AoE2ScenarioParser.datasets.trigger_lists.hotkey.Hotkey
+::: AoE2ScenarioParser.datasets.trigger_lists.hotkey.Hotkey
+    options:
+      members_order: 'source'
diff --git a/docs/api_docs/datasets/trigger_lists/object_attribute.md b/docs/api_docs/datasets/trigger_lists/object_attribute.md
@@ -1 +1,3 @@
-::: AoE2ScenarioParser.datasets.trigger_lists.object_attribute.ObjectAttribute
+::: AoE2ScenarioParser.datasets.trigger_lists.object_attribute.ObjectAttribute
+    options:
+      members_order: 'source'
diff --git a/docs/api_docs/datasets/trigger_lists/object_class.md b/docs/api_docs/datasets/trigger_lists/object_class.md
@@ -1 +1,3 @@
-::: AoE2ScenarioParser.datasets.trigger_lists.object_class.ObjectClass
+::: AoE2ScenarioParser.datasets.trigger_lists.object_class.ObjectClass
+    options:
+      members_order: 'source'
diff --git a/docs/api_docs/datasets/trigger_lists/object_state.md b/docs/api_docs/datasets/trigger_lists/object_state.md
@@ -1 +1,3 @@
-::: AoE2ScenarioParser.datasets.trigger_lists.object_state.ObjectState
+::: AoE2ScenarioParser.datasets.trigger_lists.object_state.ObjectState
+    options:
+      members_order: 'source'
diff --git a/docs/api_docs/datasets/trigger_lists/object_type.md b/docs/api_docs/datasets/trigger_lists/object_type.md
@@ -1 +1,3 @@
-::: AoE2ScenarioParser.datasets.trigger_lists.object_type.ObjectType
+::: AoE2ScenarioParser.datasets.trigger_lists.object_type.ObjectType
+    options:
+      members_order: 'source'
diff --git a/docs/api_docs/datasets/trigger_lists/obstruction_type.md b/docs/api_docs/datasets/trigger_lists/obstruction_type.md
@@ -1 +1,3 @@
-::: AoE2ScenarioParser.datasets.trigger_lists.obstruction_type.ObstructionType
+::: AoE2ScenarioParser.datasets.trigger_lists.obstruction_type.ObstructionType
+    options:
+      members_order: 'source'
diff --git a/docs/api_docs/datasets/trigger_lists/occlusion_mode.md b/docs/api_docs/datasets/trigger_lists/occlusion_mode.md
@@ -1 +1,3 @@
-::: AoE2ScenarioParser.datasets.trigger_lists.occlusion_mode.OcclusionMode
+::: AoE2ScenarioParser.datasets.trigger_lists.occlusion_mode.OcclusionMode
+    options:
+      members_order: 'source'
diff --git a/docs/api_docs/datasets/trigger_lists/operation.md b/docs/api_docs/datasets/trigger_lists/operation.md
@@ -1 +1,3 @@
-::: AoE2ScenarioParser.datasets.trigger_lists.operation.Operation
+::: AoE2ScenarioParser.datasets.trigger_lists.operation.Operation
+    options:
+      members_order: 'source'
diff --git a/docs/api_docs/datasets/trigger_lists/panel_location.md b/docs/api_docs/datasets/trigger_lists/panel_location.md
@@ -1 +1,3 @@
-::: AoE2ScenarioParser.datasets.trigger_lists.panel_location.PanelLocation
+::: AoE2ScenarioParser.datasets.trigger_lists.panel_location.PanelLocation
+    options:
+      members_order: 'source'
diff --git a/docs/api_docs/datasets/trigger_lists/projectile_hit_mode.md b/docs/api_docs/datasets/trigger_lists/projectile_hit_mode.md
@@ -1 +1,3 @@
-::: AoE2ScenarioParser.datasets.trigger_lists.projectile_hit_mode.ProjectileHitMode
+::: AoE2ScenarioParser.datasets.trigger_lists.projectile_hit_mode.ProjectileHitMode
+    options:
+      members_order: 'source'
diff --git a/docs/api_docs/datasets/trigger_lists/projectile_smart_mode.md b/docs/api_docs/datasets/trigger_lists/projectile_smart_mode.md
@@ -1 +1,3 @@
-::: AoE2ScenarioParser.datasets.trigger_lists.projectile_smart_mode.ProjectileSmartMode
+::: AoE2ScenarioParser.datasets.trigger_lists.projectile_smart_mode.ProjectileSmartMode
+    options:
+      members_order: 'source'
diff --git a/docs/api_docs/datasets/trigger_lists/projectile_vanish_mode.md b/docs/api_docs/datasets/trigger_lists/projectile_vanish_mode.md
@@ -1 +1,3 @@
-::: AoE2ScenarioParser.datasets.trigger_lists.projectile_vanish_mode.ProjectileVanishMode
+::: AoE2ScenarioParser.datasets.trigger_lists.projectile_vanish_mode.ProjectileVanishMode
+    options:
+      members_order: 'source'
diff --git a/docs/api_docs/datasets/trigger_lists/secondary_game_mode.md b/docs/api_docs/datasets/trigger_lists/secondary_game_mode.md
@@ -1 +1,3 @@
-::: AoE2ScenarioParser.datasets.trigger_lists.secondary_game_mode.SecondaryGameMode
+::: AoE2ScenarioParser.datasets.trigger_lists.secondary_game_mode.SecondaryGameMode
+    options:
+      members_order: 'source'
diff --git a/docs/api_docs/datasets/trigger_lists/selection_effect.md b/docs/api_docs/datasets/trigger_lists/selection_effect.md
@@ -1 +1,3 @@
-::: AoE2ScenarioParser.datasets.trigger_lists.selection_effect.SelectionEffect
+::: AoE2ScenarioParser.datasets.trigger_lists.selection_effect.SelectionEffect
+    options:
+      members_order: 'source'
diff --git a/docs/api_docs/datasets/trigger_lists/technology_state.md b/docs/api_docs/datasets/trigger_lists/technology_state.md
@@ -1 +1,3 @@
-::: AoE2ScenarioParser.datasets.trigger_lists.technology_state.TechnologyState
+::: AoE2ScenarioParser.datasets.trigger_lists.technology_state.TechnologyState
+    options:
+      members_order: 'source'
diff --git a/docs/api_docs/datasets/trigger_lists/terrain_restrictions.md b/docs/api_docs/datasets/trigger_lists/terrain_restrictions.md
@@ -1 +1,3 @@
-::: AoE2ScenarioParser.datasets.trigger_lists.terrain_restrictions.TerrainRestrictions
+::: AoE2ScenarioParser.datasets.trigger_lists.terrain_restrictions.TerrainRestrictions
+    options:
+      members_order: 'source'
diff --git a/docs/api_docs/datasets/trigger_lists/time_unit.md b/docs/api_docs/datasets/trigger_lists/time_unit.md
@@ -1 +1,3 @@
-::: AoE2ScenarioParser.datasets.trigger_lists.time_unit.TimeUnit
+::: AoE2ScenarioParser.datasets.trigger_lists.time_unit.TimeUnit
+    options:
+      members_order: 'source'
diff --git a/docs/api_docs/datasets/trigger_lists/unit_ai_action.md b/docs/api_docs/datasets/trigger_lists/unit_ai_action.md
@@ -1 +1,3 @@
-::: AoE2ScenarioParser.datasets.trigger_lists.unit_ai_action.UnitAIAction
+::: AoE2ScenarioParser.datasets.trigger_lists.unit_ai_action.UnitAIAction
+    options:
+      members_order: 'source'
diff --git a/docs/api_docs/datasets/trigger_lists/unit_trait.md b/docs/api_docs/datasets/trigger_lists/unit_trait.md
@@ -1 +1,3 @@
-::: AoE2ScenarioParser.datasets.trigger_lists.unit_trait.UnitTrait
+::: AoE2ScenarioParser.datasets.trigger_lists.unit_trait.UnitTrait
+    options:
+      members_order: 'source'
diff --git a/docs/api_docs/datasets/trigger_lists/victory_condition.md b/docs/api_docs/datasets/trigger_lists/victory_condition.md
@@ -1 +1,3 @@
-::: AoE2ScenarioParser.datasets.trigger_lists.victory_condition.VictoryCondition
+::: AoE2ScenarioParser.datasets.trigger_lists.victory_condition.VictoryCondition
+    options:
+      members_order: 'source'
diff --git a/docs/api_docs/datasets/trigger_lists/victory_timer_type.md b/docs/api_docs/datasets/trigger_lists/victory_timer_type.md
@@ -1 +1,3 @@
-::: AoE2ScenarioParser.datasets.trigger_lists.victory_timer_type.VictoryTimerType
+::: AoE2ScenarioParser.datasets.trigger_lists.victory_timer_type.VictoryTimerType
+    options:
+      members_order: 'source'
diff --git a/docs/api_docs/datasets/trigger_lists/visibility_state.md b/docs/api_docs/datasets/trigger_lists/visibility_state.md
@@ -1 +1,3 @@
-::: AoE2ScenarioParser.datasets.trigger_lists.visibility_state.VisibilityState
+::: AoE2ScenarioParser.datasets.trigger_lists.visibility_state.VisibilityState
+    options:
+      members_order: 'source'