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

Minor corrections to newly-added Lua documentation 

fixes 1452f831a, 82c3b471a, b687dea1b, 49cd836e1
This commit is contained in:
YoshiRulz 2022-12-09 05:23:49 +10:00
parent 49cd836e18
commit 5c0143d6f6
No known key found for this signature in database
GPG Key ID: C4DE31C245353FB7
2 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -18,6 +18,8 @@ namespace BizHawk.Client.Common
.AppendLine()
.AppendLine("As you might expect, Lua scripts execute top to bottom once, so to run something every frame you'll need to end the script with an infinite loop (or you could set a callback on one of the events instead). Make sure to call {{emu.frameadvance}} or {{emu.yield}} in the loop or your script will hang EmuHawk and then crash!")
.AppendLine()
.AppendLine("Lua supports integer arithmetic starting with BizHawk 2.9. Note {{~}} is both bitwise NOT and XOR. Some of the {{bit}} helper functions remain, but you should try to avoid them if you need performance (or [https://github.com/TASEmulators/BizHawk-ExternalTools/wiki|switch to .NET]).")
.AppendLine()
.AppendLine("FCEUX users: While this API surface may look similar, even functions with the same name may take different arguments, or behave differently in a way that isn't immediately obvious.")
.AppendLine()
.AppendLine(@"__Types and notation__
@ -48,7 +50,7 @@ namespace BizHawk.Client.Common
.AppendLine()
.AppendLine(@"__Common parameter meanings__
* {{ulong addr}}/{{long addr}}/{{uint addr}}/{{int addr}} in memory functions
** Relative to the specified domain (or the ""current"" domain, see above).
** Relative to the specified domain (or the ""current"" domain, see below).
** Some memory events allow {{nil}} for the address. That will hook on all addresses.
* {{string domain}} in memory functions
** The name of a memory domain. The list of valid domains is returned by {{memory.getmemorydomainlist}}, or can be seen in various tools such as the Hex Editor.
@ -67,8 +69,8 @@ namespace BizHawk.Client.Common
** If you pass {{nil}} or omit the argument, the ""current"" surface is used. This can be set with {{gui.use_surface}}.
* other {{string}} parameters in drawing functions
** See the relevant function's documentation.
* {{int handle}} in forms functions
** These handles are returned by {{forms.newform}} and the various control creation functions such as {{forms.checkbox}}.
* {{long handle}} in forms functions
** These handles are returned by {{forms.newform}} and the various control creation functions such as {{forms.checkbox}}. Do not attempt to re-use them across script restarts or do arithmetic with them.
* {{string guid}}/{{string name}} in event functions
** The ''name'' of a callback is an optional parameter in all the event subscription functions. The ''ID'' of a callback is what's returned by the subscription function. Multiple callbacks can share the same name, but IDs are unique.
");

8
src/BizHawk.Client.Common/lua/LuaHelperLibs/BitLuaLibrary.cs
View File

@ -27,13 +27,13 @@ namespace BizHawk.Client.Common
[LuaMethod("bnot", "Bitwise NOT of 'val'")]
public uint Bnot(uint val)
{
Log("Using bit.bnot is deprecated, use the ~ operator instead.");
Log("Using bit.bnot is deprecated, use the ~a operator instead.");
return ~val;
}
[LuaDeprecatedMethod]
[LuaMethodExample("local uibitbor = bit.bor( 1000, 4 );")]
[LuaMethod("bor", "Bitwise OR of 'val' against 'amt'.")]
[LuaMethod("bor", "Bitwise OR of 'val' against 'amt'")]
public uint Bor(uint val, uint amt)
{
Log("Using bit.bor is deprecated, use the | operator instead.");
@ -45,7 +45,7 @@ namespace BizHawk.Client.Common
[LuaMethod("bxor", "Bitwise XOR of 'val' against 'amt'")]
public uint Bxor(uint val, uint amt)
{
Log("Using bit.bxor is deprecated, use the ~ operator instead.");
Log("Using bit.bxor is deprecated, use the a ~ b operator instead.");
return val ^ amt;
}
@ -120,7 +120,7 @@ namespace BizHawk.Client.Common
=> BinaryPrimitives.ReverseEndianness(val);
[LuaMethodExample("local ulbitbyt = bit.byteswap_64( 10000 );")]
[LuaMethod("byteswap_64", "Byte swaps 'long' (NOTE: You may get unexpected results for large numbers! In current Lua engines, all numbers are double-precision floating-point, even if you intended to use integers.)")]
[LuaMethod("byteswap_64", "Byte swaps 'long'")]
public static ulong Byteswap64(ulong val)
=> BinaryPrimitives.ReverseEndianness(val);
}