Difference between revisions of "OnKeyDown - ScriptObject"

← Older edit

OnKeyDown - ScriptObject (edit)

Revision as of 19:39, 21 January 2018

104 bytes added , 19:39, 21 January 2018

added required f4se version

Anonymous user

imported>Qazaaq

@@ Line 1: / Line 1: @@
-[[Category:Scripting]]
-[[Category:Papyrus]]
-[[Category:F4SE]]
 '''F4SE Member of:''' [[ScriptObject Script]]
+{{Template:Papyrus:RequiredF4SE|version=0.3.0}}
-Minimum required F4SE Version: 0.3.0
+Listens for the pressing of keys whose [[DirectX Scan Codes|Scan Codes]] have been registered via [[RegisterForKey - ScriptObject|RegisterForKey]].
-Listens for the pressing of keys whose [[Input_Script#DXScanCodes|DXScanCodes]] have been registered via [[RegisterForKey - ScriptObject|RegisterForKey]]. (This event requires F4SE)
 == Syntax ==
-<source lang="papyrus">Event OnKeyDown(Int KeyCode)
+<source lang="papyrus">Event OnKeyDown(int keyCode)</source>
-EndEvent</source>
 == Parameters ==
-*KeyCode: The [[Input_Script#DXScanCodes|DXScanCode]] of a key press to listen for.
+*keyCode: The [[DirectX Scan Codes|Scan Code]] of a key press to listen for.
 == Examples ==
-<source lang="papyrus">Event OnKeyDown(Int KeyCode)
+<source lang="papyrus">
-	Debug.Trace("A registered key has been pressed")
+Event OnKeyDown(int keyCode)
-	If KeyCode == 160
+   If (keyCode == 160)
-		Debug.Trace("L-Shift is registered and has been pressed")
+      Debug.Trace("The left shift key has been pressed.")
-	EndIf
+   ElseIf (keyCode == 161)
-EndEvent</source>
+      Debug.Trace("The right shift key has been pressed.")
+   Else
+      Debug.Trace("The keycode '"+keyCode+"' has been pressed.")
+   EndIf
+EndEvent
+</source>
 == Notes ==
@@ Line 28: / Line 28: @@
 == See Also ==
 *[[ScriptObject Script]]
-*[[Input Script]]
 *[[RegisterForKey - ScriptObject]]
 *[[UnregisterForKey - ScriptObject]]
 *[[OnKeyUp - ScriptObject]]
+*[[DirectX Scan Codes]]
+[[Category:Scripting]]
+[[Category:Papyrus]]
+[[Category: Events]]
+[[Category:F4SE]]