From e3e51678b76d9c586e154f18c078e6917ccd1d94 Mon Sep 17 00:00:00 2001 From: YoshiRulz Date: Wed, 28 Aug 2019 15:11:14 +1000 Subject: [PATCH] Improve docs in SavestateLuaLibrary (resolves #1649) --- .../tools/Lua/Libraries/EmuLuaLibrary.Savestate.cs | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/BizHawk.Client.EmuHawk/tools/Lua/Libraries/EmuLuaLibrary.Savestate.cs b/BizHawk.Client.EmuHawk/tools/Lua/Libraries/EmuLuaLibrary.Savestate.cs index a99aa9ac88..8c251f94c2 100644 --- a/BizHawk.Client.EmuHawk/tools/Lua/Libraries/EmuLuaLibrary.Savestate.cs +++ b/BizHawk.Client.EmuHawk/tools/Lua/Libraries/EmuLuaLibrary.Savestate.cs @@ -18,7 +18,7 @@ namespace BizHawk.Client.EmuHawk public override string Name => "savestate"; [LuaMethodExample("savestate.load( \"C:\\state.bin\" );")] - [LuaMethod("load", "Loads a savestate with the given path")] + [LuaMethod("load", "Loads a savestate with the given path. If EmuHawk is deferring quicksaves, to TAStudio for example, that form will do what it likes (and the path is ignored).")] public void Load(string path) { if (!File.Exists(path)) @@ -32,7 +32,7 @@ namespace BizHawk.Client.EmuHawk } [LuaMethodExample("savestate.loadslot( 7 );")] - [LuaMethod("loadslot", "Loads the savestate at the given slot number (must be an integer between 0 and 9)")] + [LuaMethod("loadslot", "Loads the savestate at the given slot number (must be an integer between 0 and 9). If EmuHawk is deferring quicksaves, to TAStudio for example, that form will do what it likes with the slot number.")] public void LoadSlot(int slotNum) { if (slotNum >= 0 && slotNum <= 9) @@ -42,14 +42,14 @@ namespace BizHawk.Client.EmuHawk } [LuaMethodExample("savestate.save( \"C:\\state.bin\" );")] - [LuaMethod("save", "Saves a state at the given path")] + [LuaMethod("save", "Saves a state at the given path. If EmuHawk is deferring quicksaves, to TAStudio for example, that form will do what it likes (and the path is ignored).")] public void Save(string path) { GlobalWin.MainForm.SaveState(path, path, true); } [LuaMethodExample("savestate.saveslot( 7 );")] - [LuaMethod("saveslot", "Saves a state at the given save slot (must be an integer between 0 and 9)")] + [LuaMethod("saveslot", "Saves a state at the given save slot (must be an integer between 0 and 9). If EmuHawk is deferring quicksaves, to TAStudio for example, that form will do what it likes with the slot number.")] public void SaveSlot(int slotNum) { if (slotNum >= 0 && slotNum <= 9)