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

Correct mem callbacks docs (resolves #3522)

This commit is contained in:
YoshiRulz 2023-03-16 14:48:17 +10:00
parent 565a0b9141
commit 6b4f3355fd
No known key found for this signature in database
GPG Key ID: C4DE31C245353FB7
2 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
src/BizHawk.Client.Common/lua/LuaHelperLibs/EventsLuaLibrary.cs
View File

@ -98,7 +98,7 @@ namespace BizHawk.Client.Common
.Guid.ToString(); .Guid.ToString();
[LuaDeprecatedMethod] [LuaDeprecatedMethod]
[LuaMethod("onmemoryexecute", "Fires after the given address is executed by the core")] [LuaMethod("onmemoryexecute", "Fires immediately before the given address is executed by the core")]
public string OnMemoryExecute( public string OnMemoryExecute(
LuaFunction luaf, LuaFunction luaf,
uint address, uint address,
@ -109,8 +109,8 @@ namespace BizHawk.Client.Common
return OnBusExec(luaf, address, name: name, scope: scope); return OnBusExec(luaf, address, name: name, scope: scope);
} }
[LuaMethodExample("local exec_cb_id = event.on_bus_exec(\r\n\tfunction()\r\n\t\tconsole.log( \"Fires after the given address is executed by the core\" );\r\n\tend\r\n\t, 0x200, \"Frame name\", \"System Bus\" );")] [LuaMethodExample("local exec_cb_id = event.on_bus_exec(\r\n\tfunction()\r\n\t\tconsole.log( \"Fires immediately before the given address is executed by the core\" );\r\n\tend\r\n\t, 0x200, \"Frame name\", \"System Bus\" );")]
[LuaMethod("on_bus_exec", "Fires after the given address is executed by the core")] [LuaMethod("on_bus_exec", "Fires immediately before the given address is executed by the core")]
public string OnBusExec( public string OnBusExec(
LuaFunction luaf, LuaFunction luaf,
uint address, uint address,
@ -145,7 +145,7 @@ namespace BizHawk.Client.Common
} }
[LuaDeprecatedMethod] [LuaDeprecatedMethod]
[LuaMethod("onmemoryexecuteany", "Fires after any address is executed by the core (CPU-intensive)")] [LuaMethod("onmemoryexecuteany", "Fires immediately before any address is executed by the core (CPU-intensive)")]
public string OnMemoryExecuteAny( public string OnMemoryExecuteAny(
LuaFunction luaf, LuaFunction luaf,
string name = null, string name = null,
@ -155,8 +155,8 @@ namespace BizHawk.Client.Common
return OnBusExecAny(luaf, name: name, scope: scope); return OnBusExecAny(luaf, name: name, scope: scope);
} }
[LuaMethodExample("local exec_cb_id = event.on_bus_exec_any(\r\n\tfunction()\r\n\t\tconsole.log( \"Fires after any address is executed by the core (CPU-intensive)\" );\r\n\tend\r\n\t, \"Frame name\", \"System Bus\" );")] [LuaMethodExample("local exec_cb_id = event.on_bus_exec_any(\r\n\tfunction()\r\n\t\tconsole.log( \"Fires immediately before every instruction executed (in the specified scope) by the core (CPU-intensive)\" );\r\n\tend\r\n\t, \"Frame name\", \"System Bus\" );")]
[LuaMethod("on_bus_exec_any", "Fires after any address is executed by the core (CPU-intensive)")] [LuaMethod("on_bus_exec_any", "Fires immediately before every instruction executed (in the specified scope) by the core (CPU-intensive)")]
public string OnBusExecAny( public string OnBusExecAny(
LuaFunction luaf, LuaFunction luaf,
string name = null, string name = null,

2
src/BizHawk.Emulation.Common/Interfaces/IMemoryCallbackSystem.cs
View File

@ -68,7 +68,7 @@ namespace BizHawk.Emulation.Common
/// Executes all matching callbacks for the given address and domain /// Executes all matching callbacks for the given address and domain
/// </summary> /// </summary>
/// <param name="addr">The address to check for callbacks</param> /// <param name="addr">The address to check for callbacks</param>
/// <param name="value">The value contained (or written to) addr</param> /// <param name="value">For reads/execs, the value read/executed; for writes, the value to be written. Cores may pass the default <c>0</c> if write/exec is partially implemented.</param>
/// <param name="flags">The callback flags relevant to this access</param> /// <param name="flags">The callback flags relevant to this access</param>
/// <param name="scope">The scope that the address pertains to. Must be a value in <see cref="AvailableScopes"/></param> /// <param name="scope">The scope that the address pertains to. Must be a value in <see cref="AvailableScopes"/></param>
void CallMemoryCallbacks(uint addr, uint value, uint flags, string scope); void CallMemoryCallbacks(uint addr, uint value, uint flags, string scope);