OnKeyDown - ScriptObject

F4SE Member of: ScriptObject Script

Minimum required F4SE Version: 0.3.0

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

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 == 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
• Input Script
• RegisterForKey - ScriptObject
• UnregisterForKey - ScriptObject
• OnKeyUp - ScriptObject