save options in xml format

TLM/TLM/Custom/PathFinding/PathfinderUpdates.cs

@@ -17,6 +17,7 @@ public static class PathfinderUpdates {
         // Edition History:
         // 0 - An old save, unknown pathfinder edition
         // 1 - #1338 Aircraft pathfinding fix
+        // TODO: This feature is not used and does not persist. if we increment this we need to also serialize this.
 
         /// <summary>
         /// Update this each time a despawn-requiring change is
@@ -27,6 +28,8 @@ public static class PathfinderUpdates {
         [SuppressMessage("Usage", "RAS0002:Readonly field for a non-readonly struct", Justification = "Not performance critical.")]
         internal static readonly byte LatestPathfinderEdition = 1;
 
+        public static byte SavegamePathfinderEdition = LatestPathfinderEdition;
+
         /// <summary>
         /// Checks savegame pathfinder edition and, if necessary, despawns
         /// any vehicles that might have invalid paths due to bugs in the
@@ -38,13 +41,13 @@ public static class PathfinderUpdates {
         public static ExtVehicleType DespawnVehiclesIfNecessary() {
             var filter = ExtVehicleType.None;
 
-            if (SavedGameOptions.Instance.SavegamePathfinderEdition == LatestPathfinderEdition) {
+            if (SavegamePathfinderEdition == LatestPathfinderEdition) {
                 return filter; // nothing to do, everything is fine
             }
 
-            Log.Info($"Pathfinder update from {SavedGameOptions.Instance.SavegamePathfinderEdition} to {LatestPathfinderEdition}.");
+            Log.Info($"Pathfinder update from {SavegamePathfinderEdition} to {LatestPathfinderEdition}.");
 
-            if (SavedGameOptions.Instance.SavegamePathfinderEdition < 1) {
+            if (SavegamePathfinderEdition < 1) {
                 filter |= ExtVehicleType.Plane; // #1338
             }
 
@@ -60,7 +63,7 @@ public static ExtVehicleType DespawnVehiclesIfNecessary() {
             }
 
             // this will be stored in savegame
-            SavedGameOptions.Instance.SavegamePathfinderEdition = LatestPathfinderEdition;
+            SavegamePathfinderEdition = LatestPathfinderEdition;
 
             return filter;
         }

TLM/TLM/Lifecycle/SerializableDataExtension.cs

@@ -11,7 +11,8 @@ namespace TrafficManager.Lifecycle {
     using TrafficManager.Manager.Impl;
     using TrafficManager.Manager.Impl.LaneConnection;
     using TrafficManager.State;
-    using Util;
+    using TrafficManager.Util;
+    using TrafficManager.Custom.PathFinding;
 
     [UsedImplicitly]
     public class SerializableDataExtension
@@ -21,6 +22,9 @@ public class SerializableDataExtension
 
         private const string DATA_ID = "TrafficManager_v1.0";
         private const string VERSION_INFO_DATA_ID = "TrafficManager_VersionInfo_v1.0";
+        private const string OPTIONS_ID = "TMPE_OptionsXML";
+        private const string OPTIONS_LEGACY_ID = "TMPE_Options";
+
 
         private static ISerializableData SerializableData => SimulationManager.instance.m_SerializableDataWrapper;
         private static Configuration _configuration;
@@ -79,16 +83,21 @@ public static void Load() {
                 if (TMPELifecycle.InGameOrEditor()) {
                     // Always force default options on new game
                     // See: https://github.com/CitiesSkylinesMods/TMPE/pull/1425
-                    byte[] options = TMPELifecycle.IsNewGame
-                        ? null
-                        : SerializableData.LoadData("TMPE_Options");
-
-                    if (!OptionsManager.Instance.LoadData(options ?? new byte[0])) {
-                        loadingSucceeded = false;
+                    if (!TMPELifecycle.IsNewGame) {
+                        if (Version <= 3) {
+                            byte[] data = SerializableData.LoadData(OPTIONS_ID);
+                            if (data != null) {
+                                loadingSucceeded &= OptionsManager.Instance.LoadData(data);
+                            }
+                        } else {
+                            byte[] data = SerializableData.LoadData(OPTIONS_LEGACY_ID);
+                            if (data != null) {
+                                loadingSucceeded &= OptionsManager.Instance.LoadDataLegacy(data);
+                            }
+                        }
                     }
                 }
-            }
-            catch (Exception e) {
+            } catch (Exception e) {
                 Log.Error($"OnLoadData: Error while loading options: {e}");
                 loadingSucceeded = false;
             }
@@ -450,7 +459,10 @@ public static void Save() {
 
                 try {
                     if (TMPELifecycle.PlayMode) {
-                        SerializableData.SaveData("TMPE_Options", OptionsManager.Instance.SaveData(ref success));
+                        SerializableData.SaveData(OPTIONS_ID, OptionsManager.Instance.SaveData(ref success));
+
+                        // forward compatibility. only needed for a short time:
+                        SerializableData.SaveData(OPTIONS_LEGACY_ID, OptionsManager.Instance.SaveDataLegacy(ref success)); 
                     }
                 } catch (Exception ex) {
                     Log.Error("Unexpected error while saving options: " + ex.Message);

TLM/TLM/Lifecycle/TMPELifecycle.cs

@@ -299,6 +299,8 @@ internal void Load() {
 
                 IsGameLoaded = true;
 
+                SerializableUIOptionBase.UpdateAll();
+
                 ModUI.OnLevelLoaded();
                 if (PlayMode) {
                     Log._Debug("PlayMode");