Editing
IsKeyPressed - Input
Jump to navigation
Jump to search
Warning:
You are not logged in. Your IP address will be publicly visible if you make any edits. If you
log in
or
create an account
, your edits will be attributed to your username, along with other benefits.
Anti-spam check. Do
not
fill this in!
[[Category:Scripting]] [[Category:Papyrus]] [[Category:SKSE]] '''SKSE Member of:''' [[Input Script]] {{SKSEFunction|1.05.04}} Checks if a given key is currently pressed. (This function requires SKSE) == Syntax == <syntaxhighlight lang="papyrus">Bool Function IsKeyPressed(Int dxKeycode) Global Native</syntaxhighlight> == Parameters == *dxKeycode : The [[Input_Script#DXScanCodes|DXScanCode]] of the key to check. == Return Value == Returns 'True' if the key is pressed and 'False' if not. == Examples == *Standard use. <syntaxhighlight lang="papyrus">Bool bIsHotkeyPressed = Input.IsKeyPressed(42) ; Is L-Shift pressed?</syntaxhighlight> *Do/Undo something when a key is pressed/released. [[States (Papyrus)|States]] ''could'' be used in lieu of the boolean guard, but would verifiably not save any resources in this context. <syntaxhighlight lang="papyrus">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</syntaxhighlight> *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 - Debug|Trace]] would be called every iteration. <syntaxhighlight lang="papyrus">Event OnUpdate() If bIsHotkeyPressed != Input.IsKeyPressed(iHotkey) bIsHotkeyPressed = !bIsHotkeyPressed If bIsHotkeyPressed Debug.Trace("Do something.") EndIf EndIf RegisterForSingleUpdate(0.25) EndEvent</syntaxhighlight> == Notes == *To avoid multithreading mishaps, it's generally best to use [[RegisterForSingleUpdate - Form|RegisterForSingleUpdate]] rather than [[RegisterForUpdate - Form|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 [[Form Script#SKSE Events|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 - Input|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 == See Also == *[[Input Script]] *[[GetNumKeysPressed - Input]] *[[GetNthKeyPressed - Input]] *[[RegisterForKey - Form]] *[[OnKeyDown - Form]] *[[OnKeyUp - Form]] *[[RegisterForControl - Form]] *[[OnControlDown - Form]] *[[OnControlUp - Form]]
Summary:
Please note that all contributions to the CreationKit Wiki are considered to be released under the Creative Commons Attribution-ShareAlike (see
CreationKit:Copyrights
for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource.
Do not submit copyrighted work without permission!
Cancel
Editing help
(opens in new window)
Template used on this page:
Template:SKSEFunction
(
edit
)
Navigation menu
Personal tools
Not logged in
Talk
Contributions
Create account
Log in
Namespaces
Page
Discussion
English
Views
Read
Edit
Edit source
View history
More
Search
Navigation
Landing page
Tutorials
Game Systems
Editor Reference
Scripting Reference
Recent changes
Help
Tools
What links here
Related changes
Special pages
Page information
Page values