Added command to change stats font size.

Changed warning text colour.
Changed naming of stats created via the custom attribute.
Prettied up stats_list output.
Fixed exception thrown by using Mono on unsupported platform - now displays a notice in the console.

Author: DavidF-Dev

CHANGELOG.md

@@ -5,6 +5,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+- Added notice in developer console when C# evaluation is not supported.
+- Added command to change stats font size.
+- Changed warning text colour.
+- Changed stats_list output to be prettier.
+- Changed naming of stats created via the custom attribute.
+- Fixed exception thrown by using Mono on unsupported platforms.
 
 ## [1.0.2] - 2021-10-30
 - Added user-defined developer console stats which are displayed on-screen.

Runtime/DevConsoleMono.cs

@@ -42,7 +42,7 @@ internal sealed class DevConsoleMono : MonoBehaviour
         #region Static fields and constants
 
         private const string ErrorColour = "#E99497";
-        private const string WarningColour = "#B3E283";
+        private const string WarningColour = "#DEBF1F";
         private const string SuccessColour = "#B3E283";
         private const string ClearLogText = "Type <b>devconsole</b> for instructions on how to use the developer console.";
         private const int MaximumTextVertices = 64000;
@@ -56,6 +56,8 @@ internal sealed class DevConsoleMono : MonoBehaviour
         private const int MaxCachedEnumTypes = 6;
         private const float FpsUpdateRate = 4f;
         private const float StatUpdateRate = 0.1f;
+        private const int StatDefaultFontSize = 18;
+        private const string MonoNotSupportedText = "C# expression evaluation is not supported on this platform.";
 
         #region Input constants
 
@@ -107,6 +109,7 @@ internal sealed class DevConsoleMono : MonoBehaviour
         private const string PrefShowStats = "DevConsole.displayStats";
         private const string PrefStats = "DevConsole.stats";
         private const string PrefHiddenStats = "DevConsole.hiddenStats";
+        private const string PrefStatsFontSize = "DevConsole.statsFontSize";
 
         #endregion
 
@@ -377,7 +380,7 @@ internal sealed class DevConsoleMono : MonoBehaviour
         private readonly List<Type> _cacheEnumTypes = new List<Type>(MaxCachedEnumTypes);
 
         /// <summary>
-        ///     Evaluator used by "cs_evaluate" and "cs_run" to execuet C# expressions or statements.
+        ///     Evaluator used by "cs_evaluate" and "cs_run" to execute C# expressions or statements.
         /// </summary>
         private Evaluator _monoEvaluator = null;
 
@@ -409,6 +412,8 @@ internal sealed class DevConsoleMono : MonoBehaviour
         private HashSet<string> _hiddenStats = new HashSet<string>();
         private Dictionary<string, object> _cachedStats = new Dictionary<string, object>();
         private float _statUpdateTime;
+        private int _statFontSize = StatDefaultFontSize;
+        private int _oldStatFontSize = StatDefaultFontSize;
 
         #endregion
 
@@ -1175,6 +1180,11 @@ private void Awake()
             ClearConsole();
             CloseConsole();
 
+            if (_monoEvaluator == null)
+            {
+                LogWarning($"Some features may not be available: {MonoNotSupportedText}");
+            }
+
             _init = false;
         }
 
@@ -1406,17 +1416,19 @@ private void OnGUI()
                 GUI.contentColor = oldContentColour;
             }
 
