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

More improvements to mem hook docs 

fixes 6b4f3355f
This commit is contained in:
YoshiRulz 2023-03-18 09:37:25 +10:00
parent 44bf67e8a3
commit f28067e7fc
No known key found for this signature in database
GPG Key ID: C4DE31C245353FB7
3 changed files with 20 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
src/BizHawk.Client.Common/lua/LuaDocumentation.cs
View File

@ -41,8 +41,9 @@ namespace BizHawk.Client.Common
** a string containing a CSS3/X11 color name e.g. ""blue"", ""palegoldenrod""; or
** a Color created with forms.createcolor.
** As noted above, luacolor? indicates nil may also be passed.
* luaf
** A Lua function. Note that these are always parameters, and never return values of a call
* nluafunc
** A Lua function. Note that these are always parameters, and never return values of a call.
** Some callbacks will be called with arguments, if the function you register has the right number of parameters. This will be noted in the registration function's docs.
* table
** A standard Lua table
* something else

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

@ -98,7 +98,7 @@ namespace BizHawk.Client.Common
.Guid.ToString();
[LuaDeprecatedMethod]
[LuaMethod("onmemoryexecute", "Fires immediately before the given address is executed by the core")]
[LuaMethod("onmemoryexecute", "Fires immediately before the given address is executed by the core. Your callback can have 3 parameters {{(addr, val, flags)}}. {{val}} is the value to be executed (or {{0}} always, if this feature is only partially implemented).")]
public string OnMemoryExecute(
LuaFunction luaf,
uint address,
@ -109,8 +109,8 @@ namespace BizHawk.Client.Common
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 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 immediately before the given address is executed by the core")]
[LuaMethodExample("local exec_cb_id = event.on_bus_exec(\r\n\tfunction(addr, val, flags)\r\n\t\tconsole.log( \"Fires immediately before the given address is executed by the core. {{val}} is the value to be executed (or {{0}} always, if this feature is only partially implemented).\" );\r\n\tend\r\n\t, 0x200, \"Frame name\", \"System Bus\" );")]
[LuaMethod("on_bus_exec", "Fires immediately before the given address is executed by the core. Your callback can have 3 parameters {{(addr, val, flags)}}. {{val}} is the value to be executed (or {{0}} always, if this feature is only partially implemented).")]
public string OnBusExec(
LuaFunction luaf,
uint address,
@ -145,7 +145,7 @@ namespace BizHawk.Client.Common
}
[LuaDeprecatedMethod]
[LuaMethod("onmemoryexecuteany", "Fires immediately before any address is executed by the core (CPU-intensive)")]
[LuaMethod("onmemoryexecuteany", "Fires immediately before every instruction executed (in the specified scope) by the core (CPU-intensive). Your callback can have 3 parameters {{(addr, val, flags)}}. {{val}} is the value to be executed (or {{0}} always, if this feature is only partially implemented).")]
public string OnMemoryExecuteAny(
LuaFunction luaf,
string name = null,
@ -155,8 +155,8 @@ namespace BizHawk.Client.Common
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 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 immediately before every instruction executed (in the specified scope) by the core (CPU-intensive)")]
[LuaMethodExample("local exec_cb_id = event.on_bus_exec_any(\r\n\tfunction(addr, val, flags)\r\n\t\tconsole.log( \"Fires immediately before every instruction executed (in the specified scope) by the core (CPU-intensive). {{val}} is the value to be executed (or {{0}} always, if this feature is only partially implemented).\" );\r\n\tend\r\n\t, \"Frame name\", \"System Bus\" );")]
[LuaMethod("on_bus_exec_any", "Fires immediately before every instruction executed (in the specified scope) by the core (CPU-intensive). Your callback can have 3 parameters {{(addr, val, flags)}}. {{val}} is the value to be executed (or {{0}} always, if this feature is only partially implemented).")]
public string OnBusExecAny(
LuaFunction luaf,
string name = null,
@ -195,7 +195,7 @@ namespace BizHawk.Client.Common
}
[LuaDeprecatedMethod]
[LuaMethod("onmemoryread", "Fires after the given address is read by the core. If no address is given, it will attach to every memory read")]
[LuaMethod("onmemoryread", "Fires immediately before the given address is read by the core. Your callback can have 3 parameters {{(addr, val, flags)}}. {{val}} is the value read. If no address is given, it will fire on every memory read.")]
public string OnMemoryRead(
LuaFunction luaf,
uint? address = null,
@ -206,8 +206,8 @@ namespace BizHawk.Client.Common
return OnBusRead(luaf, address, name: name, scope: scope);
}
[LuaMethodExample("local exec_cb_id = event.on_bus_read(\r\n\tfunction()\r\n\t\tconsole.log( \"Fires after the given address is read by the core. If no address is given, it will attach to every memory read\" );\r\n\tend\r\n\t, 0x200, \"Frame name\" );")]
[LuaMethod("on_bus_read", "Fires after the given address is read by the core. If no address is given, it will attach to every memory read")]
[LuaMethodExample("local exec_cb_id = event.on_bus_read(\r\n\tfunction(addr, val, flags)\r\n\t\tconsole.log( \"Fires immediately before the given address is read by the core. {{val}} is the value read. If no address is given, it will fire on every memory read.\" );\r\n\tend\r\n\t, 0x200, \"Frame name\" );")]
[LuaMethod("on_bus_read", "Fires immediately before the given address is read by the core. Your callback can have 3 parameters {{(addr, val, flags)}}. {{val}} is the value read. If no address is given, it will fire on every memory read.")]
public string OnBusRead(
LuaFunction luaf,
uint? address = null,
@ -241,7 +241,7 @@ namespace BizHawk.Client.Common
}
[LuaDeprecatedMethod]
[LuaMethod("onmemorywrite", "Fires after the given address is written by the core. If no address is given, it will attach to every memory write")]
[LuaMethod("onmemorywrite", "Fires immediately before the given address is written by the core. Your callback can have 3 parameters {{(addr, val, flags)}}. {{val}} is the value to be written (or {{0}} always, if this feature is only partially implemented). If no address is given, it will fire on every memory write.")]
public string OnMemoryWrite(
LuaFunction luaf,
uint? address = null,
@ -252,8 +252,8 @@ namespace BizHawk.Client.Common
return OnBusWrite(luaf, address, name: name, scope: scope);
}
[LuaMethodExample("local exec_cb_id = event.on_bus_write(\r\n\tfunction()\r\n\t\tconsole.log( \"Fires after the given address is written by the core. If no address is given, it will attach to every memory write\" );\r\n\tend\r\n\t, 0x200, \"Frame name\" );")]
[LuaMethod("on_bus_write", "Fires after the given address is written by the core. If no address is given, it will attach to every memory write")]
[LuaMethodExample("local exec_cb_id = event.on_bus_write(\r\n\tfunction(addr, val, flags)\r\n\t\tconsole.log( \"Fires immediately before the given address is written by the core. {{val}} is the value to be written (or {{0}} always, if this feature is only partially implemented). If no address is given, it will fire on every memory write.\" );\r\n\tend\r\n\t, 0x200, \"Frame name\" );")]
[LuaMethod("on_bus_write", "Fires immediately before the given address is written by the core. Your callback can have 3 parameters {{(addr, val, flags)}}. {{val}} is the value to be written (or {{0}} always, if this feature is only partially implemented). If no address is given, it will fire on every memory write.")]
public string OnBusWrite(
LuaFunction luaf,
uint? address = null,

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

@ -5,7 +5,7 @@ using System.Collections.Generic;
namespace BizHawk.Emulation.Common
{
/// <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>
public delegate void MemoryCallbackDelegate(uint address, uint value, uint flags);
/// <summary>
@ -99,11 +99,15 @@ namespace BizHawk.Emulation.Common
/// This service defines a memory callback used by an IMemoryCallbackSystem implementation
/// </summary>
/// <seealso cref="IMemoryCallbackSystem"/>
/// <seealso cref="MemoryCallbackDelegate"/>
public interface IMemoryCallback
{
MemoryCallbackType Type { get; }
string Name { get; }
/// <seealso cref="MemoryCallbackDelegate"/>
MemoryCallbackDelegate Callback { get; }
uint? Address { get; }
uint? AddressMask { get; }
string Scope { get; }