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

Add documentation to as many lua function as I can sanely do in one sitting

This commit is contained in:
adelikat 2014-01-26 18:36:27 +00:00
parent b1dc947794
commit 70feebf229
13 changed files with 181 additions and 203 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

64
BizHawk.Client.Common/lua/EmuLuaLibrary.Emu.cs
View File

@ -61,7 +61,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"displayvsync",
"TODO"
"Sets the display vsync property of the emulator"
)]
public static void DisplayVsync(object boolean)
{
@ -81,7 +81,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"frameadvance",
"TODO"
"Signals to the emulator to resume emulation. Necessary for any lua script while loop or else the emulator will freeze!"
)]
public void FrameAdvance()
{
@ -90,7 +90,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"framecount",
"TODO"
"Returns the current frame count"
)]
public static int FrameCount()
{
@ -99,7 +99,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"getregister",
"TODO"
"returns the value of a cpu register or flag specified by name. For a complete list of possible registers or flags for a given core, use getregisters"
)]
public static int GetRegister(string name)
{
@ -108,7 +108,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"getregisters",
"TODO"
"returns the complete set of available flags and registers for a given core"
)]
public LuaTable GetRegisters()
{
@ -123,7 +123,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"getsystemid",
"TODO"
"Returns the ID string of the current core loaded. Note: No ROM loaded will return the string NULL"
)]
public static string GetSystemId()
{
@ -132,7 +132,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"islagged",
"TODO"
"returns whether or not the current frame is a lag frame"
)]
public static bool IsLagged()
{
@ -141,7 +141,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"lagcount",
"TODO"
"Returns the current lag count"
)]
public static int LagCount()
{
@ -150,56 +150,34 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"limitframerate",
"TODO"
"sets the limit framerate property of the emulator"
)]
public static void LimitFramerate(object boolean)
public static void LimitFramerate(bool enabled)
{
var temp = boolean.ToString();
if (!String.IsNullOrWhiteSpace(temp))
{
if (temp == "0" || temp.ToLower() == "false")
{
Global.Config.ClockThrottle = false;
}
else
{
Global.Config.ClockThrottle = true;
}
}
Global.Config.ClockThrottle = enabled;
}
[LuaMethodAttributes(
"minimizeframeskip",
"TODO"
"Sets the autominimizeframeskip value of the emulator"
)]
public static void MinimizeFrameskip(object boolean)
public static void MinimizeFrameskip(bool enabled)
{
var temp = boolean.ToString();
if (!String.IsNullOrWhiteSpace(temp))
{
if (temp == "0" || temp.ToLower() == "false")
{
Global.Config.AutoMinimizeSkipping = false;
}
else
{
Global.Config.AutoMinimizeSkipping = true;
}
}
Global.Config.AutoMinimizeSkipping = enabled;
}
[LuaMethodAttributes(
"setrenderplanes",
"TODO"
"Toggles the drawing of sprites and background planes. Set to false or nil to disable a pane, anything else will draw them"
)]
public static void SetRenderPlanes( // For now, it accepts arguments up to 5.
object lua_p0,
object lua_p1 = null,
object lua_p2 = null,
object lua_p3 = null,
object lua_p4 = null)
object param0,
object param1 = null,
object param2 = null,
object param3 = null,
object param4 = null)
{
SetrenderplanesDo(LuaVarArgs(lua_p0, lua_p1, lua_p2, lua_p3, lua_p4));
SetrenderplanesDo(LuaVarArgs(param0, param1, param2, param3, param4));
}
[LuaMethodAttributes(

28
BizHawk.Client.Common/lua/EmuLuaLibrary.Events.cs
View File

@ -115,7 +115,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"onframeend",
"TODO"
"Calls the given lua function at the end of each frame, after all emulation and drawing has completed. Note: this is the default behavior of lua scripts"
)]
public string OnFrameEnd(LuaFunction luaf, string name = null)
{
@ -126,7 +126,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"onframestart",
"TODO"
"Calls the given lua function at the beginning of each frame before any emulation and drawing occurs"
)]
public string OnFrameStart(LuaFunction luaf, string name = null)
{
@ -137,7 +137,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"oninputpoll",
"TODO"
"Calls the given lua function after each time the emulator core polls for input"
)]
public void OnInputPoll(LuaFunction luaf, string name = null)
{
@ -148,7 +148,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"onloadstate",
"TODO"
"Fires after a state is loaded. Receives a lua function name, and registers it to the event immediately following a successful savestate event"
)]
public string OnLoadState(LuaFunction luaf, string name = null)
{
@ -159,7 +159,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"onmemoryexecute",
"TODO"
"Fires after the given address is executed by the core"
)]
public string OnMemoryExecute(LuaFunction luaf, object address, string name = null)
{
@ -171,31 +171,31 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"onmemoryread",
"TODO"
"Fires after the given address is read by the core. If no address is given, it will attach to every memory read"
)]
public string OnMemoryRead(LuaFunction luaf, object address = null, string name = null)
{
var nlf = new NamedLuaFunction(luaf, "OnMemoryRead", LogOutputCallback, CurrentThread, name);
_luaFunctions.Add(nlf);
Global.CoreComm.MemoryCallbackSystem.AddRead(nlf.Callback, (address != null ? LuaUInt(address) : (uint?)null));
Global.CoreComm.MemoryCallbackSystem.AddRead(nlf.Callback, address != null ? LuaUInt(address) : (uint?)null);
return nlf.Guid.ToString();
}
[LuaMethodAttributes(
"onmemorywrite",
"TODO"
"Fires after the given address is written by the core. If no address is given, it will attach to every memory write"
)]
public string OnMemoryWrite(LuaFunction luaf, object address = null, string name = null)
{
var nlf = new NamedLuaFunction(luaf, "OnMemoryWrite", LogOutputCallback, CurrentThread, name);
_luaFunctions.Add(nlf);
Global.CoreComm.MemoryCallbackSystem.AddWrite(nlf.Callback, (address != null ? LuaUInt(address) : (uint?)null));
Global.CoreComm.MemoryCallbackSystem.AddWrite(nlf.Callback, address != null ? LuaUInt(address) : (uint?)null);
return nlf.Guid.ToString();
}
[LuaMethodAttributes(
"onsavestate",
"TODO"
"Fires after a state is saved"
)]
public string OnSaveState(LuaFunction luaf, string name = null)
{
@ -206,7 +206,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"unregisterbyid",
"TODO"
"Removes the registered function that matches the guid. If a function is found and remove the function will return true. If unable to find a match, the function will return false."
)]
public bool UnregisterById(object guid)
{
@ -221,11 +221,11 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"unregisterbyname",
"TODO"
"Removes the first registered function that matches Name. If a function is found and remove the function will return true. If unable to find a match, the function will return false."
)]
public bool UnregisterByName(object name)
public bool UnregisterByName(string name)
{
foreach (var nlf in _luaFunctions.Where(nlf => nlf.Name == name.ToString()))
foreach (var nlf in _luaFunctions.Where(nlf => nlf.Name == name))
{
_luaFunctions.Remove(nlf);
return true;

8
BizHawk.Client.Common/lua/EmuLuaLibrary.Joypad.cs
View File

@ -16,7 +16,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"get",
"TODO"
"returns a lua table of the controller buttons pressed. If supplied, it will only return a table of buttons for the given controller"
)]
public LuaTable Get(object controller = null)
{
@ -54,7 +54,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"getimmediate",
"TODO"
"returns a lua table of any controller buttons currently pressed by the user"
)]
public LuaTable GetImmediate()
{
@ -69,7 +69,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"set",
"TODO"
"sets the given buttons to their provided values for the current frame"
)]
public void Set(LuaTable buttons, object controller = null)
{
@ -164,7 +164,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"setanalog",
"TODO"
"sets the given analog controls to their provided values for the current frame. Note that unlike set() there is only the logic of overriding with the given value."
)]
public void SetAnalog(LuaTable controls, object controller = null)
{

72
BizHawk.Client.Common/lua/EmuLuaLibrary.MainMemory.cs
View File

@ -98,7 +98,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"getname",
"TODO"
"returns the name of the domain defined as main memory for the given core"
)]
public string GetName()
{
@ -107,7 +107,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"readbyte",
"TODO"
"gets the value from the given address as an unsigned byte"
)]
public uint ReadByte(object addr)
{
@ -116,7 +116,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"readbyterange",
"TODO"
"Reads the address range that starts from address, and is length long. Returns the result into a table of key value pairs (where the address is the key)."
)]
public LuaTable ReadByteRange(object address, object length)
{
@ -136,7 +136,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"readfloat",
"TODO"
"Reads the given address as a 32-bit float value from the main memory domain with th e given endian"
)]
public float ReadFloat(object addr, bool bigendian)
{
@ -149,7 +149,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"writebyte",
"TODO"
"Writes the given value to the given address as an unsigned byte"
)]
public void WriteByte(object addr, object value)
{
@ -161,7 +161,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"writebyterange",
"TODO"
"Writes the given values to the given addresses as unsigned bytes"
)]
public void WriteByteRange(LuaTable memoryblock)
{
@ -176,7 +176,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"writefloat",
"TODO"
"Writes the given 32-bit float value to the given address and endian"
)]
public void WriteFloat(object address, object value, bool bigendian)
{
@ -188,7 +188,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"read_s8",
"TODO"
"read signed byte"
)]
public int ReadS8(object addr)
{
@ -197,7 +197,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"read_u8",
"TODO"
"read unsigned byte"
)]
public uint ReadU8(object addr)
{
@ -206,7 +206,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"read_s16_le",
"TODO"
"read signed 2 byte value, little endian"
)]
public int ReadS16Little(object addr)
{
@ -215,7 +215,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"read_s24_le",
"TODO"
"read signed 24 bit value, little endian"
)]
public int ReadS24Little(object addr)
{
@ -224,7 +224,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"read_s32_le",
"TODO"
"read signed 4 byte value, little endian"
)]
public int ReadS32Little(object addr)
{
@ -233,7 +233,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"read_u16_le",
"TODO"
"read unsigned 2 byte value, little endian"
)]
public uint ReadU16Little(object addr)
{
@ -241,8 +241,8 @@ namespace BizHawk.Client.Common
}
[LuaMethodAttributes(
"read_u16_le",
"TODO"
"read_u24_le",
"read unsigned 24 bit value, little endian"
)]
public uint ReadU24Little(object addr)
{
@ -251,7 +251,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"read_u32_le",
"TODO"
"read unsigned 4 byte value, little endian"
)]
public uint ReadU32Little(object addr)
{
@ -260,7 +260,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"read_s16_be",
"TODO"
"read signed 2 byte value, big endian"
)]
public int ReadS16Big(object addr)
{
@ -269,7 +269,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"read_s24_be",
"TODO"
"read signed 24 bit value, big endian"
)]
public int ReadS24Big(object addr)
{
@ -278,7 +278,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"read_s32_be",
"TODO"
"read signed 4 byte value, big endian"
)]
public int ReadS32Big(object addr)
{
@ -287,7 +287,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"read_u16_be",
"TODO"
"read unsigned 2 byte value, big endian"
)]
public uint ReadU16Big(object addr)
{
@ -296,7 +296,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"read_u24_be",
"TODO"
"read unsigned 24 bit value, big endian"
)]
public uint ReadU24Big(object addr)
{
@ -305,7 +305,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"read_u32_be",
"TODO"
"read unsigned 4 byte value, big endian"
)]
public uint ReadU32Big(object addr)
{
@ -314,7 +314,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"write_s8",
"TODO"
"write signed byte"
)]
public void WriteS8(object addr, object value)
{
@ -326,7 +326,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"write_u8",
"TODO"
"write unsigned byte"
)]
public void WriteU8(object addr, object value)
{
@ -338,7 +338,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"write_s16_le",
"TODO"
"write signed 2 byte value, little endian"
)]
public void WriteS16Little(object addr, object value)
{
@ -350,7 +350,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"write_s24_le",
"TODO"
"write signed 24 bit value, little endian"
)]
public void WriteS24Little(object addr, object value)
{
@ -362,7 +362,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"write_s32_le",
"TODO"
"write signed 4 byte value, little endian"
)]
public void WriteS32Little(object addr, object value)
{
@ -374,7 +374,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"write_u16_le",
"TODO"
"write unsigned 2 byte value, little endian"
)]
public void WriteU16Little(object addr, object value)
{
@ -386,7 +386,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"write_u24_le",
"TODO"
"write unsigned 24 bit value, little endian"
)]
public void WriteU24Little(object addr, object value)
{
@ -398,7 +398,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"write_u32_le",
"TODO"
"write unsigned 4 byte value, little endian"
)]
public void WriteU32Little(object addr, object value)
{
@ -410,7 +410,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"write_s16_be",
"TODO"
"write signed 2 byte value, big endian"
)]
public void WriteS16Big(object addr, object value)
{
@ -422,7 +422,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"write_s24_be",
"TODO"
"write signed 24 bit value, big endian"
)]
public void WriteS24Big(object addr, object value)
{
@ -434,7 +434,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"write_s32_be",
"TODO"
"write signed 4 byte value, big endian"
)]
public void WriteS32Big(object addr, object value)
{
@ -446,7 +446,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"write_u16_be",
"TODO"
"write unsigned 2 byte value, big endian"
)]
public void WriteU16Big(object addr, object value)
{
@ -458,7 +458,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"write_u24_be",
"TODO"
"write unsigned 24 bit value, big endian"
)]
public void WriteU24Big(object addr, object value)
{
@ -470,7 +470,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"write_u32_be",
"TODO"
"write unsigned 4 byte value, big endian"
)]
public void WriteU32Big(object addr, object value)
{

72
BizHawk.Client.Common/lua/EmuLuaLibrary.Memory.cs
View File

@ -91,7 +91,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"getmemorydomainlist",
"TODO"
"Returns a string of the memory domains for the loaded platform core. List will be a single string delimited by line feeds"
)]
public string GetMemoryDomainList()
{
@ -100,7 +100,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"getcurrentmemorydomain",
"TODO"
"Returns a string name of the current memory domain selected by Lua. The default is Main memory"
)]
public string GetCurrentMemoryDomain()
{
@ -109,7 +109,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"getcurrentmemorydomainsize",
"TODO"
"Returns the number of bytes of the current memory domain selected by Lua. The default is Main memory"
)]
public int GetCurrentMemoryDomainSize()
{
@ -118,7 +118,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"readbyte",
"TODO"
"gets the value from the given address as an unsigned byte"
)]
public uint ReadByte(object addr)
{
@ -127,7 +127,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"readfloat",
"TODO"
"Reads the given address as a 32-bit float value from the main memory domain with th e given endian"
)]
public float ReadFloat(object addr, bool bigendian)
{
@ -138,7 +138,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"writebyte",
"TODO"
"Writes the given value to the given address as an unsigned byte"
)]
public void WriteByte(object addr, object value)
{
@ -150,7 +150,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"writefloat",
"TODO"
"Writes the given 32-bit float value to the given address and endian"
)]
public void WriteFloat(object addr, object value, bool bigendian)
{
@ -162,7 +162,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"usememorydomain",
"TODO"
"Attempts to set the current memory domain to the given domain. If the name does not match a valid memory domain, the function returns false, else it returns true"
)]
public bool UseMemoryDomain(string domain)
{
@ -180,7 +180,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"read_s8",
"TODO"
"read signed byte"
)]
public int ReadS8(object addr)
{
@ -189,7 +189,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"read_u8",
"TODO"
"read unsigned byte"
)]
public uint ReadU8(object addr)
{
@ -198,7 +198,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"read_s16_le",
"TODO"
"read signed 2 byte value, little endian"
)]
public int ReadS16Little(object addr)
{
@ -207,7 +207,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"read_s24_le",
"TODO"
"read signed 24 bit value, little endian"
)]
public int ReadS24Little(object addr)
{
@ -216,7 +216,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"read_s32_le",
"TODO"
"read signed 4 byte value, little endian"
)]
public int ReadS32Little(object addr)
{
@ -225,7 +225,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"read_u16_le",
"TODO"
"read unsigned 2 byte value, little endian"
)]
public uint ReadU16Little(object addr)
{
@ -234,7 +234,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"read_u24_le",
"TODO"
"read unsigned 24 bit value, little endian"
)]
public uint ReadU24Little(object addr)
{
@ -243,7 +243,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"read_u32_le",
"TODO"
"read unsigned 4 byte value, little endian"
)]
public uint ReadU32Little(object addr)
{
@ -252,7 +252,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"read_s16_be",
"TODO"
"read signed 2 byte value, big endian"
)]
public int ReadS16Big(object addr)
{
@ -261,7 +261,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"read_s24_be",
"TODO"
"read signed 24 bit value, big endian"
)]
public int ReadS24Big(object addr)
{
@ -270,7 +270,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"read_s32_be",
"TODO"
"read signed 4 byte value, big endian"
)]
public int ReadS32Big(object addr)
{
@ -279,7 +279,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"read_u16_be",
"TODO"
"read unsigned 2 byte value, big endian"
)]
public uint ReadU16Big(object addr)
{
@ -288,7 +288,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"read_u24_be",
"TODO"
"read unsigned 24 bit value, big endian"
)]
public uint ReadU24Big(object addr)
{
@ -297,7 +297,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"u32_be",
"TODO"
"read unsigned 4 byte value, big endian"
)]
public uint ReadU32Big(object addr)
{
@ -306,7 +306,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"write_s8",
"TODO"
"write signed byte"
)]
public void WriteS8(object addr, object value)
{
@ -318,7 +318,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"write_s8",
"TODO"
"write unsigned byte"
)]
public void WriteU8(object addr, object value)
{
@ -330,7 +330,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"write_s16_le",
"TODO"
"write signed 2 byte value, little endian"
)]
public void WriteS16Little(object addr, object value)
{
@ -342,7 +342,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"write_s24_le",
"TODO"
"write signed 24 bit value, little endian"
)]
public void WriteS24Little(object addr, object value)
{
@ -354,7 +354,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"write_s32_le",
"TODO"
"write signed 4 byte value, little endian"
)]
public void WriteS32Little(object addr, object value)
{
@ -366,7 +366,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"write_u16_le",
"TODO"
"write unsigned 2 byte value, little endian"
)]
public void WriteU16Little(object addr, object value)
{
@ -378,7 +378,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"write_u24_le",
"TODO"
"write unsigned 24 bit value, little endian"
)]
public void WriteU24Little(object addr, object value)
{
@ -390,7 +390,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"write_u32_le",
"TODO"
"write unsigned 4 byte value, little endian"
)]
public void WriteU32Little(object addr, object value)
{
@ -402,7 +402,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"write_s16_be",
"TODO"
"write signed 2 byte value, big endian"
)]
public void WriteS16Big(object addr, object value)
{
@ -414,7 +414,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"write_s24_be",
"TODO"
"write signed 24 bit value, big endian"
)]
public void WriteS24Big(object addr, object value)
{
@ -426,7 +426,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"write_s32_be",
"TODO"
"write signed 4 byte value, big endian"
)]
public void WriteS32Big(object addr, object value)
{
@ -438,7 +438,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"write_u16_be",
"TODO"
"write unsigned 2 byte value, big endian"
)]
public void WriteU16Big(object addr, object value)
{
@ -450,7 +450,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"write_u24_be",
"TODO"
"write unsigned 24 bit value, big endian"
)]
public void WriteU24Big(object addr, object value)
{
@ -462,7 +462,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"write_u32_be",
"TODO"
"write unsigned 4 byte value, big endian"
)]
public void WriteU32Big(object addr, object value)
{

30
BizHawk.Client.Common/lua/EmuLuaLibrary.Movie.cs
View File

@ -15,7 +15,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"filename",
"TODO"
"Returns the file name including path of the currently loaded movie"
)]
public static string Filename()
{
@ -24,7 +24,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"getinput",
"TODO"
"Returns a table of buttons pressed on a given frame of the loaded movie"
)]
public LuaTable GetInput(object frame)
{
@ -45,7 +45,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"getreadonly",
"TODO"
"Returns true if the movie is in read-only mode, false if in read+write"
)]
public static bool GetReadOnly()
{
@ -54,7 +54,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"getrerecordcounting",
"TODO"
"Returns whether or not the current movie is incrementing rerecords on loadstate"
)]
public static bool GetRerecordCounting()
{
@ -63,7 +63,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"isloaded",
"TODO"
"Returns true if a movie is loaded in memory (play, record, or finished modes), false if not (inactive mode)"
)]
public static bool IsLoaded()
{
@ -72,7 +72,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"length",
"TODO"
"Returns the total number of frames of the loaded movie"
)]
public static double Length()
{
@ -81,7 +81,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"mode",
"TODO"
"Returns the mode of the current movie. Possible modes: PLAY, RECORD, FINISHED, INACTIVE"
)]
public static string Mode()
{
@ -105,7 +105,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"rerecordcount",
"TODO"
"Returns the current rerecord count for the loaded movie"
)]
public static string RerecordCount()
{
@ -114,25 +114,25 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"setreadonly",
"TODO"
"Sets the read-only state to the given value. true for read only, false for read+write"
)]
public static void SetReadOnly(object readonlyVal)
public static void SetReadOnly(bool readOnly)
{
Global.MovieSession.ReadOnly = readonlyVal.ToString().ToUpper() == "TRUE" || readonlyVal.ToString() == "1";
Global.MovieSession.ReadOnly = readOnly;
}
[LuaMethodAttributes(
"setrerecordcounting",
"TODO"
"Sets whether or not the current movie will increment the rerecord counter on loadstate"
)]
public static void SetRerecordCounting(object countVal)
public static void SetRerecordCounting(bool counting)
{
Global.MovieSession.Movie.IsCountingRerecords = countVal.ToString().ToUpper() == "TRUE" || countVal.ToString() == "1";
Global.MovieSession.Movie.IsCountingRerecords = counting;
}
[LuaMethodAttributes(
"stop",
"TODO"
"Stops the current movie"
)]
public static void Stop()
{

26
BizHawk.Client.Common/lua/EmuLuaLibrary.NES.cs
View File

@ -13,7 +13,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"addgamegenie",
"TODO"
"Adds the specified game genie code. If an NES game is not currently loaded or the code is not a valid game genie code, this will have no effect"
)]
public void AddGameGenie(string code)
{
@ -38,7 +38,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"getallowmorethaneightsprites",
"TODO"
"Gets the NES setting 'Allow more than 8 sprites per scanline' value"
)]
public static bool GetAllowMoreThanEightSprites()
{
@ -47,7 +47,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"getbottomscanline",
"TODO"
"Gets the current value for the bottom scanline value"
)]
public static int GetBottomScanline(bool pal = false)
{
@ -63,7 +63,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"getclipleftandright",
"TODO"
"Gets the current value for the Clip Left and Right sides option"
)]
public static bool GetClipLeftAndRight()
{
@ -72,7 +72,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"getdispbackground",
"TODO"
"Indicates whether or not the bg layer is being displayed"
)]
public static bool GetDisplayBackground()
{
@ -81,7 +81,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"getdispsprites",
"TODO"
"Indicates whether or not sprites are being displayed"
)]
public static bool GetDisplaySprites()
{
@ -90,7 +90,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"gettopscanline",
"TODO"
"Gets the current value for the top scanline value"
)]
public static int GetTopScanline(bool pal = false)
{
@ -106,7 +106,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"removegamegenie",
"TODO"
"Removes the specified game genie code. If an NES game is not currently loaded or the code is not a valid game genie code, this will have no effect"
)]
public void RemoveGameGenie(string code)
{
@ -121,7 +121,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"setallowmorethaneightsprites",
"TODO"
"Sets the NES setting 'Allow more than 8 sprites per scanline'"
)]
public static void SetAllowMoreThanEightSprites(bool allow)
{
@ -135,7 +135,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"setclipleftandright",
"TODO"
"Sets the Clip Left and Right sides option"
)]
public static void SetClipLeftAndRight(bool leftandright)
{
@ -149,7 +149,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"setdispbackground",
"TODO"
"Sets whether or not the background layer will be displayed"
)]
public static void SetDisplayBackground(bool show)
{
@ -163,7 +163,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"setdispsprites",
"TODO"
"Sets whether or not sprites will be displayed"
)]
public static void SetDisplaySprites(bool show)
{
@ -177,7 +177,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"setscanlines",
"TODO"
"sets the top and bottom scanlines to be drawn (same values as in the graphics options dialog). Top must be in the range of 0 to 127, bottom must be between 128 and 239"
)]
public static void SetScanlines(object top, object bottom, bool pal = false)
{

32
BizHawk.Client.Common/lua/EmuLuaLibrary.SNES.cs
View File

@ -8,7 +8,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"getlayer_bg_1",
"TODO"
"Returns whether the bg 1 layer is displayed"
)]
public static bool GetLayerBg1()
{
@ -17,7 +17,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"getlayer_bg_2",
"TODO"
"Returns whether the bg 2 layer is displayed"
)]
public static bool GetLayerBg2()
{
@ -26,7 +26,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"getlayer_bg_3",
"TODO"
"Returns whether the bg 3 layer is displayed"
)]
public static bool GetLayerBg3()
{
@ -35,7 +35,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"getlayer_bg_4",
"TODO"
"Returns whether the bg 4 layer is displayed"
)]
public static bool GetLayerBg4()
{
@ -44,7 +44,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"getlayer_obj_1",
"TODO"
"Returns whether the obj 1 layer is displayed"
)]
public static bool GetLayerObj1()
{
@ -53,7 +53,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"getlayer_obj_2",
"TODO"
"Returns whether the obj 2 layer is displayed"
)]
public static bool GetLayerObj2()
{
@ -62,7 +62,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"getlayer_obj_3",
"TODO"
"Returns whether the obj 3 layer is displayed"
)]
public static bool GetLayerObj3()
{
@ -71,7 +71,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"getlayer_obj_4",
"TODO"
"Returns whether the obj 4 layer is displayed"
)]
public static bool GetLayerObj4()
{
@ -80,7 +80,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"setlayer_bg_1",
"TODO"
"Sets whether the bg 1 layer is displayed"
)]
public static void SetLayerBg1(bool value)
{
@ -94,7 +94,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"setlayer_bg_2",
"TODO"
"Sets whether the bg 2 layer is displayed"
)]
public static void SetLayerBg2(bool value)
{
@ -108,7 +108,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"setlayer_bg_3",
"TODO"
"Sets whether the bg 3 layer is displayed"
)]
public static void SetLayerBg3(bool value)
{
@ -122,7 +122,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"setlayer_bg_4",
"TODO"
"Sets whether the bg 4 layer is displayed"
)]
public static void SetLayerBg4(bool value)
{
@ -136,7 +136,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"setlayer_obj_1",
"TODO"
"Sets whether the obj 1 layer is displayed"
)]
public static void SetLayerObj1(bool value)
{
@ -150,7 +150,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"setlayer_obj_2",
"TODO"
"Sets whether the obj 2 layer is displayed"
)]
public static void SetLayerObj2(bool value)
{
@ -164,7 +164,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"setlayer_obj_3",
"TODO"
"Sets whether the obj 3 layer is displayed"
)]
public static void SetLayerObj3(bool value)
{
@ -178,7 +178,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"setlayer_obj_4",
"TODO"
"Sets whether the obj 4 layer is displayed"
)]
public static void SetLayerObj4(bool value)
{

24
BizHawk.Client.Common/lua/EmuLuaLibrary.String.cs
View File

@ -7,7 +7,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"hex",
"TODO"
"Converts the number to a string representation of the hexadecimal value of the given number"
)]
public static string Hex(object num)
{
@ -22,7 +22,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"binary",
"TODO"
"Converts the number to a string representation of the binary value of the given number"
)]
public static string Binary(object num)
{
@ -33,7 +33,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"octal",
"TODO"
"Converts the number to a string representation of the octal value of the given number"
)]
public static string Octal(object num)
{
@ -48,7 +48,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"trim",
"TODO"
"returns a string that trims whitespace on the left and right ends of the string"
)]
public static string Trim(string str)
{
@ -57,7 +57,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"replace",
"TODO"
"Returns a string that replaces all occurances of str2 in str1 with the value of replace"
)]
public static string Replace(string str, string str2, string replace)
{
@ -66,7 +66,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"toupper",
"TODO"
"Returns an uppercase version of the given string"
)]
public static string ToUpper(string str)
{
@ -75,7 +75,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"tolower",
"TODO"
"Returns an lowercase version of the given string"
)]
public static string ToLower(string str)
{
@ -84,7 +84,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"substring",
"TODO"
"Returns a string that represents a substring of str starting at position for the specified length"
)]
public static string SubString(string str, object position, object length)
{
@ -93,7 +93,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"remove",
"TODO"
"Returns a string that represents str with the given position and count removed"
)]
public static string Remove(string str, object position, object count)
{
@ -102,7 +102,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"contains",
"TODO"
"Returns whether or not str contains str2"
)]
public static bool Contains(string str, string str2)
{
@ -111,7 +111,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"startswith",
"TODO"
"Returns whether str starts with str2"
)]
public static bool StartsWith(string str, string str2)
{
@ -120,7 +120,7 @@ namespace BizHawk.Client.Common
[LuaMethodAttributes(
"endswith",
"TODO"
"Returns whether str ends wth str2"
)]
public static bool EndsWith(string str, string str2)
{

10
BizHawk.Client.EmuHawk/tools/Lua/Libraries/EmuLuaLibrary.Client.cs
View File

@ -36,7 +36,7 @@ namespace BizHawk.Client.EmuHawk
[LuaMethodAttributes(
"clearautohold",
"TODO"
"Clears all autohold keys"
)]
public void ClearAutohold()
{
@ -45,7 +45,7 @@ namespace BizHawk.Client.EmuHawk
[LuaMethodAttributes(
"closerom",
"TODO"
"Closes the loaded Rom"
)]
public static void CloseRom()
{
@ -54,7 +54,7 @@ namespace BizHawk.Client.EmuHawk
[LuaMethodAttributes(
"enablerewind",
"TODO"
"Sets whether or not the rewind feature is enabled"
)]
public static void EnableRewind(bool enabled)
{
@ -72,7 +72,7 @@ namespace BizHawk.Client.EmuHawk
[LuaMethodAttributes(
"frameskip",
"TODO"
"Sets the frame skip value of the client UI"
)]
public void FrameSkip(object numFrames)
{
@ -90,7 +90,7 @@ namespace BizHawk.Client.EmuHawk
[LuaMethodAttributes(
"getdisplayfilter",
"TODO"
"Gets the current display filter setting, possible values: 'None', 'x2SAI', 'SuperX2SAI', 'SuperEagle', 'Scanlines'"
)]
public string GetDisplayFilter()
{

6
BizHawk.Client.EmuHawk/tools/Lua/Libraries/EmuLuaLibrary.Console.cs
View File

@ -13,7 +13,7 @@ namespace BizHawk.Client.EmuHawk
[LuaMethodAttributes(
"clear",
"TODO"
"clears the output box of the Lua Console window"
)]
public static void Clear()
{
@ -22,7 +22,7 @@ namespace BizHawk.Client.EmuHawk
[LuaMethodAttributes(
"getluafunctionslist",
"TODO"
"returns a list of implemented functions"
)]
public static string GetLuaFunctionsList()
{
@ -37,7 +37,7 @@ namespace BizHawk.Client.EmuHawk
[LuaMethodAttributes(
"log",
"TODO"
"Outputs the given string to the output box on the Lua Console dialog. Note: Can accept a LuaTable"
)]
public static void Log(object output)
{

4
BizHawk.Client.EmuHawk/tools/Lua/Libraries/EmuLuaLibrary.Input.cs
View File

@ -19,7 +19,7 @@ namespace BizHawk.Client.EmuHawk
[LuaMethodAttributes(
"get",
"TODO"
"Returns a lua table of all the buttons the user is currently pressing on their keyboard and gamepads"
)]
public LuaTable Get()
{
@ -34,7 +34,7 @@ namespace BizHawk.Client.EmuHawk
[LuaMethodAttributes(
"getmouse",
"TODO"
"Returns a lua table of the mouse X/Y coordinates and button states. Table returns the values X, Y, Left, Middle, Right, XButton1, XButton2"
)]
public LuaTable GetMouse()
{

8
BizHawk.Client.EmuHawk/tools/Lua/Libraries/EmuLuaLibrary.Savestate.cs
View File

@ -9,7 +9,7 @@ namespace BizHawk.Client.EmuHawk
[LuaMethodAttributes(
"load",
"TODO"
"Loads a savestate with the given path"
)]
public void Load(string path)
{
@ -18,7 +18,7 @@ namespace BizHawk.Client.EmuHawk
[LuaMethodAttributes(
"loadslot",
"TODO"
"Loads the savestate at the given slot number (must be an integer between 0 and 9)"
)]
public void LoadSlot(object slotNum)
{
@ -32,7 +32,7 @@ namespace BizHawk.Client.EmuHawk
[LuaMethodAttributes(
"save",
"TODO"
"Saves a state at the given path"
)]
public void Save(string path)
{
@ -41,7 +41,7 @@ namespace BizHawk.Client.EmuHawk
[LuaMethodAttributes(
"saveslot",
"TODO"
"Saves a state at the given save slot (must be an integer between 0 and 9)"
)]
public void SaveSlot(object slotNum)
{