ShuriZma
/
BizHawk
mirror of https://github.com/TASEmulators/BizHawk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Use a cache for `tastudio.onqueryitemicon`

This commit is contained in:
YoshiRulz 2023-03-18 11:20:19 +10:00
parent cddc092b96
commit 291a14315d
No known key found for this signature in database
GPG Key ID: C4DE31C245353FB7
1 changed files with 12 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
src/BizHawk.Client.EmuHawk/tools/Lua/Libraries/TAStudioLuaLibrary.cs
View File

@ -16,6 +16,8 @@ namespace BizHawk.Client.EmuHawk
[LuaLibrary(released: true)]
public sealed class TAStudioLuaLibrary : LuaLibraryBase
{
private static readonly IDictionary<string, Icon> _iconCache = new Dictionary<string, Icon>();
public ToolManager Tools { get; set; }
public TAStudioLuaLibrary(ILuaLibraries luaLibsImpl, ApiContainer apiContainer, Action<string> logOutputCallback)
@ -505,7 +507,7 @@ namespace BizHawk.Client.EmuHawk
}
[LuaMethodExample("tastudio.onqueryitemicon( function( currentindex, itemname )\r\n\tconsole.log( \"called during the icon draw event of the tastudio listview. luaf must be a function that takes 2 params: index, column. The first is the integer row index of the listview, and the 2nd is the string column name. luaf should return a value that can be parsed into a .NET Color object (string color name, or integer value)\" );\r\nend );")]
[LuaMethod("onqueryitemicon", "Called during the icon draw event of the tastudio listview. {{luaf}} must be a function that takes 2 params: {{(index, column)}}. The first is the integer row index of the listview, and the 2nd is the string column name. The callback should return a string, the path to the image file to be displayed.")]
[LuaMethod("onqueryitemicon", "Called during the icon draw event of the tastudio listview. {{luaf}} must be a function that takes 2 params: {{(index, column)}}. The first is the integer row index of the listview, and the 2nd is the string column name. The callback should return a string, the path to the {{.ico}} file to be displayed. The file will be cached, so if you change the file on disk, call {{tastudio.clearIconCache()}}.")]
public void OnQueryItemIcon(LuaFunction luaf)
{
if (Engaged())
@ -516,7 +518,7 @@ namespace BizHawk.Client.EmuHawk
if (result?[0] != null)
{
string path = result[0].ToString();
Icon icon = new Icon(path);
if (!_iconCache.TryGetValue(path, out var icon)) _iconCache[path] = icon = new(path);
return icon.ToBitmap();
}
@ -525,6 +527,14 @@ namespace BizHawk.Client.EmuHawk
}
}
[LuaMethodExample("tastudio.clearIconCache();")]
[LuaMethod("clearIconCache", "Clears the cache that is built up by using {{tastudio.onqueryitemicon}}, so that changes to the icons on disk can be picked up.")]
public void ClearIconCache()
{
foreach (var icon in _iconCache.Values) icon.Dispose();
_iconCache.Clear();
}
[LuaMethodExample("tastudio.ongreenzoneinvalidated( function( currentindex )\r\n\tconsole.log( \"Called whenever the greenzone is invalidated.\" );\r\nend );")]
[LuaMethod("ongreenzoneinvalidated", "Called whenever the greenzone is invalidated. Your callback can have 1 parameter, which will be the index of the first row that was invalidated.")]
public void OnGreenzoneInvalidated(LuaFunction luaf)