Difference between revisions of "OnKeyDown - ScriptObject"

From the Fallout4 CreationKit Wiki
Jump to navigation Jump to search
imported>Qazaaq
m (parameter casing)
imported>Qazaaq
(Tweaked example code with multi-key condition)
Line 17: Line 17:
<source lang="papyrus">
<source lang="papyrus">
Event OnKeyDown(int keyCode)
Event OnKeyDown(int keyCode)
  Debug.Trace("A registered key has been pressed")
   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.")
  ElseIf (keyCode == 161)
      Debug.Trace("The right shift key has been pressed.")
  Else
      Debug.Trace("The keycode '"+keyCode+"' has been pressed.")
   EndIf
   EndIf
EndEvent
EndEvent

Revision as of 19:33, 16 August 2017

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)
   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