[color=#66cc33][b]Fixed auto-updates again! Please re-download this version in order to enable auto-updates with your copy of HoldTheKey.[/b][/color]
Just a small tool for allowing modders to use held-keybinds more easily. There's only a few functions in this mod, but I kept having to duplicate them in every mod I made so I figured this would be easier.
Maybe something obvious already exists that does this, but I don't know of it/know how to use it, so there.
[b]Main Features:[/b]
[list]
[*]Can efficiently check for held keys every frame
[*]Compatible with [b]both BLT and SuperBLT.[/b]
[*]Check for held keys without iterating through all of BLT's stored keybinds every frame
[*]Also includes a copy of the mod "[url=https://modworkshop.net/mydownloads.php?action=view_down&did=21889]Keybind Restriction Removal[/url]" which can be disabled in the menu. [u][color=#ffcc33]Please remove your copy of Keybind Restriction Removal if you already have it installed![/color][/u]
[*][b][color=#ff3333]NEW:[/color] [/b]Allows unbinding of BLT keybinds by pressing "escape" while binding keys.
[/list]
Planned:
[*]Support for callbacks when a key is pressed or released (will require BeardLib)
If you want to mod stuff with this, check [url=https://github.com/offyerrocker/HoldTheKey]GitHub for the full documentation.[/url]
Submit a pull request to replace my crappy code with your less-crappy code, if you want.
If you're doing mod things and you'd like a particular feature, message me or comment here, and maybe I can add that feature to this mod.
[hr]
If you encounter a bug, please report it below and attach any crash log associated with it, and I'll fix it ASAP.
If you need help with any of my mods, please contact me via Discord or reddit.
[b]27 Dec 2020[/b] v1.42
- Fixed broken localization but again
[b]26 Dec 2020[/b] v1.41
- Fixed broken localization
[b]21 Dec 2020[/b] v1.4
- Re-enabled multi-keybinds
- Added BeardLib localization and auto-update support
[b]8 Nov 2019[/b] v1.35
- Code improvements
* SuperBLT's v1.1.6.0 update allows you to un-bind mod keybinds by pressing [font=Courier New]Esc[/font]. Users are strongly advised to update SuperBLT, or switch from BLT to SuperBLT. Link: [url=https://superblt.znix.xyz/]https://superblt.znix.xyz/[/url]
* As such, it is no longer necessary to completely override the function MenuNodeGUI._key_press() for SuperBLT users. BLT users should either switch to SuperBLT, or re-enable this functionality of HoldTheKey by re-enabling the hooks marked "DISABLED_" in mod.txt.
[b]21 May 2019[/b] v1.34
- Re-enabled auto-updates after v1.33. This should fix any issues with Tactical Lean or other mods which require HoldTheKey being disabled.
[b]5 May 2019[/b] v1.33
- Added checking for mouse wheel up/down (which was previously missing) in order to support [url=http://modwork.shop/24768]"Mouse Wheel to Switch Weapon."[/url]
- Temporarily disabled auto-updates due to a problem with paydaymods
[b]21 Sep 2018[/b] v1.32
- Fixed crashing when checking if chat is open for Keybind_Held() and Key_Held()
[b]19 Aug 2018[/b] v1.31
- Fixed HTK sometimes refusing to register a keybind, causing constant "bad keybind" error in console
- Fixed crash on restart caused by hud chat focus check
[b]29 May 2018[/b] v1.3
- Fixed bad keybind detection if you booted up the game without having an HTK key already bound. (Previously, this required a game restart after binding the key; this will now properly update your key detection after binding a BLT keybind, for the first time or otherwise.)
- Added the ability to unbind BLT keybinds by pressing "escape" during the bind selection sequence.
- Fixed spamming the logs (and causing terrible performance) with bad/unbound HTK keybinds.
[b]6 April 2018[/b] v1.21
- Prevented held keybind checks from succeeding if the chat panel is open. I can add a function back in which ignores chat panel, if needed, but I can't think of any use cases for it right now.
[b]4 April 2018[/b] v1.2
- Fixed not updating held keybinds until game restart
[b]3 April 2018[/b] v1.1
- Fixed sometimes not storing the keybind if there were too many other keybinds (ie if the player had too many other mods with keybinds)
[b]1 April 2018[/b] v1.0
Released.
Dependencies
-
Instructions
**Make sure to first have SuperBLT installed. Click the link in the dependency list.**
Optional video tutorial for installing SuperBLT, BeardLib, and mod_overrides mods: https://youtu.be/rin_sjSJIkg
1. After downloading the mod, use a program such as [7zip](https://www.7-zip.org/download.html) or [WinRAR](https://www.rarlab.com/download.htm) to extract the main folder of the mod.
2. Drop that folder into the `mods` folder which is supposed to be in the game's installation folder (don't know where that is? click [here](https://wiki.modworkshop.net/books/payday-2/page/finding-payday-2s-install-folder))
Comments