Make argument of new waypoint-parametered script actions default to first unused waypoint

Author: Rampastring

src/TSMapEditor/Models/Map.cs

@@ -1,6 +1,7 @@
 using Microsoft.Xna.Framework;
 using Microsoft.Xna.Framework.Graphics;
 using Rampastring.Tools;
+using Rampastring.XNAUI.XNAControls;
 using System;
 using System.Collections.Generic;
 using System.Globalization;
@@ -2124,6 +2125,134 @@ private void CheckForAITriggerTeamWithMaxZeroIssue(AITriggerType aiTrigger, Team
             }
         }
 
+        public bool IsLikelyMultiplayer()
+        {
+            if (Basic.MultiplayerOnly)
+                return true;
+
+            const int MaxUniqueHouses = 32;
+            const int FirstSpawnHouseIndex = 50;
+
+            if (Houses.Count > 0 && Houses.Count < MaxUniqueHouses)
+            {
+                // Most likely singleplayer - SP maps always have houses,
+                // while regular MP maps don't have houses
+                // and scripted TS MP maps need more than 50 houses
+                return false;
+            }
+
+            if (Houses.Count > FirstSpawnHouseIndex)
+            {
+                // Most likely a scripted multiplayer scenario
+                return true;
+            }
+
+            return false;
+        }
+
+        public bool IsWaypointInUse(Waypoint waypoint)
+        {
+            foreach (Trigger trigger in Triggers)
+            {
+                foreach (var action in trigger.Actions)
+                {
+                    var triggerActionType = EditorConfig.TriggerActionTypes.GetValueOrDefault(action.ActionIndex);
+
+                    if (triggerActionType == null)
+                        continue;
+
+                    for (int i = 0; i < triggerActionType.Parameters.Length; i++)
+                    {
+                        if (triggerActionType.Parameters[i] == null)
+                            continue;
+
+                        var param = triggerActionType.Parameters[i];
+
+                        if (param.TriggerParamType == TriggerParamType.Waypoint && action.Parameters[i] == waypoint.Identifier.ToString())
+                        {
+                            return true;
+                        }
+
+                        if (param.TriggerParamType == TriggerParamType.WaypointZZ && action.Parameters[i] == Helpers.WaypointNumberToAlphabeticalString(waypoint.Identifier))
+                        {
+                            return true;
+                        }
+                    }
+                }
+
+                foreach (var condition in trigger.Conditions)
+                {
+                    var triggerEventType = EditorConfig.TriggerEventTypes.GetValueOrDefault(condition.ConditionIndex);
+
+                    if (triggerEventType == null)
+                        continue;
+
+                    for (int i = 0; i < triggerEventType.Parameters.Length; i++)
+                    {
+                        if (triggerEventType.Parameters[i] == null)
+                            continue;
+
+                        var param = triggerEventType.Parameters[i];
+
+                        if (param.TriggerParamType == TriggerParamType.Waypoint && condition.Parameters[i] == waypoint.Identifier.ToString())
+                        {
+                            return true;
+                        }
+
+                        if (param.TriggerParamType == TriggerParamType.WaypointZZ && condition.Parameters[i] == Helpers.WaypointNumberToAlphabeticalString(waypoint.Identifier))
+                        {
+                            return true;
+                        }
+                    }
+                }
+            }
+
+            foreach (Script script in Scripts)
+            {
+                foreach (var actionEntry in script.Actions)
+                {
+                    var scriptAction = EditorConfig.ScriptActions.GetValueOrDefault(actionEntry.Action);
+
+                    if (scriptAction == null)
+                    {
+                        continue;
+                    }
+
+                    if (scriptAction.ParamType == TriggerParamType.Waypoint && actionEntry.Argument == waypoint.Identifier)
+                    {
+                        return true;
+                    }
+                }
+            }
+
+            foreach (TeamType team in TeamTypes)
+            {
+                if (team.Waypoint == Helpers.WaypointNumberToAlphabeticalString(waypoint.Identifier))
+                {
+                    return true;
+                }
+            }
+
+            return false;
+        }
+
+        public Waypoint GetFirstUnusedWaypoint()
+        {
+            int firstValidIdentifier = IsLikelyMultiplayer() ? 8 : 0;
+
+            for (int i = 0; i < Waypoints.Count; i++)
+            {
+                Waypoint wp = Waypoints[i];
+                if (wp.Identifier < firstValidIdentifier)
+                    continue;
+
+                if (!IsWaypointInUse(wp))
+                    return wp;
+            }
+
+            return null;
+        }
+
         public void Clear()
         {
             LoadedINI = null;

src/TSMapEditor/Settings/UserSettings.cs

@@ -46,6 +46,7 @@ public UserSettings()
                 Theme,
                 UseBoldFont,
                 SmartScriptActionCloning,
+                SmartScriptActionDefaultValues,
                 AutoSaveInterval,
                 SidebarWidth,
 
@@ -104,6 +105,7 @@ public async Task SaveSettingsAsync()
         public StringSetting Theme = new StringSetting(General, nameof(Theme), "Default");
         public BoolSetting UseBoldFont = new BoolSetting(General, nameof(UseBoldFont), false);
         public BoolSetting SmartScriptActionCloning = new BoolSetting(General, nameof(SmartScriptActionCloning), true);
+        public BoolSetting SmartScriptActionDefaultValues = new BoolSetting(General, nameof(SmartScriptActionDefaultValues), true);
         public IntSetting AutoSaveInterval = new IntSetting(General, nameof(AutoSaveInterval), 300);
         public IntSetting SidebarWidth = new IntSetting(General, nameof(SidebarWidth), 250);
 

src/TSMapEditor/UI/Windows/ScriptsWindow.cs

@@ -507,6 +507,27 @@ private void SelTypeOfAction_MouseLeftDown(object sender, EventArgs e)
             selectScriptActionWindow.Open(scriptAction);
         }
 
