Difference between revisions of "GetNthKeyPressed - Input"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>JustinOther
(Created page with "Category:Scripting Category:Papyrus Category:SKSE '''SKSE Member of:''' Input Script For walking over the pressed keys. (This function requires SKSE) == Synt...")
 
imported>Terra Nova2
 
(8 intermediate revisions by 3 users not shown)
Line 3: Line 3:
[[Category:SKSE]]
[[Category:SKSE]]
'''SKSE Member of:''' [[Input Script]]
'''SKSE Member of:''' [[Input Script]]
{{SKSEFunction|1.05.07}}


For walking over the pressed keys. (This function requires SKSE)
For walking over the pressed keys. (This function requires SKSE)
Line 10: Line 12:


== Parameters ==
== Parameters ==
*n : the N'th key pressed
*n : the Nth key pressed


== Return Value ==
== Return Value ==
Returns the [[DXScanCode]] of the N'th key pressed as an Int. If no N'th key is pressed, -1 is returned.
Returns the [[Input_Script#DXScanCodes|DXScanCode]] of the Nth key pressed as an Int. If no Nth key is pressed, -1 is returned.


== Examples ==
== Examples ==
Line 20: Line 22:
== Notes ==
== Notes ==
*The index of the first key pressed is 0.
*The index of the first key pressed is 0.
*The function checks for any keys held down the moment the function is called. [http://forums.bethsoft.com/topic/1507604-quick-questions-quick-answers-thread-45/page-5#entry23787951 Source]
== See Also ==
== See Also ==
*[[Input Script]]
*[[Input Script]]
*[[GetNumKeysPressed - Input]]
*[[GetNumKeysPressed - Input]]
*[[IsKeyPressed - Input]]
*[[IsKeyPressed - Input]]
*[[RegisterForKey - Form]]
*[[OnKeyDown - Form]]
*[[OnKeyUp - Form]]
*[[RegisterForControl - Form]]
*[[OnControlDown - Form]]
*[[OnControlUp - Form]]

Latest revision as of 19:13, 9 October 2014

SKSE Member of: Input Script

Minimum required SKSE Version: 1.05.07

For walking over the pressed keys. (This function requires SKSE)

Syntax[edit | edit source]

int Function GetNthKeyPressed(int n) global native

Parameters[edit | edit source]

  • n : the Nth key pressed

Return Value[edit | edit source]

Returns the DXScanCode of the Nth key pressed as an Int. If no Nth key is pressed, -1 is returned.

Examples[edit | edit source]

Int iHotkey = Input.GetNthKeyPressed(0)

Notes[edit | edit source]

  • The index of the first key pressed is 0.
  • The function checks for any keys held down the moment the function is called. Source

See Also[edit | edit source]