[Relz/beta] CK Hotkeys - including Control Tab

[Udun]

Highlights :

• ControlTab : press and hold Ctrl then press Tab to cycle in an Alt Tab way through the CK windows that are open (Render, Cell, Object, References, etc). Shift reverses order. It works like the Alt Tab shortcut in Windows Explorer.
  
• FocusBack : when closing a window focus is given back to previously focused window
  
• Shortcuts : including Maximize and minimize for all windows (like Cell, render, Object) - Tab on a couple windows (like object, cell etc) - Esc and Enter on NPCs etc - Htlm readme is very useful if you want to use the shortcuts, read it !
  
• Warnings mass OK : Pressing delete on a warning window will keep pressing yes to all the chunk of warnings - if such a chunk is separated from the next by several secs press delete again. See the ini.
  

Focusback (beta) may misfire - that is focus is given back to the previous win before focus is given to the win you opened - enable OnlyForReferences in the ini if this happens too often - you may also disable it completely via the ini. Let me know. I chose to fully enable it by default - I find it very useful and people are too lazy to enable it themselves lol.

Beth forums thread

Skyrim Nexus

The readme :

Name: TES5 CK Hotkeys (including Control Tab and Toggle Script)

Version: 0.95b (beta)

Date: 2011/3/17

Category: Modding Tools

Requirements: tested with CK 1.4.23 on WIN7 PRO

Author : utumno aka Udun

Homepage: http://udunslabs.blogspot.com/

Download: http://skyrim.nexusm...le.php?id=13113

Description

===========

This release includes one executable, CK_Hotkeys_v0.95b.exe which adds :

* control tab functionality (actually ALT TAB, but using Ctrl-Tab shortcut) in the Skyrim Construction Kit, using the always handy Autohotkey language.

* Customizable (via ini file) shortcuts (hotkeys) for various actions (see below).

* An ini file created in the directory the script is run, CK_Hotkeys.ini.

* A focus back to previous window feature. By default enabled for all windows. If you find you have problems with some windows loosing focus (namely the NPC window) set OnlyForReferences to 1 in the ini.

Install

=======

Download, unzip, save CK_Hotkeys_v0.95b.exe wherever in your drive. Run the exe, open up the CK, switch to it and let the script initialize (takes a couple secs). (If the CK is not running, as long as you leave the default ini settings, the script will wait for the CK).

One small green icon with an H on it will appear on system tray when you run the exe. By right clicking on it you can exit, pause the script or suspend the hotkeys. The exe will create an ini file in the directory it is run, where you can customize a couple of options.

Features

========

CK_Hotkeys_v0.95b.exe :

* press and hold Ctrl then press Tab to cycle in an Alt Tab way through the CK windows that are open (Render, Cell, Object, References, etc). Shift reverses order. It works like the Alt Tab shortcut in Windows Explorer. Clicking on a window adds it to the stack (even if the script failed to auto-add it).

* Adds shortcuts, see the ini file section bellow.

In particular pressing Alt+m toggles the maximize/restore state of the window while Alt+n minimizes it out of your way (to actually minimize it out of your way press Alt+Shift+n). Alt+m is meant to be used with the object, cell, render, script and script\open windows (and a couple of others maybe) which although not having maximize\restore\minimize button they can be maximized and minimized. With other windows, like "Reference", will give a funky result

Also, pressing Cntrl+Shift+r reloads the script. When cpu load is very high this may prove necessary.

CK_Hotkeys.ini

==============

^ stands for Control, + for Shift and ! for Alt.

~ is not part of the hotkeys but a symbol that tells Autohotkey that when the hotkey fires, its key's native function will not be blocked (so wherever you see, for instance, the ~Enter combo, pressing Enter (and NOT the tilde) will fire the hotkey and also send an Enter keystroke). Best to leave it there when I have it.

For more keys and rules see http://www.autohotke...keys.htm#Intro.

