Difference between revisions of "OnKeyDown - Form"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>JustinOther
m (Requires SKSE)
imported>JustinOther
m (Misspelling)
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]]. (This event requires SKSE)
Listens for the pressing of keys whose [[Input_Script#DXScanCodes|DXScanCodes]] have been registered via [[RegisterForKey - Form|RegisterForKey]]. (This event requires SKSE)


== Syntax ==
== Syntax ==

Revision as of 11:28, 3 October 2012

SKSE Member of: Form Script

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

Syntax

Event OnKeyDown(Int KeyCode)
EndEvent

Parameters

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

Examples

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

  • 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