Implement scripting API version 2, making it possible for scripts to show custom INItializableWindow UIs

Rampastring · Rampastring · commit 5e97c4d488c2 · 2025-06-06T18:08:22.000+03:00
diff --git a/src/TSMapEditor/Constants.cs b/src/TSMapEditor/Constants.cs
@@ -4,7 +4,7 @@ namespace TSMapEditor
 {
     public static class Constants
     {
-        public const string ReleaseVersion = "1.4.12";
+        public const string ReleaseVersion = "1.5.0";
 
         public static int CellSizeX = 48;
         public static int CellSizeY = 24;
diff --git a/src/TSMapEditor/Properties/AssemblyInfo.cs b/src/TSMapEditor/Properties/AssemblyInfo.cs
@@ -34,4 +34,4 @@
 // You can specify all the values or you can default the Build and Revision Numbers
 // by using the '*' as shown below:
 // [assembly: AssemblyVersion("1.0.*")]
-[assembly: AssemblyVersion("1.4.*")]
+[assembly: AssemblyVersion("1.5.*")]
diff --git a/src/TSMapEditor/Scripts/ScriptRunner.cs b/src/TSMapEditor/Scripts/ScriptRunner.cs
@@ -1,20 +1,64 @@
 ﻿using Rampastring.Tools;
+using Rampastring.XNAUI;
 using System;
 using System.IO;
 using System.Reflection;
 using TSMapEditor.Models;
+using TSMapEditor.Rendering;
+using TSMapEditor.UI;
+using TSMapEditor.UI.Windows;
 using Westwind.Scripting;
 
 namespace TSMapEditor.Scripts
 {
+    // Has to be a class, Westwind.Scripting does not appear to recognize this if it is a struct.
+    public class ScriptDependencies
+    {
+        public Map Map;
+        public ICursorActionTarget CursorActionTarget;
+        public EditorState EditorState;
+        public WindowManager WindowManager;
+        public WindowController WindowController;
+
+        public ScriptDependencies(Map map, ICursorActionTarget cursorActionTarget, EditorState editorState, WindowManager windowManager, WindowController windowController)
+        {
+            Map = map;
+            CursorActionTarget = cursorActionTarget;
+            EditorState = editorState;
+            WindowManager = windowManager;
+            WindowController = windowController;
+        }
+    }
+
     public static class ScriptRunner
     {
         private static object scriptClassInstance;
-        private static MethodInfo getDescriptionMethod;
+
+        private static MethodInfo getDescriptionMethod; // V1 only
         private static MethodInfo performMethod;
-        private static MethodInfo getSuccessMessageMethod;
+        private static MethodInfo getSuccessMessageMethod; // V1 only
+
+        public static int ActiveScriptAPIVersion;
+
+        public static string CompileScript(ScriptDependencies scriptDependencies, string scriptPath)
+        {
+            if (!File.Exists(scriptPath))
+                return "The script file does not exist!";
+
+            var sourceCode = File.ReadAllText(scriptPath);
+            string error = CompileSource(scriptDependencies, sourceCode);
+            if (error != null)
+                return error;
+
+            return null;
+        }
+
+        public static string GetDescriptionFromScriptV1()
+        {
+            return (string)getDescriptionMethod.Invoke(scriptClassInstance, null);
+        }
 
-        public static string RunScript(Map map, string scriptPath)
+        public static string RunScriptV1(Map map, string scriptPath)
         {
             if (scriptClassInstance == null || performMethod == null || getSuccessMessageMethod == null)
                 throw new InvalidOperationException("Script not properly compiled!");
@@ -26,7 +70,7 @@ public static string RunScript(Map map, string scriptPath)
                 performMethod.Invoke(scriptClassInstance, new object[] { map });
                 return (string)getSuccessMessageMethod.Invoke(scriptClassInstance, null);
             }
-            catch (Exception ex) // rare case where catching Exception is OK, we cannot know what the script can throw
+            catch (Exception ex) // catching Exception is OK, we cannot know what the script can throw
             {
                 string errorMessage = ex.Message;
 
@@ -44,27 +88,43 @@ public static string RunScript(Map map, string scriptPath)
             }
         }
 
-        public static (string error, string description) GetDescriptionFromScript(Map map, string scriptPath)
+        public static string RunScriptV2()
         {
-            if (!File.Exists(scriptPath))
-                return ("The script file does not exist!", null);
+            try
+            {
+                performMethod.Invoke(scriptClassInstance, null);
+            }
+            catch (Exception ex) // catching Exception is OK, we cannot know what the script can throw
+            {
+                string errorMessage = ex.Message;
 
-            var sourceCode = File.ReadAllText(scriptPath);
-            string error = CompileSource(map, sourceCode);
-            if (error != null)
-                return (error, null);
+                while (ex.InnerException != null)
+                {
+                    ex = ex.InnerException;
+                    errorMessage += Environment.NewLine + Environment.NewLine +
+                        "Inner exception message: " + ex.Message + Environment.NewLine +
+                        "Stack trace: " + ex.StackTrace;
+                }
+
+                Logger.Log("Exception while running script. Returned exception message: " + errorMessage);
 
-            return (null, (string)getDescriptionMethod.Invoke(scriptClassInstance, null));
+                return "An error occurred while running the script. Returned error message: " + Environment.NewLine + Environment.NewLine + errorMessage;
+            }
+
+            return null;
         }
 
-        private static string CompileSource(Map map, string source)
+        private static string CompileSource(ScriptDependencies scriptDependencies, string source)
         {
             var script = new CSharpScriptExecution() { SaveGeneratedCode = true };
             script.AddLoadedReferences();
             script.AddNamespace("TSMapEditor");
             script.AddNamespace("TSMapEditor.Models");
             script.AddNamespace("TSMapEditor.Rendering");
             script.AddNamespace("TSMapEditor.GameMath");
+            script.AddNamespace("TSMapEditor.Scripts");
+            script.AddNamespace("TSMapEditor.UI");
+            script.AddNamespace("TSMapEditor.UI.Controls");
 
             getDescriptionMethod = null;
             performMethod = null;
@@ -77,8 +137,80 @@ private static string CompileSource(Map map, string source)
                 return script.ErrorMessage;
             }
 
+            int version = 1;
+            Type classType = instance.GetType();
+            var properties = classType.GetProperties();
+            var apiVersionProperty = Array.Find(properties, prop => prop.Name == "ApiVersion");
+            if (apiVersionProperty != null)
+            {
+                if (apiVersionProperty.PropertyType != typeof(int))
+                {
+                    return "ApiVersion property is not an integer!";
+                }
+
+                version = (int)apiVersionProperty.GetValue(instance);
+            }
+
+            ActiveScriptAPIVersion = version;
+
+            if (version == 1)
+            {
+                return ExtractScriptV1(instance);
+            }
+            else if (version == 2)
+            {
+                return ExtractScriptV2(instance, scriptDependencies);
+            }
+
+            return $"Unsupported scripting API version: {version}. Contact the script's author for troubleshooting.";
+        }
+
+        private static string ExtractScriptV2(object instance, ScriptDependencies scriptDependencies)
+        {
+            scriptClassInstance = instance;
+            Type classType = instance.GetType();
+
+            var methods = classType.GetMethods();
+            foreach (MethodInfo method in methods)
+            {
+                if (method.Name == "Perform")
+                {
+                    performMethod = method;
+                    if (performMethod.GetParameters().Length > 0)
+                    {
+                        return "The Perform method has one or more parameters." + Environment.NewLine +
+                            "It should have no parameters in a V2 script." + Environment.NewLine +
+                            "To access map data, access ScriptDependencies.Map.";
+                    }
+                }
+            }
+
+            var properties = classType.GetProperties();
+            foreach (PropertyInfo property in properties)
+            {
+                var setter = property.GetSetMethod();
+                if (setter == null)
+                    continue;
+
+                if (property.Name == "ScriptDependencies")
+                {
+                    setter.Invoke(instance, [scriptDependencies]);
+                }
+            }
+
+            if (performMethod == null)
+            {
+                return "The script does not declare the Perform method.";
+            }
+
+            return null;
+        }
+
+        private static string ExtractScriptV1(object instance)
+        {
             scriptClassInstance = instance;
             Type classType = instance.GetType();
+
             var methods = classType.GetMethods();
             foreach (MethodInfo method in methods)
             {
diff --git a/src/TSMapEditor/UI/Controls/EditorWindow.cs b/src/TSMapEditor/UI/Controls/EditorWindow.cs
@@ -1,4 +1,5 @@
 ﻿using Microsoft.Xna.Framework;
+using Microsoft.Xna.Framework.Graphics;
 using Rampastring.Tools;
 using Rampastring.XNAUI;
 using Rampastring.XNAUI.XNAControls;
@@ -57,12 +58,6 @@ public override void Kill()
             base.Kill();
         }
 
-        private void CloseButton_LeftClick(object sender, EventArgs e)
-        {
-            Hide();
-            Closed?.Invoke(this, EventArgs.Empty);
-        }
-
         protected override void ParseControlINIAttribute(IniFile iniFile, string key, string value)
         {
             if (key == nameof(CanBeMoved))
@@ -118,7 +113,10 @@ public override void Update(GameTime gameTime)
             base.Update(gameTime);
 
             if (Alpha <= 0f && AlphaRate < 0.0f)
+            {
+                Closed?.Invoke(this, EventArgs.Empty);
                 Disable();
+            }
 
             if (IsDragged)
             {
diff --git a/src/TSMapEditor/UI/Controls/INItializableWindow.cs b/src/TSMapEditor/UI/Controls/INItializableWindow.cs
@@ -18,7 +18,7 @@ public INItializableWindow(WindowManager windowManager) : base(windowManager)
         {
         }
 
-        protected IniFile ConfigIni { get; private set; }
+        protected IniFile ConfigIni { get; set; }
 
         private bool _initialized = false;
 
@@ -58,15 +58,19 @@ public override void Initialize()
                 throw new InvalidOperationException("INItializableWindow cannot be initialized twice.");
 
             var dsc = Path.DirectorySeparatorChar;
-            string defaultConfigIniPath = Path.Combine(Environment.CurrentDirectory, "Config", "Default", "UI", SubDirectory, Name + ".ini");
-            string configIniPath = Path.Combine(Environment.CurrentDirectory, "Config", "UI", SubDirectory, Name + ".ini");
-
-            if (File.Exists(configIniPath))
-                ConfigIni = new IniFile(configIniPath);
-            else if (File.Exists(defaultConfigIniPath))
-                ConfigIni = new IniFile(defaultConfigIniPath);
-            else
-                throw new FileNotFoundException("Config INI not found: " + configIniPath);
+
+            if (ConfigIni == null)
+            {
+                string defaultConfigIniPath = Path.Combine(Environment.CurrentDirectory, "Config", "Default", "UI", SubDirectory, Name + ".ini");
+                string configIniPath = Path.Combine(Environment.CurrentDirectory, "Config", "UI", SubDirectory, Name + ".ini");
+
+                if (File.Exists(configIniPath))
+                    ConfigIni = new IniFile(configIniPath);
+                else if (File.Exists(defaultConfigIniPath))
+                    ConfigIni = new IniFile(defaultConfigIniPath);
+                else
+                    throw new FileNotFoundException("Config INI not found: " + configIniPath);
+            }
 
             Parser.Instance.SetPrimaryControl(this);
             ReadINIForControl(this);
diff --git a/src/TSMapEditor/UI/Windows/RunScriptWindow.cs b/src/TSMapEditor/UI/Windows/RunScriptWindow.cs
@@ -3,22 +3,21 @@
 using Rampastring.XNAUI.XNAControls;
 using System;
 using System.IO;
-using TSMapEditor.Models;
 using TSMapEditor.Scripts;
 using TSMapEditor.UI.Controls;
 
 namespace TSMapEditor.UI.Windows
 {
     public class RunScriptWindow : INItializableWindow
     {
-        public RunScriptWindow(WindowManager windowManager, Map map) : base(windowManager)
+        public RunScriptWindow(WindowManager windowManager, ScriptDependencies scriptDependencies) : base(windowManager)
         {
-            this.map = map;
+            this.scriptDependencies = scriptDependencies;
         }
 
         public event EventHandler ScriptRun;
 
-        private readonly Map map;
+        private readonly ScriptDependencies scriptDependencies;
 
         private EditorListBox lbScriptFiles;
 
@@ -34,6 +33,14 @@ public override void Initialize()
         }
 
         private void BtnRunScript_LeftClick(object sender, EventArgs e)
+        {
+            // Run script on next game loop frame so that in case the script displays
+            // UI, the UI will be shown on top of our window despite that the user
+            // clicked on our window this frame
+            AddCallback(RunScript_Callback);
+        }
+
+        private void RunScript_Callback()
         {
             if (lbScriptFiles.SelectedItem == null)
                 return;
@@ -49,36 +56,48 @@ private void BtnRunScript_LeftClick(object sender, EventArgs e)
 
             scriptPath = filePath;
 
-            (string error, string confirmation) = ScriptRunner.GetDescriptionFromScript(map, filePath);
+            string error = ScriptRunner.CompileScript(scriptDependencies, filePath);
 
             if (error != null)
             {
-                Logger.Log("Compilation error when attempting to run fetch script description: " + error);
+                Logger.Log("Compilation error when attempting to run script: " + error);
                 EditorMessageBox.Show(WindowManager, "Error",
                     "Compiling the script failed! Check its syntax, or contact its author for support." + Environment.NewLine + Environment.NewLine +
                     "Returned error was: " + error, MessageBoxButtons.OK);
                 return;
             }
 
-            if (confirmation == null)
+            if (ScriptRunner.ActiveScriptAPIVersion == 1)
             {
-                EditorMessageBox.Show(WindowManager, "Error", "The script provides no description!", MessageBoxButtons.OK);
-                return;
-            }
+                string confirmation = ScriptRunner.GetDescriptionFromScriptV1();
+
+                confirmation = Renderer.FixText(confirmation, Constants.UIDefaultFont, Width).Text;
 
-            confirmation = Renderer.FixText(confirmation, Constants.UIDefaultFont, Width).Text;
+                var messageBox = EditorMessageBox.Show(WindowManager, "Are you sure?",
+                    confirmation, MessageBoxButtons.YesNo);
+                messageBox.YesClickedAction = (_) => ApplyCode();
 
-            var messageBox = EditorMessageBox.Show(WindowManager, "Are you sure?",
-                confirmation, MessageBoxButtons.YesNo);
-            messageBox.YesClickedAction = (_) => ApplyCode();
+            }
+            else if (ScriptRunner.ActiveScriptAPIVersion == 2)
+            {
+                error = ScriptRunner.RunScriptV2();
+
+                if (error != null)
+                    EditorMessageBox.Show(WindowManager, "Error running script", error, MessageBoxButtons.OK);
+            }
+            else
+            {
+                EditorMessageBox.Show(WindowManager, "Unsupported Scripting API Version",
+                    "Script uses an unsupported scripting API version: " + ScriptRunner.ActiveScriptAPIVersion, MessageBoxButtons.OK);
+            }
         }
 
         private void ApplyCode()
         {
             if (scriptPath == null)
                 throw new InvalidOperationException("Pending script path is null!");
 
-            string result = ScriptRunner.RunScript(map, scriptPath);
+            string result = ScriptRunner.RunScriptV1(scriptDependencies.Map, scriptPath);
             result = Renderer.FixText(result, Constants.UIDefaultFont, Width).Text;
 
             EditorMessageBox.Show(WindowManager, "Result", result, MessageBoxButtons.OK);
diff --git a/src/TSMapEditor/UI/Windows/WindowController.cs b/src/TSMapEditor/UI/Windows/WindowController.cs

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@ namespace TSMapEditor`
`4`	`4`	`{`
`5`	`5`	`public static class Constants`
`6`	`6`	`{`
`7`		`- public const string ReleaseVersion = "1.4.12";`
	`7`	`+ public const string ReleaseVersion = "1.5.0";`
`8`	`8`
`9`	`9`	`public static int CellSizeX = 48;`
`10`	`10`	`public static int CellSizeY = 24;`