Super Hotkeys

version 0.54
by SkyRanger-1
Forum thread: http://www.bethsoft.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 hotk
eys have similar interfaces to the vanilla hotkeys, but can do a variety of diff
erent things like cycling you between weapons, or storing an entire outfit inste
ad of a single item, or switching to a spell and casting it and then switching b
ack to your original spell.

=============================================
Section 2: Installation
=============================================
Put the esp and ini files in your Oblivion\Data directory. Enable the esp.

=============================================
Section 3: 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 t
he item/spell to bind the key. Pressing and holding the number will cause the w
heel to appear, showing you how the keys are currently configured.
2.2. Modifier keys allow you to switch between multiple wheels, similar to Impr
oved 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 (plu
s optional modifier keys). A menu will come up asking you what type you want th
at hotkey to be.
Note: Some hotkey types have additional configuration options that can only be a
ccessed by first setting the type of the hotkey, and then accessing this menu ag
ain 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 t
ype you chose. To change it back to a normal hotkey, repeat step 3 and select n
ormal hotkey from the menu.
2.5. The process for configuring the special hotkey depends upon the type of sp
ecial 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 m
ore spells or items you want bound to it. In most cases you have to hold the ho
tkey 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 4: Special Hotkey Types
=============================================

Current hotkey types include Normal, Cycler, Gear-Set, Auto-Cast, and Dynamic Cy
cler.
4.0 Normal Hotkeys
The default hotkey type. Works just like a vanilla hotkey. That's because it I
S a vanilla hotkey. All other hotkeys types are collectively referred to as "sp
ecial hotkey types".
4.1 Cycler Hotkeys
Bind the Cycler Hotkey to each item you want it to cycle through, in order, with
out lifting the hotkey until all items have been bound. Configuration is now do
ne, 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.
4.2.0 Gear-Set Hotkeys, Mode 0 (default)
Bind the Gear-Set Hotkey to each item you want it to equip or unequip, without l
ifting the hotkey until all items have been bound. Configuration is now done, b
ut 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 wha
t 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.
4.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 t
he 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.
4.2.2 Gear-Set Hotkeys, Mode 2
As for mode 0 above, except that weapons and ammo are unequipped just like cloth
ing.
4.2.3 Gear-Set Hotkeys, Mode 3
This gear-set mod equips everything in the set and unequip nothing (though the a
ct of equipping some things may force items occupying the same slots to be unequ
ipped).
4.3 Auto-Cast
Bind the spells you want this hotkey to cast, without lifting the hotkey until a
ll spells have been bound. Configuration is now done, but can be repeated at an
y 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 c
an modify your currently set spell without interfering with the process or being
interfered with by the process. You can press additional Cast Hotkeys, the spe
lls they cast will be queued up. You can abort the sequence at any time by pres
sing the cast key, though if a spell had already started casting then that spell
will complete before it aborts.
4.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 ite
ms 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 (no
t 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 eq
uipped then it will cause you to equip the first item from the cycle. If you ha
ve 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 equi
p every item that comes immediately after an item in the cycle that you currentl
y 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. No
te that if this causes multiple scripted items to be equiped from a single keypr
ess then only one of those items will avoid the OnEquip issue in the current ver
sion.
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 Ho
tkey. 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 yo
u 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 app
ropriate. 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 5: .ini file configuration
=============================================
While hotkeys are generally configured in-game, modifier keys are configured fro
m the .ini file. The options available from the .ini file are extensive, confus
ing, and difficult to explain.

=============================================
Section 6: 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 beha
vior
version 0.40:
......removed spurious popups when viewing the stats menu immediately after star
ting 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 a
re wearing
......fixes bug introduced in .41 or .42 where going to the menus in the first f
ew 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 som
e computers
......fixed a bug with equipping scripted items that could cause hotkey 8 to be
changed
......NOT INCLUDED: modified OBSE version now available, see below:
version 0.50:
......changed/fixed how some of the icons are handled
......permit potion selectors to be bound to multiple potions and cycle
......made poisons on special hotkeys not prompt for confirmation
version 0.51:
......fixed (I hope) potion drinker/selector/cycler
version 0.52:
......fixed some issues with auto-cast hotkeys
......allowed console messages to be turned off "set srHotkey.hide_debug_message
s to 1" in the ini file
version 0.53:
......fixed some issues with hotkeys while on horses
version 0.54:
......disabled the fancy stuff with arrow equipping; it was intended to make the
correct number of arrows appear in sheaths, but it was sometimes destroying the
players arrows

=============================================
Section 7: 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.

- For base saddles:

Set MDSBTraders.Version to 0
StartQuest MDSBTraders
- For saddlebags and fancy saddles:
Set MDSBTraderESP.Version to 0
StartQuest MDSBTraderESP
- Recuperar items COC MDSaddleBagCell