+        private ScriptActionEntry CreateNewScriptActionEntry(int actionId)
+        {
+            var entry = new ScriptActionEntry(actionId, 0);
+
+            if (UserSettings.Instance.SmartScriptActionDefaultValues)
+            {
+                var scriptActionType = map.EditorConfig.ScriptActions[actionId];
+
+                switch (scriptActionType.ParamType)
+                {
+                    case TriggerParamType.Waypoint:
+                        Waypoint wp = map.GetFirstUnusedWaypoint();
+                        if (wp != null)
+                            entry.Argument = wp.Identifier;
+                        break;
+                }
+            }
+
+            return entry;
+        }
+
         private void SelectScriptActionDarkeningPanel_Hidden(object sender, EventArgs e)
         {
             if (editedScript == null)
@@ -527,15 +548,15 @@ private void SelectScriptActionDarkeningPanel_Hidden(object sender, EventArgs e)
                     {
                         int viewTop = lbActions.ViewTop;
                         int index = lbActions.SelectedIndex;
-                        editedScript.Actions.Insert(index, new ScriptActionEntry(selectScriptActionWindow.SelectedObject.ID, 0));
+                        editedScript.Actions.Insert(index, CreateNewScriptActionEntry(selectScriptActionWindow.SelectedObject.ID));
                         EditScript(editedScript);
                         lbActions.SelectedIndex = index;
                         lbActions.ViewTop = viewTop;
                         insertIndex = -1;
                     }
                     else
                     {
-                        editedScript.Actions.Add(new ScriptActionEntry(selectScriptActionWindow.SelectedObject.ID, 0));
+                        editedScript.Actions.Add(CreateNewScriptActionEntry(selectScriptActionWindow.SelectedObject.ID));
                         EditScript(editedScript);
                         lbActions.SelectedIndex = lbActions.Items.Count - 1;
                         lbActions.ScrollToBottom();