v2.4.1:

Nifty255 · Nifty255 · commit ff33f21b0cd2 · 2016-08-06T00:48:38.000+09:00
- Modified DraftKerbal method to invoke success using a generic Dictionary instead of a specialized DraftInfo object.
- ScenarioDraftManager now destroys itself when returning to the main menu (and reloads when entering another save) to prevent potential load/save issues.
diff --git a/DraftTwitchViewers/Plugins/DraftTwitchViewers.dll b/DraftTwitchViewers/Plugins/DraftTwitchViewers.dll
diff --git a/DraftTwitchViewers/README.txt b/DraftTwitchViewers/README.txt
@@ -30,6 +30,10 @@ Draft Twitch Viewers (DTV) uses web requests to connect to Twitch, and can pick
 
 CHANGELOG:
 
+v2.4.1:
+- Modified DraftKerbal method to invoke success using a generic Dictionary instead of a specialized DraftInfo object.
+- ScenarioDraftManager now destroys itself when returning to the main menu (and reloads when entering another save) to prevent potential load/save issues.
+
 v2.4:
 - Drafts are now saved directly to each save's persistent file, allowing reverts to free drafted names.
 - An upgrade system was left in place which will migrate pre-existing drafts over to the new system.
diff --git a/README.md b/README.md
@@ -30,6 +30,10 @@ Draft Twitch Viewers (DTV) uses web requests to connect to Twitch, and can pick
 
 CHANGELOG:
 
+v2.4.1:
+- Modified DraftKerbal method to invoke success using a generic Dictionary instead of a specialized DraftInfo object.
+- ScenarioDraftManager now destroys itself when returning to the main menu (and reloads when entering another save) to prevent potential load/save issues.
+
 v2.4:
 - Drafts are now saved directly to each save's persistent file, allowing reverts to free drafted names.
 - An upgrade system was left in place which will migrate pre-existing drafts over to the new system.
diff --git a/Source/DraftTwitchViewers/DraftManagerApp.cs b/Source/DraftTwitchViewers/DraftManagerApp.cs
@@ -649,11 +649,11 @@ private void DoDraft(bool forDrawing, string job = "Any")
         /// Creates a new Kerbal based on the provided name.
         /// </summary>
         /// <param name="kerbalName">The name of the new Kerbal.</param>