When the CK_Hotkeys_v0.95b.exe script is first run the (default) CK_Hotkeys.ini will be created - and then left alone. If you want to change a shortcut just open the ini and edit the shortcut you want. For instance, replace the line :

ReloadScript=^+r

with :

ReloadScript=^!j

if you want Control+Alt+j to reload the script instead of the default Control+Shift+r. If you want to disable a particular shortcut delete the part after the = sign. For instance :

ReloadScript=

disables the Reload Script shortcut.

For changes to take effect rerun the exe.

If you want to revert to the default hotkeys just delete CK_Hotkeys.ini and reload (run) the CK_Hotkeys_v0.95b.exe. A brand new (default) CK_Hotkeys.ini will be created.

The specific window classes' hotkeys take precedence over the global ones (see comments in [GlobalHotkeys] section).

The ini file I give below is "commented". Do not attempt to comment the actual ini as I don't believe it's possible.

<ck_hotkeys.ini>


   [Settings]

   Exit_on_CS_exit=0		 ; if set to 1 the script will exit on CS's exit and not start at all if the CS is not running

   Enable_Shortcuts=1		; set to 0 to disable all shortcuts (except Control-Tab)

   Show_initialize_tooltip=1 ; set to 0 to disable the tooltip shown on initialization

   EnableRefocus=1		   ; set to 0 to disable focusing back on the previous window when closing a window

   OnlyForReferences=0	   ; set to 1 to disable ReFocus on all windows except "References" windows

   EvenMoreWins=1			; set to 0 to disable ReFocus on some windows like find and replace, Quests etc ; if OnlyForReferences==1 this has no effect


   [GlobalHotkeys]

   ; these will run if any CK window is active (has focus). If a shortcut here conflicts with one in another section however, the other one will take precedence.

   ; for instance ^s won't save the active plugin when a Script Edit window is active - it will save the current script instead (see [ScriptHotkeys] section below)

   ReloadScript=^+r	 ; reloads the script (CK_Hotkeys)

   Maximize/Restore=!m  ; meant to be used with the object, cell, render, script and script\open windows (and a couple others maybe)

   Minimize=!n

   ForceMin=!+n		 ; minimizes active window and puts it to the bottom of the stack of windows - so when hitting CntrlTab once it won't pop up

						; you need to press ^+Tab to see it - found this very useful

   Dialogue=^+d		 ; brings up the Dialogue window

   OpenWindows=^+o	  ; brings up the Open Windows window

   Preview=^+p		  ; brings up the Preview window

   FindRepl=^h		  ; brings up the Find and Replace window

   Save=^s			  ; brings up the Save window

   Data=^o			  ; brings up the Data window

   Preferences=^p	   ; brings up the Preferences window

   FindText=^t		  ; brings up the Find Text window

   Quests=^+q		   ; focuses on the Object window in the Quests list

   Factions=^+f		 ; focuses on the Object window in the Factions list

   Packages=^+k		 ; focuses on the Object window in the Packages list

   PapyrusManager=^+s   ; brings up the Papyrus Manager window


   [PapyrusHotkeys]

   ; these hotkeys run when the Papyrus Manager window is active

   DoubleClickPapysusOpenSCR=~Enter  ; press Enter to open the currently highlighted script in the list

   ClosePapyrus=~Esc				 ; DO NOT PRESS THE ~ !!! Just press Esc to exit the Papyrus Manager

   TabPapyrus=Tab					; press Tab to jump from control to control in the cell win


   [Warnings]

   ; these are for "Warnings" windows

   MassOK=delete	 ; press delete and the script will keep pressing Yes to chunks of warnings. Works even for thousands of them. The CK may loose focus - it is a CK bug

					 ; Give it time to finish, do not alt tab to another window till it does

   wait=10		   ; time in ms to wait before pressing Yes again. Minimum -1 (fastest). Do not set it very high (-1 to 100 is fine)


   [PrefHotkeys]

   ; this hotkey runs when the Preferences window is active. Takes precedence over the GlobalHotkeys

   PrefConfirm=~Enter	; press Enter to confirm changes and close pref window (doh)


   [DataHotkeys]

   ; these hotkeys run when the Data window is active.

   DATact=^Space	 ; set (unset if set) as active plugin (the list of plugins must have focus)

   DATcheck=Space	; check (uncheck) plugin (the list of plugins must have focus) ; thanks to HotKeyIt


   [Cell]

   ; pressing Enter when keyboard focus is on cell X, in the list of cells (left list in Cell window), loads X

   ; while pressing Enter when focus is on an object in the *X_cell* Objects list (right list in Cell window) focuses on the object in Render win. ; thanks to HotKeyIt

   DoubleClickC=~Enter

   TabC=Tab   ; press Tab to jump from control to control in the cell win


   [Object]

   ; pressing Enter when keyboard focus (the blue background) is on object X displays the properties of object X

   DoubleClickO=~Enter

   TabO=Tab   ; press Tab to jump from control to control in the object win


   [Render/CK]

   ; when focus on CK itself or on the Render window

   Havoc=o		  ; toggle havoc


   [PrevHotkeys]

   ClosePrev=~Esc   ; press Esc to close the Preview win


   [NPCHotkeys]

   NPCok=~Enter	 ; press Enter on the active Actor win hits the OK button

   NPCcancel=~Esc   ; press Esc to close the active Actor win


