Super Hotkeys
version 0.49
by SkyRanger-1

Forum thread: http://www.gamesas.com/bgsforums/index.php?showtopic=949637

tesnexus download: none yet

This mod requires OBSE version 16 or later. OBSE can be obtained here:
http://obse.silverlock.org/


=============================================
Section 1: Overview
=============================================

This mod extends the vanilla hotkey wheel in two general ways:
1. It adds new hotkey wheels, accessable by holding down modifier keys.
2. Slots in hotkey wheels can be marked as being special hotkeys. Special hotkeys have similar interfaces to the vanilla hotkeys, but can do a variety of different things like cycling you between weapons, or storing an entire outfit instead of a single item, or switching to a spell and casting it and then switching back to your original spell.


=============================================
Section 2: General Interface
=============================================

The general interface at this point is this:

2.1. It mostly works like regular hotkeys. You press the number and click on the item/spell to bind the key. Pressing and holding the number will cause the wheel to appear, showing you how the keys are currently configured.

2.2. Modifier keys allow you to switch between multiple wheels, similar to Improved Hotkeys. In the default configuration, pressing left-shift will switch you to an alternate wheel of hotkeys, pressing left-alt will switch you to another, and pressing left-shift and left-alt at the same time will switch you to a 3rd wheel of hotkeys, for a total of 4 wheels including the default wheel used when no modifiers are pressed.

2.3. To create a special hotkey, go to the stats menu and press the hotkey (plus optional modifier keys). A menu will come up asking you what type you want that hotkey to be.
Note: Some hotkey types have additional configuration options that can only be accessed by first setting the type of the hotkey, and then accessing this menu again and setting the type to the same thing it already was.

2.4. Now that slot in the hotkey wheel is occupied by a special hotkey of the type you chose. To change it back to a normal hotkey, repeat step 3 and select normal hotkey from the menu.

2.5. The process for configuring the special hotkey depends upon the type of special hotkey, but it generally involves binding items or spells to the hotkey by holding down the hotkey in the inventory or magic menu and clicking on one or more spells or items you want bound to it. In most cases you have to hold the hotkey down until you have finished binding all items.

The hotkey types are:

Normal Hotkey: These work just like in vanilla.
Cycler Hotkey: Used to cycle through a set of weapons or spells.
Gear-Set Hotkey: Used to equip an entire outfit at once.
AutoCast Hotkey: Used to cast a spell or sequence of spells automatically while still keeping your current spell selected.

For more details see section 3.


=============================================
Section 3: Special Hotkey Types
=============================================


Current hotkey types include Normal, Cycler, Gear-Set, Auto-Cast, and Dynamic Cycler.

3.0 Normal Hotkeys
The default hotkey type. Works just like a vanilla hotkey. That's because it IS a vanilla hotkey. All other hotkeys types are collectively referred to as "special hotkey types".

3.1 Cycler Hotkeys
Bind the Cycler Hotkey to each item you want it to cycle through, in order, without lifting the hotkey until all items have been bound. Configuration is now done, but can be repeated at any time. Each Cycler Hotkey remembers a position in the cycle. The position starts out as the first item in the cycle. Each time the hotkey is pressed, it will equip the item in the current position (or select the spell in the current position) and then switch to the next position.

3.2.0 Gear-Set Hotkeys, Mode 0 (default)
Bind the Gear-Set Hotkey to each item you want it to equip or unequip, without lifting the hotkey until all items have been bound. Configuration is now done, but can be repeated at any time. This will unequip any armor, clothing, jewelry, shield, or torch that is not part of the set.

In order to switch a Gear-Set hotkey between normal mode and alternate mode, go to the stats menu and press the hotkey for your Gear-Set. When prompted for what type you want to change it to, select Gear-Set. This will cause a menu to pop up offering you the option of switching to the alternate mode.

3.2.1 Gear-Set Hotkeys, Mode 1
To configure a Gear-Set Hotkey that is in mode 1, equip every item you want the Gear-Set Hotkey to equip, and unequip every item you want it to unequip. Bind the Gear-Set Hotkey to each item you want it to equip or unequip, without lifting the hotkey until all items have been bound. Configuration is now done, but can be repeated at any time. Now when you use the gear-set key it should equip and unequip items appropriately.

3.2.2 Gear-Set Hotkeys, Mode 2
As for mode 0 above, except that weapons and ammo are unequipped just like clothing.

3.2.3 Gear-Set Hotkeys, Mode 3
This gear-set mod equips everything in the set and unequip nothing (though the act of equipping some things may force items occupying the same slots to be unequipped).

3.3 Auto-Cast
Bind the spells you want this hotkey to cast, without lifting the hotkey until all spells have been bound. Configuration is now done, but can be repeated at any time. Now when you use this hotkey, your character should cast the bound spell in order as if you were switching to them and casting them sequentially. You can modify your currently set spell without interfering with the process or being interfered with by the process. You can press additional Cast Hotkeys, the spells they cast will be queued up. You can abort the sequence at any time by pressing the cast key, though if a spell had already started casting then that spell will complete before it aborts.

