OnKeyDown - ScriptObject

From Creation Kit
Jump to: navigation, search

F4SE Member of: ScriptObject Script
Requires F4SE version 0.3.0 or higher.

Listens for the pressing of keys whose Scan Codes have been registered via RegisterForKey.

Syntax

Event OnKeyDown(int keyCode)

Parameters

  • keyCode: The Scan Code of a key press to listen for.

Examples

Event OnKeyDown(int keyCode)
   If (keyCode == 160)
      Debug.Trace("The left shift key has been pressed.")
   ElseIf (keyCode == 161)
      Debug.Trace("The right shift key has been pressed.")
   Else
      Debug.Trace("The keycode '"+keyCode+"' 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