Lua - add a userdata library, with basic api for a script to add arbitruary data to a dictionary. This dictionary is saved and loaded in savestates (if present). Scripts can use this to create counters and whatnot that need data saved in savestates

BizHawk.Client.Common/BinarySaveStates.cs

@@ -27,7 +27,9 @@ namespace BizHawk.Client.Common
 		StateHistorySettings,
 		Markers,
 		ClientSettings,
-		VerificationLog
+		VerificationLog,
+
+		UserData
 	}
 
 	public static class BinaryStateFileNames
@@ -63,6 +65,7 @@ namespace BizHawk.Client.Common
 			AddLumpName(BinaryStateLump.Markers, "Markers.txt");
 			AddLumpName(BinaryStateLump.ClientSettings, "ClientSettings.json");
 			AddLumpName(BinaryStateLump.VerificationLog, "VerificationLog.txt");
+			AddLumpName(BinaryStateLump.UserData, "UserData.txt");
 		}
 
 		public static string GetReadName(BinaryStateLump lump)

BizHawk.Client.Common/BizHawk.Client.Common.csproj

@@ -137,6 +137,7 @@
     <Compile Include="lua\EmuLuaLibrary.NES.cs" />
     <Compile Include="lua\EmuLuaLibrary.SNES.cs" />
     <Compile Include="lua\EmuLuaLibrary.String.cs" />
+    <Compile Include="lua\EmuLuaLibrary.UserData.cs" />
     <Compile Include="lua\LuaAttributes.cs" />
     <Compile Include="lua\LuaDocumentation.cs" />
     <Compile Include="lua\LuaFile.cs" />

BizHawk.Client.Common/Global.cs

@@ -2,6 +2,7 @@
 using BizHawk.Emulation.Cores.Nintendo.Gameboy;
 using BizHawk.Emulation.Cores.Sega.MasterSystem;
 using BizHawk.Emulation.DiscSystem;
+using System.Collections.Generic;
 
 namespace BizHawk.Client.Common
 {
@@ -146,5 +147,7 @@ namespace BizHawk.Client.Common
 				}
 			}
 		}
+
+		public static Dictionary<string, object> UserBag = new Dictionary<string, object>();
 	}
 }

BizHawk.Client.Common/SavestateManager.cs

@@ -1,11 +1,13 @@
 using System;
 using System.IO;
+using System.Linq;
 
 using BizHawk.Common;
 using BizHawk.Common.BufferExtensions;
 using BizHawk.Common.IOExtensions;
 using BizHawk.Emulation.Common;
 using BizHawk.Emulation.Common.IEmulatorExtensions;
+using System.Collections.Generic;
 
 namespace BizHawk.Client.Common
 {
@@ -60,6 +62,16 @@ namespace BizHawk.Client.Common
 							Global.MovieSession.HandleMovieSaveState(tw);
 						});
 				}
+
+				if (Global.UserBag.Any())
+				{
+					bs.PutLump(BinaryStateLump.UserData,
+						delegate(TextWriter tw)
+						{
+							var data = ConfigService.SaveWithType(Global.UserBag);
+							tw.WriteLine(data);
+						});
+				}
 			}
 		}
 
@@ -116,6 +128,24 @@ namespace BizHawk.Client.Common
 						bl.GetCoreState(br => core.LoadStateBinary(br), tr => core.LoadStateText(tr));
 
 					bl.GetLump(BinaryStateLump.Framebuffer, false, PopulateFramebuffer);
+
+					if (bl.HasLump(BinaryStateLump.UserData))
+					{
+						string userData = string.Empty;
+						bl.GetLump(BinaryStateLump.UserData, false, delegate(TextReader tr)
+						{
+							string line;
+							while ((line = tr.ReadLine()) != null)
+							{
+								if (!string.IsNullOrWhiteSpace(line))
+								{
+									userData = line;
+								}
+							}
+						});
+
+						Global.UserBag = (Dictionary<string, object>)ConfigService.LoadWithType(userData);
+					}
 				}
 				catch
 				{

BizHawk.Client.Common/lua/EmuLuaLibrary.UserData.cs

@@ -0,0 +1,65 @@
+using System;
+using System.Collections.Generic;
+using System.ComponentModel;
+using System.Linq;
+
+using LuaInterface;
+using BizHawk.Common;
+using BizHawk.Emulation.Common;
+using BizHawk.Client.Common;
+
+namespace BizHawk.Client.EmuHawk
+{
+	[Description("A library for setting and retrieving dynamic data that will be saved and loaded with savestates")]
+	public sealed class UserDataLibrary : LuaLibraryBase
+	{
+		public UserDataLibrary(Lua lua)
+			: base(lua) { }
+
+		public UserDataLibrary(Lua lua, Action<string> logOutputCallback)
+			: base(lua, logOutputCallback) { }
+
+		public override string Name { get { return "userdata"; } }
+
+		[LuaMethodAttributes(
+			"set",
+			"adds or updates the data with the given key with the given value"
+		)]
+		public void Set(string name, object value)
+		{
+			Global.UserBag[name] = value;
+		}
+
+		[LuaMethodAttributes(
+			"get",
+			"gets the data with the given key, if the key does not exist it will return nil"
+		)]
+		public object Get(string key)
+		{
+			if (Global.UserBag.ContainsKey(key))
+			{
+				return Global.UserBag[key];
+			}
+
+			return null;
+		}
+
+		[LuaMethodAttributes(
+			"clear",
+			"clears all user data"
+		)]
+		public void Clear()
+		{
+			Global.UserBag.Clear();
+		}
+
+		[LuaMethodAttributes(
+			"remove",
+			"remove the data with the given key. Returns true if the element is successfully found and removed; otherwise, false."
+		)]
+		public bool Remove(string key)
+		{
+			return Global.UserBag.Remove(key);
+		}
+	}
+}