-            if (_isDisplayingStats && _monoEvaluator != null && _stats.Any())
+            if (_isDisplayingStats && _stats.Any())
             {
-                if (_statStyle == null)
+                if (_statStyle == null || _statFontSize != _oldStatFontSize)
                 {
                     // Create the style
                     _statStyle = new GUIStyle(GUI.skin.box)
                     {
                         alignment = TextAnchor.MiddleCenter,
-                        fontSize = 18,
+                        fontSize = _statFontSize,
                         normal = { textColor = Color.white, background = Texture2D.whiteTexture }
                     };
+
+                    _oldStatFontSize = _statFontSize;
                 }
 
                 // Initialise
@@ -1468,7 +1480,7 @@ private void OnGUI()
 
                     // Set content
                     string content = $"{stat.Key}: {result ?? "NULL"}";
-                    GUI.contentColor = result == null ? Color.yellow : (result.Equals("ERROR") ? Color.red : Color.white);
+                    GUI.contentColor = result == null ? Color.yellow : ((result.Equals("ERROR") || result.Equals(MonoNotSupportedText)) ? Color.red : Color.white);
 
                     // Determine label size
                     Vector2 size = _statStyle.CalcSize(new GUIContent(content));
@@ -2318,14 +2330,20 @@ void logChildren(GameObject obj, int tabAmount)
                 Parameter.Create("expression", "The expression to evaluate"),
                 input =>
                 {
+                    if (_monoEvaluator == null)
+                    {
+                        DevConsole.LogError(MonoNotSupportedText);
+                        return;
+                    }
+
                     try
                     {
                         if (!input.EndsWith(";"))
                         {
                             input += ";";
                         }
 
-                        object result = _monoEvaluator?.Evaluate(input) ?? null;
+                        object result = _monoEvaluator.Evaluate(input);
 
                         if (result == null)
                         {
@@ -2355,14 +2373,20 @@ void logChildren(GameObject obj, int tabAmount)
                 Parameter.Create("statement", "The statement to execute"),
                 input =>
                 {
+                    if (_monoEvaluator == null)
+                    {
+                        DevConsole.LogError(MonoNotSupportedText);
+                        return;
+                    }
+
                     try
                     {
                         if (!input.EndsWith(";"))
                         {
                             input += ";";
                         }
 
-                        if (_monoEvaluator?.Run(input) ?? false)
+                        if (_monoEvaluator.Run(input))
                         {
                             LogSuccess("Successfully executed the C# expression or statement.");
                         }
@@ -2384,6 +2408,12 @@ void logChildren(GameObject obj, int tabAmount)
                 "Display a list of all active using statements",
                 () =>
                 {
+                    if (_monoEvaluator == null)
+                    {
+                        DevConsole.LogError(MonoNotSupportedText);
+                        return;
+                    }
+
                     string usings = _monoEvaluator.GetUsing();
 
                     if (string.IsNullOrEmpty(usings))
@@ -2404,6 +2434,12 @@ void logChildren(GameObject obj, int tabAmount)
                 "Display a list of all local variables defined",
                 () =>
                 {
+                    if (_monoEvaluator == null)
+                    {
+                        DevConsole.LogError(MonoNotSupportedText);
+                        return;
+                    }
+
                     string vars = _monoEvaluator.GetVars();
 
                     if (string.IsNullOrEmpty(vars))
@@ -2516,16 +2552,18 @@ void logChildren(GameObject obj, int tabAmount)
             AddCommand(Command.Create(
                 "stats_list",
                 "",
-                "Display a list of the stored developer console stats that can be displayed on-screen",
+                "Display a list of the tracked developer console stats that can be displayed on-screen",
                 () =>
                 {
                     if (!_stats.Any())
                     {
-                        DevConsole.Log($"There are no stored developer console stats. Use {GetCommand("stats_set").GetFormattedName()} to set one up.");
+                        DevConsole.Log($"There are no tracked developer console stats. Use {GetCommand("stats_set").GetFormattedName()} to set one up.");
                         return;
                     }
 
-                    LogCollection(_stats, x => $"{x.Key}: {x.Value} ({x.Value.Desc}){(_hiddenStats.Contains(x.Key) ? " [Disabled]" : "")}.");
+                    LogSeperator("Tracked developer console stats");
+                    LogCollection(_stats, x => $"<b>{x.Key}:</b> {x.Value} ({x.Value.Desc}){(_hiddenStats.Contains(x.Key) ? " <i>[Disabled]</i>" : "")}.");
+                    LogSeperator();
                 }
                 ));
 
@@ -2647,6 +2685,25 @@ void logChildren(GameObject obj, int tabAmount)
                 }
                 ));
 
+            AddCommand(Command.Create<int>(
+                "stats_fontsize",
+                "",
+                "Query or set the font size of the tracked developer console stats",
+                Parameter.Create("fontSize", $"Size of the font (default: {StatDefaultFontSize})"),
+                f =>
+                {
+                    if (f <= 0)
+                    {
+                        LogError("Font size must be non-zero and positive.");
+                        return;
+                    }
+
+                    _statFontSize = f;
+                    LogSuccess($"Set the stats font size to {_statFontSize} (was {_oldStatFontSize}).");
+                },
+                () => LogVariable("Stats font size", _statFontSize)
+                ));
+
             #endregion
 
             #region Misc commands
@@ -2866,7 +2923,7 @@ private void InitAttributes()
                                 continue;
                             }
 
-                            string name = $"var_{field.Name}";
+                            string name = attribute.Name ?? field.Name;
                             _stats[name] = new ReflectedStat(field);
                             if (!attribute.StartEnabled)
                             {
@@ -2882,7 +2939,7 @@ private void InitAttributes()
                                 continue;
                             }
 
-                            string name = $"var_{property.Name}";
+                            string name = attribute.Name ?? property.Name;
                             _stats[name] = new ReflectedStat(property);
                             if (!attribute.StartEnabled)
                             {
@@ -3443,6 +3500,7 @@ private void SavePreferences()
             DevConsoleData.SetObject(PrefShowStats, _isDisplayingStats);
             DevConsoleData.SetObject(PrefStats, _stats.Where(x => x.Value is EvaluatedStat).ToDictionary(x => x.Key, x => ((EvaluatedStat)x.Value).Expression));
             DevConsoleData.SetObject(PrefHiddenStats, new HashSet<string>(_hiddenStats.Where(x => _stats.Keys.Contains(x))));
+            DevConsoleData.SetObject(PrefStatsFontSize, _statFontSize);
 
             DevConsoleData.Save();
         }
@@ -3472,6 +3530,7 @@ private void LoadPreferences()
                 _stats.Add(stat.Key, new EvaluatedStat(stat.Value));
             }
             _hiddenStats = DevConsoleData.GetObject(PrefHiddenStats, new HashSet<string>());
+            _statFontSize = _oldStatFontSize = DevConsoleData.GetObject(PrefStatsFontSize, StatDefaultFontSize);
 
             DevConsoleData.Clear();
         }
@@ -3490,26 +3549,33 @@ private void InitMonoEvaluator()
                 return;
             }
 
-            CompilerSettings settings = new CompilerSettings();
-
-            // Add assembly references to the settings
-            foreach (Assembly assembly in AppDomain.CurrentDomain.GetAssemblies())
+            try
             {
-                if (assembly == null)
+                CompilerSettings settings = new CompilerSettings();
+
+                // Add assembly references to the settings
+                foreach (Assembly assembly in AppDomain.CurrentDomain.GetAssemblies())
                 {
-                    continue;
-                }
+                    if (assembly == null)
+                    {
+                        continue;
+                    }
 
-                settings.AssemblyReferences.Add(assembly.FullName);
-            }
+                    settings.AssemblyReferences.Add(assembly.FullName);
+                }
 
