IsKeyPressed - Input
From Creation Kit
SKSE Member of: Input Script
Minimum required SKSE Version: 1.05.04
Checks if a given key is currently pressed. (This function requires SKSE)
Bool Function IsKeyPressed(Int dxKeycode) Global Native
- dxKeycode : The DXScanCode of the key to check.
Returns 'True' if the key is pressed and 'False' if not.
- Standard use.
Bool bIsHotkeyPressed = Input.IsKeyPressed(42) ; Is L-Shift pressed?
- Do/Undo something when a key is pressed/released. States could be used in lieu of the boolean guard, but would verifiably not save any resources in this context.
Bool bIsHotkeyPressed ; = False Int Property iHotkey = 184 Auto ; R-Alt by default Event OnInit() RegisterForSingleUpdate(0.25) EndEvent Event OnUpdate() If bIsHotkeyPressed != Input.IsKeyPressed(iHotkey) ; Only run code when the status changes bIsHotkeyPressed = !bIsHotkeyPressed ; Set bool to whatever it isn't If bIsHotkeyPressed ; == True Debug.Trace("Hotkey Pressed") Else ; If bIsHotkeyPressed == False Debug.Trace("Hotkey Released") EndIf EndIf RegisterForSingleUpdate(0.25) EndEvent
- Do something exactly once each time a key is pressed. We'll take the scaffolding from above as rendered given the difference is exclusively in the OnUpdate event. Without the primary check and consecutive bool-flip, Trace would be called every iteration.
Event OnUpdate() If bIsHotkeyPressed != Input.IsKeyPressed(iHotkey) bIsHotkeyPressed = !bIsHotkeyPressed If bIsHotkeyPressed Debug.Trace("Do something.") EndIf EndIf RegisterForSingleUpdate(0.25) EndEvent
- To avoid multithreading mishaps, it's generally best to use RegisterForSingleUpdate rather than RegisterForUpdate.
- If updating at tight intervals, optimization is key as it will make your polling script more responsive. It shouldn't be necessary to update at intervals < 0.25 and doing so just makes a script unnecessarily 'expensive'.
- Given the Input Events are available, they'll be preferable to the above polling methods for many applications as their 'cost' is less.
- Avoid using keys already claimed by Skyrim. Invariably, mod added hotkeys will conflict, so it's best to offer a way to rebind your hotkey(s) via GetNthKeyPressed from an Options Menu or other readily accessible means such as a scripted inventory item. This will afford your mod elasticity and allow it to work in tandem with other hotkey bearing mods.
- Using a property to store the dxKeycode of the key you are polling will allow the same script to be easily reused to poll for different keys simultaneously, as this allows the dxKeycode to be set (or the default value overridden) in the Creation Kit without editing the script's source