Refactor trigger owner to be based on a HouseType reference instead of a string

Author: Rampastring

src/TSMapEditor/Config/Scripts/Add Map Reveal Trigger.cs

@@ -48,7 +48,7 @@ public void Perform(Map map)
         {
             var trigger = new Trigger(map.GetNewUniqueInternalId());
             trigger.Name = mapRevealTriggerName;
-            trigger.HouseType = "Neutral";
+            trigger.HouseType = map.FindHouseType(Constants.DefaultHouseTypeName);
 
             var timeElapsedCondition = new TriggerCondition();
             timeElapsedCondition.ConditionIndex = 13;

src/TSMapEditor/Config/Translations/en/Translation_en.ini

@@ -89,6 +89,8 @@ MapLoader.ReadSmudges.SmudgeOutOfBounds=Smudge at {0},{1} is placed outside of t
 MapLoader.ReadOverlays.OverlayIndexOutOfBounds=Ignoring overlay on tile at {0},{1} because it's out of bounds compared to Rules.ini overlay list
 MapLoader.ReadWaypoints.InvalidWaypointSyntax=Invalid syntax encountered for waypoint: {0}={1}
 MapLoader.ReadWaypoints.WaypointOutOfBounds=Waypoint {0} at {1} was not within the valid map area. It has been moved to {2}.
+MapLoader.ReadTriggers.FailedToLoadTrigger=Failed to load trigger {0}! It most likely has a malformed INI format.
+MapLoader.ReadTriggers.InvalidHouseTypeForTrigger=Trigger "{0}" had a non-existent HouseType "{1}" as its owner. It has been reset to \"{2}\".
 MapLoader.TriggerFix.InvalidTriggerAction=Trigger "{0}" had action "{1}" with invalid value for uncustomizable parameter #{2}: "{3}". It has been automatically corrected to "{4}".
 MapLoader.TriggerFix.InvalidTriggerAction=Trigger "{0}" had action "{1}" with invalid value for uncustomizable parameter #{2}: "{3}". It has been automatically corrected to "{4}".
 MapLoader.ReadTags.TriggerNotFound=Ignoring tag {0} because its related trigger {1} does not exist!
@@ -136,7 +138,7 @@ Map.CheckForIssues.TriggerEventNoObjectAttached=Trigger '{0}' is using the {1} e
 Map.CheckForIssues.TriggerAttachedToSelf=Trigger '{0}' is attached to itself (potentially through other triggers). This will cause the game to crash!
 Map.CheckForIssues.InvalidTriggerActionTeamType=Trigger '{0}' has a nonexistent TeamType specified as a parameter for one or more of its actions.
 Map.CheckForIssues.InvalidTriggerActionHouse=Trigger '{0}' has a nonexistent HouseType specified as a parameter for one or more of its actions.
-Map.CheckForIssues.InvalidTriggerOwner=Trigger '{0}' has a nonexistent HouseType '{1}' specified as its owner.
+Map.CheckForIssues.InvalidTriggerOwner=Trigger '{0}' has a nonexistent HouseType specified as its owner.
 Map.CheckForIssues.TriggerTooManyActions=Trigger '{0}' has more than {1} actions! This can cause the game to crash! Consider splitting it up to multiple triggers.
 Map.CheckForIssues.SpecialWaypointUsed=The map makes use of waypoint #{0}. In Tiberian Sun, this waypoint is reserved for special use cases (WAYPT_SPECIAL). Using it as a normal waypoint may cause issues as it may be dynamically moved by game events.
 Map.CheckForAITriggerTeamWithMaxZeroIssue.TeamTypeMax=Team '{0}', linked to AITrigger '{1}', has Max=0. This prevents the AI from building the team.

src/TSMapEditor/Constants.cs

@@ -123,6 +123,8 @@ public static class Constants
 
         public const int TS_WAYPT_SPECIAL = 100;
 
+        public const string DefaultHouseTypeName = "Neutral";
+
         public static void Init()
         {
             const string ConstantsSectionName = "Constants";

src/TSMapEditor/Initialization/MapLoader.cs

@@ -864,8 +864,20 @@ public static void ReadTriggers(IMap map, IniFile mapIni)
                     continue;
 
                 var trigger = Trigger.ParseTrigger(kvp.Key, kvp.Value);
-                if (trigger != null)
-                    map.AddTrigger(trigger);
+                if (trigger == null)
+                {
+                    AddMapLoadError(string.Format(Translate("MapLoader.ReadTriggers.FailedToLoadTrigger", "Failed to load trigger {0}! It most likely has a malformed INI format."), kvp.Key));
+                    continue;
+                }
+
+                map.AddTrigger(trigger);
+                trigger.HouseType = map.FindHouseType(trigger.LoadedHouseTypeName);
+                if (trigger.HouseType == null)
+                {
+                    trigger.HouseType = map.FindHouseType(Constants.DefaultHouseTypeName);
+                    AddMapLoadError(string.Format(Translate("MapLoader.ReadTriggers.InvalidHouseTypeForTrigger", "Trigger \"{0}\" had a non-existent HouseType \"{1}\" as its owner. It has been reset to \"{2}\"."),
+                        trigger.Name, trigger.LoadedHouseTypeName, trigger.HouseType?.ININame));
+                }
 
                 string actionData = mapIni.GetStringValue("Actions", trigger.ID, null);
                 trigger.ParseActions(actionData);

src/TSMapEditor/Misc/MapIssueChecker.cs

@@ -384,10 +384,12 @@ public static List<string> CheckForIssues(Map map)
             // Check for triggers having invalid owners
             foreach (var trigger in map.Triggers)
             {
-                if (!houseTypes.Exists(ht => trigger.HouseType == ht.ININame))
+                if (trigger.HouseType == null || map.FindHouseType(trigger.HouseType.ININame) == null)
+                {
                     issueList.Add(string.Format(Translate(map, "CheckForIssues.InvalidTriggerOwner",
-                        "Trigger '{0}' has a nonexistent HouseType '{1}' specified as its owner."),
-                            trigger.Name, trigger.HouseType));
+                        "Trigger '{0}' has a nonexistent HouseType as its owner."),
+                        trigger.Name));
+                }
             }
 
             // Check for triggers in SP that have Building Exists event but house belongs to an AI
