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

Expose `IInputApi.GetPressedAxes` to Lua, improve `input` lib docs

This commit is contained in:
James Groom 2023-11-17 13:27:53 +10:00 committed by GitHub
parent 8eef419c62
commit 63127695d4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/BizHawk.Client.Common/lua/CommonLibs/InputLuaLibrary.cs
View File

@ -12,15 +12,20 @@ namespace BizHawk.Client.Common
public override string Name => "input";
#pragma warning disable CS0612
[LuaMethodExample("local nlinpget = input.get( );")]
[LuaMethod("get", "Returns a lua table of all the buttons the user is currently pressing on their keyboard and gamepads\nAll buttons that are pressed have their key values set to true; all others remain nil.")]
[LuaMethodExample("local buttons_down = input.get();\nlocal is_b_down = buttons_down[\"B\"];\nif is_b_down and not was_b_down then console.writeline(\"B pressed\"); end\nwas_b_down = is_b_down;")]
[LuaMethod("get", "Returns a dict-like table of key/button names (of host). Only pressed buttons will appear (with a value of {{true}}); unpressed buttons are omitted. Includes gamepad axes ({{!axis.isNeutral}}, with sticks as 4 \"buttons\" suffixed {{\"Up\"}}/{{\"Down\"}}/{{\"Left\"}}/{{\"Right\"}}). Includes mouse buttons, but not axes (cursor position and wheel rotation). Unlike {{getmouse}}, these have the names {{\"WMouse L\"}}, {{\"WMouse R\"}}, {{\"WMouse C\"}}, {{\"WMouse 1\"}}, and {{\"WMouse 2\"}} for LMB, RMB, MMB, Mouse4, and Mouse5, respectively.")]
public LuaTable Get()
=> _th.DictToTable(APIs.Input.Get());
#pragma warning restore CS0612
[LuaMethodExample("local nlinpget = input.getmouse( );")]
[LuaMethodExample("local mouse_buttons_down = input.getmouse();\nlocal is_m3_down = mouse_buttons_down[\"Middle\"];\nif is_m3_down and not was_m3_down then console.writeline(\"M3 pressed\"); end\nwas_m3_down = is_m3_down;")]
[LuaMethod("getmouse", "Returns a lua table of the mouse X/Y coordinates and button states. Table keys are X, Y, Left, Middle, Right, XButton1, XButton2, Wheel.")]
public LuaTable GetMouse()
=> _th.DictToTable(APIs.Input.GetMouse());
[LuaMethodExample("local axis_values = input.get_pressed_axes();\nif axis_values[\"X1 RightThumbY Axis\"] < -8000 then console.writeline(\"LStick is down\"); end")]
[LuaMethod("get_pressed_axes", "Returns a dict-like table of (host) axis names and their state. Axes may not appear if they have never been seen with a value other than {{0}} (for example, if the gamepad has been set down on a table since launch, or if it was recently reconnected). Includes mouse cursor position axes, but not mouse wheel rotation. Unlike {{getmouse}}, these have the names {{\"WMouse X\"}} and {{\"WMouse Y\"}}.")]
public LuaTable GetPressedAxes()
=> _th.DictToTable(APIs.Input.GetPressedAxes());
}
}