Merge remote-tracking branch 'upstream/master'

Author: JoyfulShush

docs/images/mapeditor.jpg

@@ -2,6 +2,7 @@
 using System;
 using System.Collections.Generic;
 using System.IO;
+using TSMapEditor.Settings;
 
 namespace TSMapEditor.CCEngine
 {
@@ -143,7 +144,8 @@ private void AddMix(MixFile mixFile)
         {
             mixFiles.Add(mixFile);
 
-            // Logger.Log("Registering " + mixFile.GetEntries().Count + " file entries from " + Path.GetFileName(mixFile.FilePath));
+            if (UserSettings.Instance.LogFileLoading)
+                Logger.Log("Registering " + mixFile.GetEntries().Count + " file entries from " + Path.GetFileName(mixFile.FilePath));
 
             foreach (MixFileEntry fileEntry in mixFile.GetEntries())
             {
@@ -243,14 +245,17 @@ public string FindFileFromDirectories(string fileName)
 
         public byte[] LoadFile(string name)
         {
-            // Logger.Log("Loading file " + name);
+            if (UserSettings.Instance.LogFileLoading)
+                Logger.Log("Loading file " + name);
 
             foreach (string searchDirectory in searchDirectories)
             {
                 string looseFilePath = Path.Combine(searchDirectory, name);
                 if (File.Exists(looseFilePath))
                 {
-                    // Logger.Log("    File found from " + searchDirectory);
+                    if (UserSettings.Instance.LogFileLoading)
+                        Logger.Log("    File found from " + searchDirectory);
+
                     return File.ReadAllBytes(looseFilePath);
                 }
             }
@@ -259,11 +264,15 @@ public byte[] LoadFile(string name)
 
             if (fileLocationInfos.TryGetValue(id, out FileLocationInfo value))
             {
-                // Logger.Log("    File found from " + Path.GetFileName(value.MixFile.FilePath));
+                if (UserSettings.Instance.LogFileLoading)
+                    Logger.Log("    File found from " + Path.GetFileName(value.MixFile.FilePath));
+
                 return value.MixFile.GetSingleFileData(value.Offset, value.Size);
             }
 
-            // Logger.Log("    FAILED to find file: " + name);
+            if (UserSettings.Instance.LogFileLoading)
+                Logger.Log("    FAILED to find file: " + name);
+
             return null;
         }
 

src/TSMapEditor/CCEngine/CCFileManager.cs

@@ -18,13 +18,14 @@ ParamType=Quarry
 Option0=0,N/A (Cancel)
 Option1=1,Anything
 Option2=2,Structures
-Option3=3,Harvesters
+Option3=3,Tiberium Processing Objects
 Option4=4,Infantry
 Option5=5,Vehicles
 Option6=6,Factories
 Option7=7,Base Defenses
 Option8=8,Base Threats
 Option9=9,Power Plants
+Option10=10,Harvesters (Vinifera)
 
 [AttackWaypoint]
 Name=Attack Waypoint

src/TSMapEditor/Config/Default/ScriptActions.ini

@@ -0,0 +1,25 @@
+; C&C World-Altering Editor (WAE)
+; https://github.com/CnCNet/WorldAlteringEditor
+
+; Default settings file.
+; This file is loaded as a base settings INI when Settings.ini does not exist in the editor's folder.
+
+; It is a good place for giving defaults to special settings that are not available in the user-interface.
+; That way, users checking out the settings INI can see these hidden options.
+
+
+[Display]
+ConserveVRAM=no                 ; If set, the editor skips loading rarely-used frames of certain graphics
+
+[General]
+SidebarWidth=250                ; Width of the editor's sidebar.
+AutoSaveInterval=300            ; Seconds between saving a copy of the currently open map to the editor's directory.
+MultithreadedTextureLoading=yes ; Set to "no" to disable multi-threaded loading of textures. Can be useful for debugging asset loading issues.
+
+LogFileLoading=no               ; If enabled, the editor will log all discovered and loaded files to the logfile.
+                                ; Can be useful to track which MIX files the editor loads different files from.
+                                ; Note: will result in big log files when enabled.
+
+[MapView]
+MapWideOverlayOpacity=50        ; Opacity level of the map-wide overlay. Must be between 0 (completely transparent) and 255 (completely opaque)
+

src/TSMapEditor/Config/DefaultSettings.ini

@@ -1457,13 +1457,14 @@ ScriptAction.Attack Quarry.Description=Attack the target type (quarry) and repea
 ScriptAction.Attack Quarry.Option0.PresetText=N/A (Cancel)
 ScriptAction.Attack Quarry.Option1.PresetText=Anything
 ScriptAction.Attack Quarry.Option2.PresetText=Structures
-ScriptAction.Attack Quarry.Option3.PresetText=Harvesters
+ScriptAction.Attack Quarry.Option3.PresetText=Tiberium Processing Objects
 ScriptAction.Attack Quarry.Option4.PresetText=Infantry
 ScriptAction.Attack Quarry.Option5.PresetText=Vehicles
 ScriptAction.Attack Quarry.Option6.PresetText=Factories
 ScriptAction.Attack Quarry.Option7.PresetText=Base Defenses
 ScriptAction.Attack Quarry.Option8.PresetText=Base Threats
 ScriptAction.Attack Quarry.Option9.PresetText=Power Plants
+ScriptAction.Attack Quarry.Option10.PresetText=Harvesters (Vinifera)
 ScriptAction.Attack Waypoint.Name=Attack Waypoint
 ScriptAction.Attack Waypoint.Description=Attack the object if present or the cell at the given waypoint. Action will change accordingly if a structure is present and the team member has attributes of Infiltrate or Engineer or  Agent or C4.
 ScriptAction.Go Berzerk.Name=Go Berzerk

src/TSMapEditor/Config/Translations/en/Translation_en.ini

@@ -1,5 +1,6 @@
 using Rampastring.Tools;
 using System;
+using System.IO;
 using System.Threading.Tasks;
 
 namespace TSMapEditor.Settings
@@ -17,7 +18,16 @@ public UserSettings()
 
             Instance = this;
 
-            UserSettingsIni = new IniFile(Environment.CurrentDirectory + "/MapEditorSettings.ini");
+            string path = Path.Combine(Environment.CurrentDirectory, "MapEditorSettings.ini");
+            if (File.Exists(path))
+            {
+                UserSettingsIni = new IniFile(path);
+            }
+            else
+            {
+                UserSettingsIni = new IniFile(Path.Combine(Environment.CurrentDirectory, "Config", "DefaultSettings.ini"));
+                UserSettingsIni.FileName = path;
+            }
 
             settings = new IINILoadable[]
             {
@@ -40,6 +50,7 @@ public UserSettings()
                 SidebarWidth,
 
                 MultithreadedTextureLoading,
+                LogFileLoading,
 
                 GameDirectory,
                 LastScenarioPath,
@@ -78,30 +89,31 @@ public async Task SaveSettingsAsync()
 
         private readonly IINILoadable[] settings;
 
-        public IntSetting TargetFPS = new IntSetting(Display, "TargetFPS", 240);
+        public IntSetting TargetFPS = new IntSetting(Display, nameof(TargetFPS), 240);
         public IntSetting GraphicsLevel = new IntSetting(Display, nameof(GraphicsLevel), 1);
-        public IntSetting ResolutionWidth = new IntSetting(Display, "ResolutionWidth", -1);
-        public IntSetting ResolutionHeight = new IntSetting(Display, "ResolutionHeight", -1);
-        public DoubleSetting RenderScale = new DoubleSetting(Display, "RenderScale", 1.0);
-        public BoolSetting Borderless = new BoolSetting(Display, "Borderless", false);
-        public BoolSetting FullscreenWindowed = new BoolSetting(Display, "FullscreenWindowed", false);
-        public BoolSetting ConserveVRAM = new BoolSetting(Display, "ConserveVRAM", false);
+        public IntSetting ResolutionWidth = new IntSetting(Display, nameof(ResolutionWidth), -1);
+        public IntSetting ResolutionHeight = new IntSetting(Display, nameof(ResolutionHeight), -1);
+        public DoubleSetting RenderScale = new DoubleSetting(Display, nameof(RenderScale), 1.0);
+        public BoolSetting Borderless = new BoolSetting(Display, nameof(Borderless), false);
+        public BoolSetting FullscreenWindowed = new BoolSetting(Display, nameof(FullscreenWindowed), false);
+        public BoolSetting ConserveVRAM = new BoolSetting(Display, nameof(ConserveVRAM), false);
 
         public IntSetting ScrollRate = new IntSetting(MapView, nameof(ScrollRate), 15);
-        public IntSetting MapWideOverlayOpacity = new IntSetting(MapView, "MapWideOverlayOpacity", 50);
+        public IntSetting MapWideOverlayOpacity = new IntSetting(MapView, nameof(MapWideOverlayOpacity), 50);
 
-        public StringSetting Theme = new StringSetting(General, "Theme", "Default");
-        public BoolSetting UseBoldFont = new BoolSetting(General, "UseBoldFont", false);
-        public BoolSetting SmartScriptActionCloning = new BoolSetting(General, "SmartScriptActionCloning", true);
-        public IntSetting AutoSaveInterval = new IntSetting(General, "AutoSaveInterval", 300);
-        public IntSetting SidebarWidth = new IntSetting(General, "SidebarWidth", 350);
+        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 IntSetting AutoSaveInterval = new IntSetting(General, nameof(AutoSaveInterval), 300);
+        public IntSetting SidebarWidth = new IntSetting(General, nameof(SidebarWidth), 350);
 
-        public BoolSetting MultithreadedTextureLoading = new BoolSetting(General, "MultithreadedTextureLoading", true);
+        public BoolSetting MultithreadedTextureLoading = new BoolSetting(General, nameof(MultithreadedTextureLoading), true);
+        public BoolSetting LogFileLoading = new BoolSetting(General, nameof(LogFileLoading), false);
 
-        public StringSetting GameDirectory = new StringSetting(General, "GameDirectory", string.Empty);
+        public StringSetting GameDirectory = new StringSetting(General, nameof(GameDirectory), string.Empty);
         public StringSetting LastScenarioPath = new StringSetting(General, nameof(LastScenarioPath), "Maps/Custom/");
 
-        public StringSetting TextEditorPath = new StringSetting(General, "TextEditorPath", string.Empty);
+        public StringSetting TextEditorPath = new StringSetting(General, nameof(TextEditorPath), string.Empty);
 
         public StringSetting Language = new StringSetting(General, nameof(Language), string.Empty);
 

src/TSMapEditor/Settings/UserSettings.cs

@@ -38,6 +38,9 @@
     <Compile Remove="Config\Scripts\Replace Frost With Clear.cs" />
   </ItemGroup>
   <ItemGroup>
+    <None Update="Config\DefaultSettings.ini">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
     <None Update="Config\Default\Actions.ini">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>
@@ -511,7 +514,7 @@
     <PackageReference Include="MonoGame.Framework.WindowsDX" Version="3.8.3" />
     <PackageReference Include="Rampastring.Tools" Version="2.0.7" />
     <PackageReference Include="MonoGame.Content.Builder.Task" Version="3.8.3" />
-    <PackageReference Include="Rampastring.XNAUI.WindowsDX" Version="3.1.0" />
+    <PackageReference Include="Rampastring.XNAUI.WindowsDX" Version="3.1.6" />
     <PackageReference Include="SixLabors.ImageSharp" Version="2.1.11" />
     <PackageReference Include="Westwind.Scripting" Version="1.3.3" />
   </ItemGroup>

src/TSMapEditor/TSMapEditor.csproj

@@ -42,7 +42,11 @@ protected set
 
     public bool CompositionEmpty => string.IsNullOrEmpty(_composition);
 
+    /// <summary>
+    /// Indicates whether an IME event has been received ever. Used to distinguish IME users from non-IME users.
+    /// </summary>
     protected bool IMEEventReceived = false;
+
     protected bool LastActionIMEChatInput = true;
 
     private void OnCompositionChanged(string oldValue, string newValue)
@@ -73,21 +77,12 @@ protected virtual void OnIMETextInput(char character)
     {
         //Debug.WriteLine($"IME: OnIMETextInput: {character} {(short)character}; IMEFocus is null? {IMEFocus == null}");
 
-        IMEEventReceived = true;
         LastActionIMEChatInput = true;
 
         if (IMEFocus != null)
         {
-            // Handle ESC
-            if (character == 27 && CompositionEmpty)
-            {
-                IMEFocus.Text = string.Empty;
-            }
-            else
-            {
-                TextBoxHandleChatInputCallbacks.TryGetValue(IMEFocus, out var handleChatInput);
-                handleChatInput?.Invoke(character);
-            }
+            TextBoxHandleChatInputCallbacks.TryGetValue(IMEFocus, out var handleChatInput);
+            handleChatInput?.Invoke(character);
         }
     }
 
@@ -213,7 +208,15 @@ bool IIMEHandler.HandleEnterKey(XNATextBox sender)
     bool IIMEHandler.HandleEscapeKey(XNATextBox sender)
     {
         //Debug.WriteLine($"IME: HandleEscapeKey: handled: {IMEEventReceived}");
-        return IMEEventReceived;
+
+        // This method disables the ESC handling of the TextBox as long as the user has ever used IME.
+        // This is because IME users often use ESC to cancel composition. Even if currently the composition is empty,
+        // the user still expects ESC to cancel composition rather than deleting the whole sentence.
+        // For example, the user might mistakenly hit ESC key twice to cancel composition -- deleting the whole sentence is definitely a heavy punishment for such a small mistake.
+
+        // Note: "!CompositionEmpty => IMEEventReceived" should hold, but just in case
+
+        return IMEEventReceived || !CompositionEmpty;
     }
 
     void IIMEHandler.OnTextChanged(XNATextBox sender) { }