Add options API

TLM/TLM/Lifecycle/TMPELifecycle.cs

@@ -305,6 +305,8 @@ internal void Load() {
 
         internal void Unload() {
             try {
+                Options.Available = false;
+
                 GeometryNotifierDisposable?.Dispose();
                 GeometryNotifierDisposable = null;
 

TLM/TLM/Manager/Impl/OptionsManager.cs

@@ -8,6 +8,7 @@ namespace TrafficManager.Manager.Impl {
     using TrafficManager.Lifecycle;
     using JetBrains.Annotations;
     using TrafficManager.Util;
+    using System.Reflection;
 
     public class OptionsManager
         : AbstractCustomManager,
@@ -29,6 +30,31 @@ private static SimulationAccuracy ConvertToSimulationAccuracy(byte value) {
             return SimulationAccuracy.MaxValue - value;
         }
 
+        /// <summary>
+        /// API method for external mods to get option values by name.
+        /// </summary>
+        /// <typeparam name="TVal">Option type, eg. <c>bool</c>.</typeparam>
+        /// <param name="optionName">Name of the option in <see cref="Options"/>.</param>
+        /// <param name="value">The option value, if found, otherwise <c>default</c> for <typeparamref name="TVal"/>.</param>
+        /// <returns>Returns <c>true</c> if successful, or <c>false</c> if there was a problem (eg. option not found, wrong TVal, etc).</returns>
+        /// <remarks>Check <see cref="OptionsAreSafeToQuery"/> first before trying to get an option value.</remarks>
+        public bool TryGetOptionByName<TVal>(string optionName, out TVal value) {
+            if (!Options.Available) {
+                value = default;
+                return false;
+            }
+
+            var field = typeof(Options).GetField(optionName, BindingFlags.Static | BindingFlags.Public);
+
+            if (field == null || field.FieldType is not TVal) {
+                value = default;
+                return false;
+            }
+
+            value = (TVal)field.GetValue(null);
+            return true;
+        }
+
         /// <summary>
         /// Converts SimulationAccuracy to SimulationAccuracy
         /// </summary>
@@ -74,6 +100,8 @@ private static void ToCheckbox([NotNull] byte[] data, uint idx, ILegacySerializa
 
         public bool LoadData(byte[] data) {
             try {
+                Options.Available = false;
+
                 Log.Info($"OptionsManager.LoadData: {data.Length} bytes");
 
                 GeneralTab.SetSimulationAccuracy(ConvertToSimulationAccuracy(LoadByte(data, idx: 0)));
@@ -154,10 +182,16 @@ public bool LoadData(byte[] data) {
 
                 ToCheckbox(data, idx: 59, OverlaysTab.ShowDefaultSpeedSubIcon, false);
 
+                Options.Available = true;
+
                 return true;
             }
             catch (Exception ex) {
                 ex.LogException();
+
+                // even though there was error, the options are now available for querying
+                Options.Available = true;
+
                 return false;
             }
         }

TLM/TLM/State/Options.cs

@@ -25,6 +25,7 @@ public class Options : MonoBehaviour {
         // private static UITextField pathCostMultiplicator2Field = null;
 #endif
 
+        // Likely to change or be removed in future
         [Flags]
         public enum PersistTo {
             None = 0,
@@ -33,6 +34,15 @@ public enum PersistTo {
             GlobalOrSavegame = Global | Savegame,
         }
 
+        /// <summary>
+        /// When <c>true</c>, options are safe to query.
+        /// </summary>
+        /// <remarks>
+        /// Is set <c>true</c> after options are loaded via <see cref="Manager.Impl.OptionsManager"/>.
+        /// Is set <c>false</c> while options are being saved, and also when level unloads.
+        /// </remarks>
+        public static bool Available = false;
+
         public static bool instantEffects = true;
         public static bool individualDrivingStyle = true;
         public static int recklessDrivers = 3;

TLM/TMPE.API/Manager/IOptionsManager.cs

@@ -1,4 +1,4 @@
-namespace TrafficManager.API.Manager {
+namespace TrafficManager.API.Manager {
     /// <summary>
     /// Manages mod options
     /// </summary>
@@ -8,5 +8,14 @@ public interface IOptionsManager : ICustomDataManager<byte[]> {
         /// </summary>
         /// <returns>true if changes may be published, false otherwise</returns>
         bool MayPublishSegmentChanges();
+
+        /// <summary>
+        /// Get current value of TMPE mod option from <see cref="Options"/>.
+        /// </summary>
+        /// <typeparam name="TVal">Option type, eg. <c>bool</c>.</typeparam>
+        /// <param name="optionName">Name of the option in <see cref="Options"/>.</param>
+        /// <param name="value">The option value, if found, otherwise <c>default</c> for <typeparamref name="TVal"/>.</param>
+        /// <returns>Returns <c>true</c> if successful, or <c>false</c> if there was a problem (eg. option not found, wrong TVal, etc).</returns>
+        bool TryGetOptionByName<TVal>(string optionName, out TVal value);
     }
 }