OnKeyDown - ScriptObject

F4SE Member of: ScriptObject Script

Minimum required F4SE Version: 0.3.0

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)
   Debug.Trace("A registered key has been pressed")
   If (keyCode == 160)
      Debug.Trace("L-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

• ScriptObject Script
• RegisterForKey - ScriptObject
• UnregisterForKey - ScriptObject
• OnKeyUp - ScriptObject
• DirectX Scan Codes