@@ -397,7 +399,7 @@ public static List<string> CheckForIssues(Map map)
                 foreach (var trigger in map.Triggers)
                 {
                     // Get the house of the trigger
-                    var house = map.Houses.Find(house => house.ININame == trigger.HouseType);
+                    var house = map.Houses.Find(house => house.HouseType == trigger.HouseType);
 
                     if (house == null)
                         continue; // will be reported by the check for invalid owners

src/TSMapEditor/Models/Trigger.cs

@@ -23,7 +23,14 @@ public class Trigger : IIDContainer
         public void SetInternalID(string id) => ID = id;
 
         public string ID { get; private set; }
-        public string HouseType { get; set; }
+
+        public HouseType HouseType { get; set; }
+
+        /// <summary>
+        /// The name of the trigger's HouseType as loaded from the map.
+        /// Should not be used for anything after the map has been loaded.
+        /// </summary>
+        public string LoadedHouseTypeName { get; private set; }
 
         /// <summary>
         /// The linked trigger ID loaded from the map.
@@ -103,8 +110,9 @@ public void WriteToIniFile(IniFile iniFile, EditorConfig editorConfig)
         {
             // Write entry to [Triggers]
             string linkedTriggerId = LinkedTrigger == null ? Constants.NoneValue1 : LinkedTrigger.ID;
+            string owner = HouseType != null ? HouseType.ININame : Constants.NoneValue1;
             iniFile.SetStringValue("Triggers", ID,
-                $"{HouseType},{linkedTriggerId},{Name}," +
+                $"{owner},{linkedTriggerId},{Name}," +
                 $"{Helpers.BoolToIntString(Disabled)}," +
                 $"{Helpers.BoolToIntString(Easy)},{Helpers.BoolToIntString(Normal)},{Helpers.BoolToIntString(Hard)},0");
 
@@ -249,7 +257,7 @@ public static Trigger ParseTrigger(string id, string data)
 
             return new Trigger(id)
             {
-                HouseType = parts[0],
+                LoadedHouseTypeName = parts[0],
                 LinkedTriggerId = parts[1],
                 Name = parts[2],
                 Disabled = Conversions.BooleanFromString(parts[3], false),
@@ -261,7 +269,7 @@ public static Trigger ParseTrigger(string id, string data)
 
         public void Serialize(MemoryStream memoryStream)
         {
-            StreamHelpers.WriteUnicodeString(memoryStream, HouseType);
+            StreamHelpers.WriteUnicodeString(memoryStream, HouseType != null ? HouseType.ININame : Constants.NoneValue1);
             StreamHelpers.WriteUnicodeString(memoryStream, Name);
 
             StreamHelpers.WriteBool(memoryStream, Disabled);
@@ -286,7 +294,7 @@ public void Serialize(MemoryStream memoryStream)
 
         public void Deserialize(MemoryStream memoryStream)
         {
-            HouseType = StreamHelpers.ReadUnicodeString(memoryStream);
+            LoadedHouseTypeName = StreamHelpers.ReadUnicodeString(memoryStream);
             Name = StreamHelpers.ReadUnicodeString(memoryStream);                        
 
             Disabled = StreamHelpers.ReadBool(memoryStream);
@@ -340,6 +348,7 @@ public static (Trigger, Tag) GetTriggerAndTagFromClipboard(Map map)
 
             var trigger = new Trigger(map.GetNewUniqueInternalId());
             trigger.Deserialize(memoryStream);
+            trigger.HouseType = map.FindHouseType(trigger.LoadedHouseTypeName);
 
             var tag = new Tag();
             tag.ID = map.GetNewUniqueInternalId();

src/TSMapEditor/UI/Windows/CreateRandomTriggerSetWindow.cs

@@ -154,7 +154,7 @@ private Trigger CreateBaseTrigger(string name, int elapsedTime, string color, in
 
             var baseTrigger = new Trigger(map.GetNewUniqueInternalId());
             baseTrigger.Name = triggerName;
-            baseTrigger.HouseType = "Neutral";
+            baseTrigger.HouseType = map.FindHouseType(Constants.DefaultHouseTypeName);
 
             if (!string.IsNullOrWhiteSpace(color))
             {
@@ -203,7 +203,7 @@ private List<Trigger> CreateChildTriggers(string name, int count, int delay, str
             {
                 var childTrigger = new Trigger(map.GetNewUniqueInternalId());
                 childTrigger.Name = $"{name} {i + 1}";
-                childTrigger.HouseType = "Neutral";
+                childTrigger.HouseType = map.FindHouseType(Constants.DefaultHouseTypeName);
                 childTrigger.Disabled = true;
 
                 if (!string.IsNullOrWhiteSpace(color))

src/TSMapEditor/UI/Windows/TriggersWindow.cs

@@ -1768,7 +1768,7 @@ private void BtnNewTrigger_LeftClick(object sender, EventArgs e)
         {
             map.TriggersChanged -= Map_TriggersChanged;
 
-            var newTrigger = new Trigger(map.GetNewUniqueInternalId()) { Name = "New trigger", HouseType = "Neutral" };
+            var newTrigger = new Trigger(map.GetNewUniqueInternalId()) { Name = "New trigger", HouseType = map.FindHouseType(Constants.DefaultHouseTypeName) };
             map.AddTrigger(newTrigger);
             map.AddTag(new Tag() { ID = map.GetNewUniqueInternalId(), Name = "New tag", Trigger = newTrigger });
             ListTriggers();
@@ -2232,7 +2232,7 @@ public void Open()
         private void RefreshHouses()
         {
             ddHouseType.Items.Clear();
-            map.GetHouseTypes().ForEach(ht => ddHouseType.AddItem(ht.ININame, Helpers.GetHouseTypeUITextColor(ht)));
+            map.GetHouseTypes().ForEach(ht => ddHouseType.AddItem(new XNADropDownItem() { Text = ht.ININame, TextColor = Helpers.GetHouseTypeUITextColor(ht), Tag = ht }));
         }
 
         private void ListTriggers()
@@ -2339,7 +2339,7 @@ private void EditTrigger(Trigger trigger)
             }
 
             tbName.Text = editedTrigger.Name;
-            ddHouseType.SelectedIndex = map.GetHouseTypes().FindIndex(h => h.ININame == trigger.HouseType);
+            ddHouseType.SelectedIndex = map.GetHouseTypes().FindIndex(h => h == trigger.HouseType);
             ddType.SelectedIndex = tag == null ? 3 : tag.Repeating;
             selAttachedTrigger.Text = editedTrigger.LinkedTrigger == null ? Constants.NoneValue1 : editedTrigger.LinkedTrigger.Name;
             selAttachedTrigger.Tag = editedTrigger.LinkedTrigger;
@@ -2419,7 +2419,7 @@ private void DdType_SelectedIndexChanged(object sender, EventArgs e)
 
         private void DdHouse_SelectedIndexChanged(object sender, EventArgs e)
         {
-            editedTrigger.HouseType = ddHouseType.SelectedItem.Text;
+            editedTrigger.HouseType = (HouseType)ddHouseType.SelectedItem.Tag;
         }
 
         private void ChkDisabled_CheckedChanged(object sender, EventArgs e)