3.4 Dynamic Cycler
BE WARNED.
This hotkey type is difficult to understand and configure properly.
Go to the inventory or spell menu. Bind the Dynamic Cycler Hotkey to each item you want it to cycle through, in order, without lifting the hotkey until all items have been bound. Configuration is now done, but can be repeated at any time. If you have one item from the cycle selected (and it is only in the cycle once) then using the hotkey should cause you to equip the next item in the cycle (not necessarily unequiping the previous item, if it did not occupy the same slot). The same is true for spells. If you have no items or spells from the cycle equipped then it will cause you to equip the first item from the cycle. If you have multiple items (or a spell and one or more items) from the cycle equipped, or if the cycle includes some items or spells more than once, then the behavior is more complicated but still consistent. Specifically, it will cause you to equip every item that comes immediately after an item in the cycle that you currently have equipped. Your active spell counts as equipped. If you have none of the items in the cycle equiped, then it will equip the first item in the cycle. Note that if this causes multiple scripted items to be equiped from a single keypress then only one of those items will avoid the OnEquip issue in the current version.

Potion Selector/Drinker: A Potion Drinker Hotkey will make you drink one of the selected potion type whenever you press it. The "selected" potion type in this case means the potion type bound to the most recently pressed Potion Selector Hotkey. To make a Potion Selector Hotkey, simply make a Potion Drinker Hotkey and then bind it to a potion type.

Planned but not yet implemented hotkey types include:

Gear-Set Cycler: Bind your Gear-Set Cycler Hotkey to your first set of gear, as for a Gear-Set Hotkey above. Then bind it to your second set of gear, as if you were replacing the original gear set. Repeat for each additional set of gear you want this hotkey to cycle through. Configuration is now done. When you use the Gear-Set Cycler Hotkey is should switch you to the next set of gear, as appropriate. Unlike some other hotkey types, you can not reconfigure by repeating the configuration process. If you want to reconfigure it, you have to reset it by selecting the hotkey type again from the stats menu.


=============================================
Section 4: .ini file configuration
=============================================

While hotkeys are generally configured in-game, modifier keys are configured from the .ini file. The options available from the .ini file are extensive, confusing, and difficult to explain.



=============================================
Section 5: Version History
=============================================

