fix: Properly segregate the new editor window classes into their own files and add documentation to them as-is appropriate.

Author: paulhazen

Assets/Plugins/Source/Editor/EditorWindows/EOSEditorWindow.cs

@@ -126,7 +126,7 @@ protected EOSEditorWindow(
         /// <summary>
         /// String value for the title of the window.
         /// </summary>
-        public string WindowTitle { get; protected set; }
+        public string WindowTitle { get; }
 
         protected virtual void OnEnable()
         {

Assets/Plugins/Source/Editor/EditorWindows/EncryptionKeyWindow.cs

@@ -0,0 +1,80 @@
+/*
+ * Copyright (c) 2024 PlayEveryWare
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+namespace PlayEveryWare.EpicOnlineServices.Editor.Windows
+{
+    using PlayEveryWare.EpicOnlineServices.Editor.Utility;
+    using PlayEveryWare.EpicOnlineServices;
+    using System;
+    using UnityEditor;
+    using UnityEngine;
+
+    /// <summary>
+    /// Represents a modal window used to display and edit the encryption key field of a set of client credentials.
+    /// </summary>
+    public sealed class EncryptionKeyWindow : ModalEOSEditorWindow<string>
+    {
+        public EncryptionKeyWindow() : base("Client Credential Encryption Key", 600f, 50f)
+        {
+        }
+
+        /// <summary>
+        /// Helper function to show the modal window.
+        /// </summary>
+        /// <param name="input">
+        /// The encryption key string.
+        /// </param>
+        /// <param name="onSubmitCallback">
+        /// The action to take when the modal window is submitted.
+        /// </param>
+        public static void Show(string input, Action<string> onSubmitCallback)
+        {
+            ScheduleShow<EncryptionKeyWindow>(
+                input,
+                onSubmitCallback,
+                EOSClientCredentials.IsEncryptionKeyValid,
+                "Enter the encryption key for these client credentials here:",
+                "Invalid encryption key. Encryption key must be 64 characters long and contain only alphanumeric characters.");
+        }
+
+        /// <summary>
+        /// Renders the fields necessary to edit the encryption key.
+        /// </summary>
+        protected override void RenderModalContents()
+        {
+            GUILayout.BeginHorizontal();
+
+            _input = GUILayout.TextField(_input, GUILayout.Width(GUIEditorUtility.MeasureLabelWidth(64)), GUILayout.Height(20));
+
+            GUILayout.Space(5f);
+
+            if (GUILayout.Button(
+                new GUIContent(EditorGUIUtility.IconContent("Refresh").image,
+                "Click here to generate a new encryption key."), GUILayout.Height(20), GUILayout.Width(50)))
+            {
+                _input = EOSClientCredentials.GenerateEncryptionKey();
+            }
+            GUILayout.EndHorizontal();
+        }
+    }
+
+}

Assets/Plugins/Source/Editor/EditorWindows/EncryptionKeyWindow.cs.meta

@@ -1,85 +1,110 @@
-using PlayEveryWare.EpicOnlineServices.Editor.Utility;
-using System;
-using System.Threading.Tasks;
-using UnityEditor;
-using UnityEngine;
+/*
+ * Copyright (c) 2024 PlayEveryWare
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
 
 namespace PlayEveryWare.EpicOnlineServices.Editor.Windows
 {
-    public sealed class ClientCredentialsEncryptionKeyWindow : ModalInputWindow<string>
-    {
-        public ClientCredentialsEncryptionKeyWindow() : base(600f, 50f)
-        {
-        }
-
-        public static void Show(
-            string input,
-            Action<string> onSubmitCallback,
-            string windowTitle = "Client Credentials Encryption Key",
-            string inputPrompt = "Enter the encryption key for these client credentials here:")
-        {
-            ScheduleShow<ClientCredentialsEncryptionKeyWindow>(
-                input, 
-                onSubmitCallback, 
-                EOSClientCredentials.IsEncryptionKeyValid, 
-                windowTitle, 
-                inputPrompt,
-                "Invalid encryption key. Encryption key must be 64 characters long and contain only alphanumeric characters.");
-        }
-
-        protected override void RenderModalContents()
-        {
-            GUILayout.BeginHorizontal();
-
-            _input = GUILayout.TextField(_input, GUILayout.Width(GUIEditorUtility.MeasureLabelWidth(64)), GUILayout.Height(20));
-
-            GUILayout.Space(5f);
-
-            if (GUILayout.Button(
-                new GUIContent(EditorGUIUtility.IconContent("Refresh").image, 
-                "Click here to generate a new encryption key."), GUILayout.Height(20), GUILayout.Width(50)))
-            {
-                _input = EOSClientCredentials.GenerateEncryptionKey();
-            }
-            GUILayout.EndHorizontal();
-        }
-    }
-
-    public abstract class ModalInputWindow<TInputType> : EOSEditorWindow
+    using PlayEveryWare.EpicOnlineServices.Editor.Utility;
+    using System;
+    using UnityEditor;
+    using UnityEngine;
+
+    /// <summary>
+    /// Represents an editor window that is modal in nature - it is designed to
+    /// only provide input for a single value, and not be dismissed from focus
+    /// unless canceled or closed.
+    /// </summary>
+    /// <typeparam name="TInputType">
+    /// The type of value that the modal window is designed to edit.
+    /// </typeparam>
+    public abstract class ModalEOSEditorWindow<TInputType> : EOSEditorWindow
     {
+        /// <summary>
+        /// The value being edited.
+        /// </summary>
         protected TInputType _input;
+
+        /// <summary>
+        /// The prompt to display indicating what the value means.
+        /// </summary>
         private string _inputPrompt;
+
+        /// <summary>
+        /// The prompt to display if the input is not valid.
+        /// </summary>
         private string _errorPrompt;
+
+        /// <summary>
+        /// The action to take when the modal window is submitted.
+        /// </summary>
         private Action<TInputType> _onSubmit;
+
+        /// <summary>
+        /// The function used to validate the input.
+        /// </summary>
         private Func<TInputType, bool> _validateFunction;
+
+        /// <summary>
+        /// Flag that indicates whether the error prompt should be displayed.
+        /// </summary>
         private bool _showError;
 
         // Keep a reference to prevent focus loss
-        private static ModalInputWindow<TInputType> s_currentWindow;
+        private static ModalEOSEditorWindow<TInputType> s_currentWindow;
 
-        protected ModalInputWindow(float width, float height) : base("", height, width, false)
+        /// <summary>
+        /// Constructs a noew modal eos editor window.
+        /// </summary>
+        /// <param name="windowTitle">Window title.</param>
+        /// <param name="width">The fixed width of the window.</param>
+        /// <param name="height">The fixed height of the window.</param>
+        protected ModalEOSEditorWindow(string windowTitle, float width, float height) : base(windowTitle, height, width, false)
         {
         }
 
         /// <summary>
         /// Helper to schedule the showing of the modal window.
         /// </summary>
+        /// <typeparam name="TWindowType">Type of value modal window is designed to edit.</typeparam>
+        /// <param name="input">The value that the modal window provides editing of.</param>
+        /// <param name="onSubmitCallback">The action that takes place when the modal window is submitted with a valid value.</param>
+        /// <param name="validateFunction">Function used to validate the input.</param>
+        /// <param name="inputPrompt">The prompt to display in the modal window.</param>
+        /// <param name="errorPrompt">The error to display if the input value is invalid.</param>
         protected static void ScheduleShow<TWindowType>(
             TInputType input,
             Action<TInputType> onSubmitCallback,
             Func<TInputType, bool> validateFunction,
-            string windowTitle,
             string inputPrompt,
             string errorPrompt
-        ) where TWindowType : ModalInputWindow<TInputType>
+        ) where TWindowType : ModalEOSEditorWindow<TInputType>
         {
             void ShowAndUnsubscribe()
             {
                 // Unsubscribe first to ensure it runs only once
                 EditorApplication.update -= ShowAndUnsubscribe;
 
                 // Open the modal window
-                ShowWindow<TWindowType>(input, onSubmitCallback, validateFunction, windowTitle, inputPrompt, errorPrompt);
+                ShowWindow<TWindowType>(input, onSubmitCallback, validateFunction, inputPrompt, errorPrompt);
             }
 
             // Subscribe the delegate to execute on the next frame
@@ -90,19 +115,17 @@ public static void ShowWindow<TWindowType>(
             TInputType input, 
             Action<TInputType> onSubmitCallback, 
             Func<TInputType, bool> validateFunction,
-            string windowTitle,
             string inputPrompt,
-            string errorPrompt) where TWindowType : ModalInputWindow<TInputType>
+            string errorPrompt) where TWindowType : ModalEOSEditorWindow<TInputType>
         {
             if (s_currentWindow != null)
             {
                 s_currentWindow.Focus();
                 return;
             }
 
-            ModalInputWindow<TInputType> window = CreateInstance<TWindowType>();
+            ModalEOSEditorWindow<TInputType> window = CreateInstance<TWindowType>();
             window._input = input;
-            window.WindowTitle = windowTitle;
             window._inputPrompt = inputPrompt;
             window._onSubmit = onSubmitCallback;
             window._validateFunction = validateFunction;
@@ -155,35 +178,45 @@ protected override void OnDestroy()
             base.OnDestroy();
         }
 
+        /// <summary>
+        /// Deriving modal window implementations should implement this function
+        /// to render the contents of the input.
+        /// </summary>
         protected abstract void RenderModalContents();
 
         protected override void RenderWindow()
         {
             bool shouldClose = false;
 
+            // Render the prompt text
             EditorGUILayout.LabelField(_inputPrompt, GUILayout.Width(
                 GUIEditorUtility.MeasureLabelWidth(_inputPrompt))
             );
 
+            // Display error if it needs to be displayed.
             if (_showError)
             {
                 EditorGUILayout.HelpBox(_errorPrompt, MessageType.Warning);
             }
 
+            // Render the contents that are unique to the modal window implementation.
             RenderModalContents();
 
             EditorGUILayout.Space();
 
             GUILayout.BeginHorizontal();
             if (GUILayout.Button("Save"))
             {
+                // Try to validate the value being submitted
                 if (_validateFunction(_input))
                 {
+                    // If successful, then call the submit action.
                     _onSubmit?.Invoke(_input);
                     shouldClose = true;
                 }
                 else
                 {
+                    // Otherwise, turn on the flag that indicates the error should be displayed.
                     _showError = true;
                 }
             }
@@ -195,6 +228,7 @@ protected override void RenderWindow()
             }
             GUILayout.EndHorizontal();
 
+            // Close if it should be.
             if (shouldClose)
             {
                 Close();

…ditor/EditorWindows/ModalEditorWindow.cs …or/EditorWindows/ModalEOSEditorWindow.csAssets/Plugins/Source/Editor/EditorWindows/ModalEditorWindow.cs renamed to Assets/Plugins/Source/Editor/EditorWindows/ModalEOSEditorWindow.cs Assets/Plugins/Source/Editor/EditorWindows/ModalEditorWindow.cs renamed to Assets/Plugins/Source/Editor/EditorWindows/ModalEOSEditorWindow.cs

@@ -1068,14 +1068,12 @@ private static SetOfNamed<EOSClientCredentials> RenderInput(ConfigFieldAttribute
                         new Rect(renderCursorX, rect.y, keyButtonWidth, rect.height),
                         keyButtonContent))
                     {
-                        ClientCredentialsEncryptionKeyWindow.Show(item.Value.EncryptionKey, 
+                        EncryptionKeyWindow.Show(item.Value.EncryptionKey, 
                             result =>
                             {
                                 item.Value.EncryptionKey = result;
-                            },
-                            "Client Credentials Encryption Key", 
-                            "Enter the encryption key for these client credentials here:"
-                            );
+                            }
+                        );
                     }