</ck_hotkeys.ini>

Limitations

===========

When clicking too fast on an object in the object window the window that pops up fails to get detected by my script. By too fast I mean so fast that actually the object window is given focus again instantly, so the object's properties loose focus (and that's not the reason for having been clicked in the first place . Either double click on the object again (not so fast) or left click on the object's window properties if visible. It will be detected. Now this is what makes it a beta. I need help with windows event programming to save these scripts from betaness !

NB : THOSE SCRIPTS ARE NOT MEANT TO BE USED WITH MULTIPLE CSs ACTIVE.

Known Bugs

==========

The ^o shortcut for opening the data window sometimes does not work (window does not appear). Workaround : hit the shortcut (^o) again. A blank data window should appear. Hit Esc and the normal data window should appear.

Focus back works too much sometimes - restrict it via ini if causing problems.

Sometimes (on some keyboards ?) some shortcuts do not fire (I had this issue with ^n in script wins). Workaround : reload the script (^+r by default).

A rare bug is that, sometimes, when hitting a hotkey, the perspective in the Render window changes. I have not figured out when exactly this happens - please give me feedback on this one.

To Do

=====

Correct limitation and bugs above. Add tab shortcut functionality for more wins. Make the scripts event based.

Feedback needed

===============

The script relies on sleep times tested on my machine which is rather clean, cpu not under big load etc. Should work fine anyway but I need some feedback on that. And feedback on the workings of the CK from people who are into WinAPI programming would be great. The CK is full of surprises

Changelog

=========

0.95b, 2010/5/9 - CK_Hotkeys_v0.95b.exe : Initial release.

Contact

=======

My blog : http://udunslabs.blogspot.com/. Visit for some more info on the project and to post comments. Remember I need feedback ! Also active in the beth forums (utumno).

Credits

=======

Thanks to Bethesda for creating Skyrim and the CK we love to patch.

Thanks to TESNexus.com/PlanetElderScrolls for the a one-stop-shop resource for authors and players.

Thanks to LHammonds for the Readme Generator this file was based on.

Thanks to the great Autohotkey community that provided me with tons of useful functions/answers/remarks. In particular I would like to thank HotKeyIt who made half of the functions I use Thumbs up guys

Thanks to all that provided me with feedback in the beth forums !

Licensing/Legal

===============

Donationware (I have still to add a button - but you can still click on the ads at my blog). Ah, yes, I tested thoroughly and anyway it's a harmless script but still backup and blah blah - enable autosave in the CK btw.

Edited March 19, 2012 by Udun