version 0.30: initial release
version 0.31: bug fix? or maybe I added gear keys? I forget
version 0.32: fixed handling of scripted inventory objects
version 0.35:
......added auto-cast hotkey type
......renamed the old cycler hotkeys to dynamic cycler hotkeys
......added new, simpler cycler hotkeys
......more stuff I've forgotten
version 0.36:
......changed cast hotkeys to support multiple spells in one hotkey
......changed name of cast keys to auto-cast keys
......improved handling of queued auto-cast spells
......fixed a couple bugs in auto-cast keys
......fixed bug when changing special hotkeys back to normal hotkeys
......fixed a bug that was preventing modifier keys from working properly
version 0.37:
......fixed issues with selecting the type of hotkeys with modifier keys
version 0.38:
......fixed an issue that was prevent the OnEquip stuff from working
......made modifier keys configurable from an ini file
......added 3 new types of modifier keys
version 0.39:
......improved behavior of auto-cast hotkeys
......added the ability to map a hotkey to an additional key
......changed the default behavior of gear-set hotkey, added menu to select behavior
version 0.40:
......removed spurious popups when viewing the stats menu immediately after starting a new game
version 0.41:
......added another mode for gear-sets
......possible fix for the continuous wheel spam bug
......added "cancel" button to hotkey type menu
version 0.42:
......fixed mode 2 for gear-sets
......added code to fix wheel number if it got messed up somehow
......fixed "cancel" button in hotkey type menu
version 0.43:
......fixed mode 2 for gear-sets, for real this time
......newly created gear-set hotkeys are now by default bound to the items you are wearing
......fixes bug introduced in .41 or .42 where going to the menus in the first few seconds after loading could make this mod go beserk
version 0.43, release 2:
......updates documentation somewhat, no other changes
version 0.44:
......fixes bug in gear-set type selection
......changes some hotkeys names to be more informative
version 0.45:
......fixes bug with multislot items not being unequiped properly in gear-sets
......fixed gear-set name updates
......misc. changes (ie stuff I've forgotten)
version 0.47:
......fixed issues with special hotkeys only equipping a single arrow
......reorganized some code, possibly other stuff I've forgotten
version 0.48:
......removed debugging script that gave player a test object
......added new hotkey type, the potion drinker/selector hotkey
......futzed with cycler hotkeys in hopes of fixing any problems in them
version 0.49:
......fixed a bug with equipping multiple arrows that could cause crashes on some computers
......fixed a bug with equipping scripted items that could cause hotkey 8 to be changed
......NOT INCLUDE: modified OBSE version now available, see below:

Modified OBSE version:
There is a modified version of OBSE 16 available from me. It seems to fix many of the problems that plague users of this mod. However, it is not a standard OBSE version, so until there is a standard OBSE version with these changes incorporated, care must be taken to avoid creating versioning problems for OBSE. If you want to test out this modified OBSE version, post in the forum thread or PM me on the official Bethesda forums, and I'll send you a link to the modified OBSE dll.


=============================================
Section 6: Plans
=============================================

Improve OnEquip handling
Fix up auto-cast hotkeys to work better with my big mod, Enhanced Magic System.
Support for hotkeys that are not part of wheels
Possibly add Pluggy HUD options for potion drinker/selector hotkeys.
Add additional options for mapping hotkeys to other keys.
Add Gear-Set Cycler Hotkey.
Add Toggle-Spell/Maintain-Spell Hotkey.

Gear: Equip every item you want the Gear Hotkey to equip, and unequip every item you want it to unequip. Bind the Gear Hotkey to each item you want it to equip or unequip, without lifting the hotkey until all items have been bound. Configuration is now done, but can be repeated at any time. Now when you use the gear key it should equip and unequip items appropriately.

The "Now when you use the gear key it should equip and unequip items appropriately" means that it will equip every item in the set that was equipped when you bound the hotkey, and unequip every item in the set that was not equipped when you bound the hotkey. The items in the set are the ones that you clicked on while holding down the hotkey.

Would renaming Gear Hotkeys to Gear-set Hotkeys (or somesuch thing) make it more likely for people to recognize it at a glance?

short test, not fully tested yet...
(snip)

Thank you. Version 0.36 up now. There's a new link, the top post will be updated to point at it in a second. Should fix all of those. Also, auto-cast keys can now hold multiple spells, and will auto-cast all of those in sequence. Auto-casting can be aborted by pressing the cast button (will finish the current spell and then stop).

Further note: It may require a clean save to switch to the update, not sure. Sorry about that

8. hotkey #1 wheel #0's icon changed to healing minor wounds' one from flare's <--- this should be minor glitch

what a quick update! grabbed .37 and tested...
All issues I mentioned seem to be solved. :icecream:

But I wonder why only a few ppl reporting bugs... :confused:
Please join this beta test and help skyranger if you want to use a super uber hotkey mod.
I swear that This mod will be an YET ANOTHER USEFUL HOTKEY MOD if it becomes bug-free. :swear:

well, I'm gonna keep testing this mod

I become more and more addicted to this mod every time I use these hotkey function...

Quick test:
0. Reverting back to Normal seems to work :goodjob:
1. Cycler seems to work :goodjob:
2. Gear-Set seems to work :goodjob: (It might be bit confusing to first-time users because you have to equip items before assiging them to Gear-Set keys.)
3. Auto-Cast seems to work :goodjob:
4. Dynamic Cycler isn't tested yet, sorry

There may be some oversights but it looks fine so far. I'l report back if I find anything that is not intended to work.

brief test for dynamic cycling...

Case1:
1. open stans menu and set key '1' to Dynamic Cycler
2. close stats menu
3. use '1' key (nothing is assigned)
4. CTD

Case2:
1. open stans menu and set key '1' to Dynamic Cycler
2. assign Weapon1, Weapon2, Weapon3, Armor1, Armor2, Armor3, Spell1, Spell2, Spell3 to key '1' which is a Dynamic Cycler Hotkey
3. keep cycling items for a while
4. in the meantime, cycling function stops to work

somehow I get the impression that you're making a reference to the recent release thread by that name.

for Case2, try this

1. open stans menu and set key '1' to Dynamic Cycler
2. switch to spell menu
3. hold '1' key and click Club, Iron Claymore, Iron Battle Axe, Iron Boots, Iron Curiass, Iron Gauntlets, Buoyance, Defend and Flare to assign
3. keep cycling items for a while (for me 10+ times cycling was enough)
4. in the meantime, cycling function stops to work and I can't switch weapon

I can reproduce this again and again

Case3:
1. I made a http://www.mediafire.com/?0nmz1mhwzzz which adds an Iron Mace that pops-up a message dialogue when you equip it. (OnEquip sciript)
2. script won't run if you assign this Iron Mace to Cycle, Gear-Set or Dynamic Cycler
3. script runs if you assign this Iron Mace to Normal

2. Gear-Set seems to work :goodjob: (It might be bit confusing to first-time users because you have to equip items before assiging them to Gear-Set keys.)

I meant to say this earlier but forgot:
I got annoyed long ago at some gear-set hotkey mod (I think it might have been JOGs Stealth Overhaul) that didn't let me specify what to unequip (I don't remember if it unequipped too much or too little), so I decided to allow that to be explicitly specified.
On the other hand, there's still a few ways an equip-only version could be handled:
1. The current version could be renamed, with the current name given to a new simpler implementation. That is exactly what happened with the original cycler keys... someone said they were counterintuitive or too complex or something, so it got renamed and a simpler implementation was made for the original name.
2. A messagebox could prompt the user asking if they want the gear-set key to equip everything or equip some and unequip others. This could be done either when the gear-set key is first created (ie immediately after you click on "Gear-Set" in the hotkey type menu), or each time it is configured (ie when you lift the hotkey after clicking on some items in the inventory menu).