Difference between revisions of "OnKeyDown - Form"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>JustinOther
(Initial page creation)
 
imported>JustinOther
m (Added required version template)
 
(3 intermediate revisions by the same user not shown)
Line 4: Line 4:
'''SKSE Member of:''' [[Form Script]]
'''SKSE Member of:''' [[Form Script]]


Listens for the pressing of keys whose [[Input_Script#DXScanCodes|DXScanCodes]] have been registred via [[RegisterForKey -Form|RegisterForKey]].
{{SKSEFunction|1.06.00}}
 
Listens for the pressing of keys whose [[Input_Script#DXScanCodes|DXScanCodes]] have been registered via [[RegisterForKey - Form|RegisterForKey]]. (This event requires SKSE)


== Syntax ==
== Syntax ==
Line 23: Line 25:
== Notes ==
== Notes ==
*If multiple keys are registered, you'll want to differentiate in the event body as demonstrated above. If only one key will be registered for the form, such differentiation is not necessary.
*If multiple keys are registered, you'll want to differentiate in the event body as demonstrated above. If only one key will be registered for the form, such differentiation is not necessary.
== See Also ==
*[[Form Script]]
*[[Input Script]]
*[[RegisterForKey - Form]]
*[[UnregisterForKey - Form]]
*[[UnregisterForAllKeys - Form]]
*[[OnKeyUp - Form]]

Latest revision as of 15:56, 3 October 2012

SKSE Member of: Form Script

Minimum required SKSE Version: 1.06.00

Listens for the pressing of keys whose DXScanCodes have been registered via RegisterForKey. (This event requires SKSE)

Syntax[edit | edit source]

Event OnKeyDown(Int KeyCode)
EndEvent

Parameters[edit | edit source]

  • KeyCode: The DXScanCode of a key press to listen for.

Examples[edit | edit source]

Event OnKeyDown(Int KeyCode)
	Debug.Trace("A registered key has been pressed")
	If KeyCode == 42
		Debug.Trace("R-Shift is registered and has been pressed")
	EndIf
EndEvent

Notes[edit | edit source]

  • If multiple keys are registered, you'll want to differentiate in the event body as demonstrated above. If only one key will be registered for the form, such differentiation is not necessary.

See Also[edit | edit source]