-        private void DraftSuccess(DraftInfo info)
+        private void DraftSuccess(Dictionary<string, string> info)
         {
             ProtoCrewMember newKerbal = HighLogic.CurrentGame.CrewRoster.GetNewKerbal();
-            newKerbal.name = info.name;
-            KerbalRoster.SetExperienceTrait(newKerbal, info.job);
+            newKerbal.name = info["name"];
+            KerbalRoster.SetExperienceTrait(newKerbal, info["job"]);
 
             // If the game is career, subtract the cost of hiring.
             if (HighLogic.CurrentGame.Mode == Game.Modes.CAREER)
@@ -685,7 +685,7 @@ private void DraftSuccess(DraftInfo info)
             else
             {
                 // Alert in-game.
-                alertingMsg = draftMessage.Replace("&user", info.name).Replace("&skill", newKerbal.experienceTrait.Title);
+                alertingMsg = draftMessage.Replace("&user", info["name"]).Replace("&skill", newKerbal.experienceTrait.Title);
                 draftBusy = false;
                 failedToDraft = false;
                 alertShowing = true;
@@ -698,10 +698,10 @@ private void DraftSuccess(DraftInfo info)
         /// Displays the winner of the drawing.
         /// </summary>
         /// <param name="winner">The winner of the drawing.</param>
-        private void DrawingSuccess(DraftInfo info)
+        private void DrawingSuccess(Dictionary<string, string> info)
         {
             // Alert in-game.
-            alertingMsg = drawMessage.Replace("&user", info.name);
+            alertingMsg = drawMessage.Replace("&user", info["winner"]);
             draftBusy = false;
             failedToDraft = false;
             alertShowing = true;
diff --git a/Source/DraftTwitchViewers/Properties/AssemblyInfo.cs b/Source/DraftTwitchViewers/Properties/AssemblyInfo.cs
@@ -32,5 +32,5 @@
 // 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("2.4.0.0")]
-[assembly: AssemblyFileVersion("2.3.0.0")]
+[assembly: AssemblyVersion("2.4.1.0")]
+[assembly: AssemblyFileVersion("2.3.1.0")]
diff --git a/Source/DraftTwitchViewers/README.txt b/Source/DraftTwitchViewers/README.txt
@@ -30,6 +30,10 @@ Draft Twitch Viewers (DTV) uses web requests to connect to Twitch, and can pick
 
 CHANGELOG:
 
+v2.4.1:
+- Modified DraftKerbal method to invoke success using a generic Dictionary instead of a specialized DraftInfo object.
+- ScenarioDraftManager now destroys itself when returning to the main menu (and reloads when entering another save) to prevent potential load/save issues.
+
 v2.4:
 - Drafts are now saved directly to each save's persistent file, allowing reverts to free drafted names.
 - An upgrade system was left in place which will migrate pre-existing drafts over to the new system.
diff --git a/Source/DraftTwitchViewers/RescueContractModifier.cs b/Source/DraftTwitchViewers/RescueContractModifier.cs
@@ -136,7 +136,7 @@ void EnqueueContract(Contract toEnqueue)
         /// Called when a draft succeeds.
         /// </summary>
         /// <param name="kerbalName">The name of the drafted viewer.</param>
-        void DraftSuccess(DraftInfo info)
+        void DraftSuccess(Dictionary<string, string> info)
         {
             // Resets failures. The addon should only destroy after 5 consecutive failures.
             failures = 0;
@@ -152,7 +152,7 @@ void DraftSuccess(DraftInfo info)
             string oldName = replacement.GetValue("kerbalName");
 
             // Replace the old name with the new.
-            replacement.SetValue("kerbalName", info.name);
+            replacement.SetValue("kerbalName", info["name"]);
 
             // For each PARAM node in the CONTRACT node,
             foreach (ConfigNode node in replacement.nodes)
@@ -165,23 +165,23 @@ void DraftSuccess(DraftInfo info)
                 {
                     case "AcquireCrew":
                         {
-                            node.SetValue("title", "Save " + info.name);
+                            node.SetValue("title", "Save " + info["name"]);
                             break;
                         }
                     case "AcquirePart":
                         {
-                            string firstName = info.name.Substring(0, info.name.IndexOf(' '));
+                            string firstName = info["name"].Substring(0, info["name"].IndexOf(' '));
                             node.SetValue("title", "Obtain " + firstName + "'s Scrap");
                             break;
                         }
                     case "RecoverKerbal":
                         {
-                            node.SetValue("title", "Recover " + info.name + " on Kerbin");
+                            node.SetValue("title", "Recover " + info["name"] + " on Kerbin");
                             break;
                         }
                     case "RecoverPart":
                         {
-                            string firstName = info.name.Substring(0, info.name.IndexOf(' '));
+                            string firstName = info["name"].Substring(0, info["name"].IndexOf(' '));
                             node.SetValue("title", "Recover " + firstName + "'s Scrap on Kerbin");
                             break;
                         }
@@ -206,10 +206,10 @@ void DraftSuccess(DraftInfo info)
 
             // Get the old Kerbal and rename it.
             ProtoCrewMember toRename = HighLogic.CurrentGame.CrewRoster[oldName];
-            toRename.name = info.name;
+            toRename.name = info["name"];
 
             // Logging.
-            Logger.DebugLog("Draft Success (" + contractsToModify.Count.ToString() + " contracts waiting): " + info.name);
+            Logger.DebugLog("Draft Success (" + contractsToModify.Count.ToString() + " contracts waiting): " + info["name"]);
 
             // Refresh the contract list by firing the onContractListChanged event.
             GameEvents.Contract.onContractsListChanged.Fire();
diff --git a/Source/DraftTwitchViewers/ScenarioDraftManager.cs b/Source/DraftTwitchViewers/ScenarioDraftManager.cs
@@ -6,19 +6,10 @@
 
 namespace DraftTwitchViewers
 {
-    struct DraftInfo
-    {
-        public string name;
-        public string job;
-
-        public DraftInfo(string name, string job = "Any")
-        {
-            this.name = name;
-            this.job = job;
-        }
-    }
-
-    [KSPScenario(ScenarioCreationOptions.AddToAllGames, new GameScenes[] { GameScenes.SPACECENTER, GameScenes.EDITOR, GameScenes.FLIGHT })]
+    /// <summary>
+    /// A KSP Scenario module which handles all draft functions, both internal and external.
+    /// </summary>
+    [KSPScenario(ScenarioCreationOptions.AddToAllGames, new GameScenes[] { GameScenes.SPACECENTER })]
     class ScenarioDraftManager : ScenarioModule
     {
         #region Instance
@@ -254,6 +245,9 @@ public override void OnAwake()
 
                 #endregion
 
+                // Destroy this instance if the Main Menu is loaded.
+                GameEvents.onGameSceneLoadRequested.Add(SceneRequested);
+
                 // Initialize the regex array.
                 InitRegexes();
             }
@@ -281,10 +275,19 @@ void Update()
             }
         }
 
+        void OnDestroy()
+        {
+            Instance = null;
+        }
+
         #endregion
 
         #region KSP Functions
 
+        /// <summary>
+        /// Loads the local game settings for this scenario.
+        /// </summary>
+        /// <param name="node">The config node for this scenario.</param>
         public override void OnLoad(ConfigNode node)
         {
             #region Local
@@ -323,6 +326,10 @@ public override void OnLoad(ConfigNode node)
             #endregion
         }
 
+        /// <summary>
+        /// Saves the local game settings for this scenario.
+        /// </summary>
+        /// <param name="node">The config node for this scenario.</param>
         public override void OnSave(ConfigNode node)
         {
             SaveGlobalSettings();
@@ -410,19 +417,32 @@ public void LegacyLoadLocalSettings()
             }
         }
 
+        /// <summary>
+        /// Destroys this instance if the requested scene is the Main Menu.
+        /// </summary>
+        /// <param name="requestedScene">The requested scene.</param>
+        void SceneRequested(GameScenes requestedScene)
+        {
+            if (requestedScene == GameScenes.MAINMENU)
+            {
+                Destroy(gameObject);
+            }
+        }
+
         #endregion
 
         #region Draft function
 
         /// <summary>
         /// Drafts a Kerbal, invoking the suplied success Action if the draft succeeds, or the failure Action if the draft fails.
         /// </summary>
-        /// <param name="success">The Action to invoke on draft success.</param>
-        /// <param name="failure">The Action to invoke on draft failure.</param>
+        /// <param name="success">The Action to invoke on draft success. Provides a dictionary which will contain a "winner" entry for drawings, or a "name" and "job" entry for drafts.</param>
+        /// <param name="failure">The Action to invoke on draft failure. Provides a string reason the draft failed.</param>
         /// <param name="forDrawing">Whether the draft is for a drawing, or for an actual draft.</param>
+        /// <param name="suppressSave">If true, the drafted user will not be saved.</param>
         /// <param name="job">The job for the Kerbal. Optional and defaults to "Any" and is not needed if forDrawing is true.</param>
         /// <returns>The IEnumerator (used for making the draft asynchronously).</returns>
-        public static IEnumerator DraftKerbal(Action<DraftInfo> success, Action<string> failure, bool forDrawing, bool suppressSave, string job = "Any")
+        public static IEnumerator DraftKerbal(Action<Dictionary<string, string>> success, Action<string> failure, bool forDrawing, bool suppressSave, string job = "Any")
         {
             // If a channel hasn't been input yet,
             if (string.IsNullOrEmpty(Instance.channel))
@@ -534,8 +554,11 @@ public static IEnumerator DraftKerbal(Action<DraftInfo> success, Action<string>
                                     Instance.SaveDrawn();
                                 }
 
+                                Dictionary<string, string> winner = new Dictionary<string, string>();
+                                winner.Add("winner", realUsername);
+
                                 // Invoke the success Action, allowing the caller to continue.
-                                success.Invoke(new DraftInfo(realUsername));
+                                success.Invoke(winner);
                             }
                             // If there is an error,
                             else
@@ -620,8 +643,13 @@ public static IEnumerator DraftKerbal(Action<DraftInfo> success, Action<string>
                                 Instance.AlreadyDrafted.Add(oddUsername);
                             }
 
+                            Dictionary<string, string> drafted = new Dictionary<string, string>();
+
+                            drafted.Add("name", realUsername + (Instance.addKerman ? " Kerman" : ""));
+                            drafted.Add("job", job);
+
                             // Invoke the success Action, allowing the caller to continue.
-                            success.Invoke(new DraftInfo(realUsername + (Instance.addKerman ? " Kerman" : ""), job));
+                            success.Invoke(drafted);
                         }
                         // Else, if we failed to find one,
                         else if (failedToFindOne)
diff --git a/Source/DraftTwitchViewers/TourismContractModifier.cs b/Source/DraftTwitchViewers/TourismContractModifier.cs
@@ -142,10 +142,10 @@ void EnqueueContract(Contract toEnqueue)
         /// Called when a draft succeeds.
         /// </summary>
         /// <param name="kerbalName">The name of the drafted viewer.</param>
-        void DraftSuccess(DraftInfo info)
+        void DraftSuccess(Dictionary<string, string> info)
         {
             // Enqueue the name first thing, since it needs to be in the queue whether it has enough with it or not.
-            draftNames.Enqueue(info.name);
+            draftNames.Enqueue(info["name"]);
 
             // Resets failures. The addon should only destroy after 5 consecutive failures.
             failures = 0;

Original file line number	Diff line number	Diff line change
`@@ -136,7 +136,7 @@ void EnqueueContract(Contract toEnqueue)`
`136`	`136`	`/// Called when a draft succeeds.`
`137`	`137`	`/// </summary>`
`138`	`138`	`/// <param name="kerbalName">The name of the drafted viewer.</param>`
`139`		`- void DraftSuccess(DraftInfo info)`
	`139`	`+ void DraftSuccess(Dictionary<string, string> info)`
`140`	`140`	`{`
`141`	`141`	`// Resets failures. The addon should only destroy after 5 consecutive failures.`
`142`	`142`	`failures = 0;`
`@@ -152,7 +152,7 @@ void DraftSuccess(DraftInfo info)`
`152`	`152`	`string oldName = replacement.GetValue("kerbalName");`
`153`	`153`
`154`	`154`	`// Replace the old name with the new.`
`155`		`- replacement.SetValue("kerbalName", info.name);`
	`155`	`+ replacement.SetValue("kerbalName", info["name"]);`
`156`	`156`
`157`	`157`	`// For each PARAM node in the CONTRACT node,`
`158`	`158`	`foreach (ConfigNode node in replacement.nodes)`
`@@ -165,23 +165,23 @@ void DraftSuccess(DraftInfo info)`
`165`	`165`	`{`
`166`	`166`	`case "AcquireCrew":`
`167`	`167`	`{`
`168`		`- node.SetValue("title", "Save " + info.name);`
	`168`	`+ node.SetValue("title", "Save " + info["name"]);`
`169`	`169`	`break;`
`170`	`170`	`}`
`171`	`171`	`case "AcquirePart":`
`172`	`172`	`{`
`173`		`- string firstName = info.name.Substring(0, info.name.IndexOf(' '));`
	`173`	`+ string firstName = info["name"].Substring(0, info["name"].IndexOf(' '));`
`174`	`174`	`node.SetValue("title", "Obtain " + firstName + "'s Scrap");`
`175`	`175`	`break;`
`176`	`176`	`}`
`177`	`177`	`case "RecoverKerbal":`
`178`	`178`	`{`
`179`		`- node.SetValue("title", "Recover " + info.name + " on Kerbin");`
	`179`	`+ node.SetValue("title", "Recover " + info["name"] + " on Kerbin");`
`180`	`180`	`break;`
`181`	`181`	`}`
`182`	`182`	`case "RecoverPart":`
`183`	`183`	`{`
`184`		`- string firstName = info.name.Substring(0, info.name.IndexOf(' '));`
	`184`	`+ string firstName = info["name"].Substring(0, info["name"].IndexOf(' '));`
`185`	`185`	`node.SetValue("title", "Recover " + firstName + "'s Scrap on Kerbin");`
`186`	`186`	`break;`
`187`	`187`	`}`
`@@ -206,10 +206,10 @@ void DraftSuccess(DraftInfo info)`
`206`	`206`
`207`	`207`	`// Get the old Kerbal and rename it.`
`208`	`208`	`ProtoCrewMember toRename = HighLogic.CurrentGame.CrewRoster[oldName];`
`209`		`- toRename.name = info.name;`
	`209`	`+ toRename.name = info["name"];`
`210`	`210`
`211`	`211`	`// Logging.`
`212`		`- Logger.DebugLog("Draft Success (" + contractsToModify.Count.ToString() + " contracts waiting): " + info.name);`
	`212`	`+ Logger.DebugLog("Draft Success (" + contractsToModify.Count.ToString() + " contracts waiting): " + info["name"]);`
`213`	`213`
`214`	`214`	`// Refresh the contract list by firing the onContractListChanged event.`
`215`	`215`	`GameEvents.Contract.onContractsListChanged.Fire();`