-            CompilerContext context = new CompilerContext(settings, new ConsoleReportPrinter());
-            _monoEvaluator = new Evaluator(context);
+                CompilerContext context = new CompilerContext(settings, new ConsoleReportPrinter());
+                _monoEvaluator = new Evaluator(context);
 
-            // Add the included using statements
-            foreach (string includedUsing in _includedUsings)
+                // Add the included using statements
+                foreach (string includedUsing in _includedUsings)
+                {
+                    _monoEvaluator.Run($"using {includedUsing};");
+                }
+            }
+            catch (Exception)
             {
-                _monoEvaluator.Run($"using {includedUsing};");
+                _monoEvaluator = null;
             }
         }
 
@@ -3627,6 +3693,11 @@ public EvaluatedStat(string expression)
 
             public override object GetResult(Evaluator evaluator)
             {
+                if (evaluator == null)
+                {
+                    return MonoNotSupportedText;
+                }
+
                 return evaluator?.Evaluate(Expression) ?? null;
             }
 

Runtime/DevConsoleTrackedStatAttribute.cs

@@ -23,10 +23,26 @@ public DevConsoleTrackedStatAttribute(bool startEnabled = true)
             StartEnabled = startEnabled;
         }
 
+        /// <summary>
+        ///     Track a field or property and have it displayed on-screen.
+        /// </summary>
+        /// <param name="name">Custom name to use for the tracked stat.</param>
+        /// <param name="startEnabled">Whether to have the stat displayed by default.</param>
+        public DevConsoleTrackedStatAttribute(string name, bool startEnabled = true)
+        {
+            Name = name;
+            StartEnabled = startEnabled;
+        }
+
         #endregion
 
         #region Properties
 
+        /// <summary>
+        ///     Custom name to use for the tracked stat, otherwise use the target name.
+        /// </summary>
+        public string Name { get; }
+
         /// <summary>
         ///     Whether the stat is displayed by default.
         /// </summary>