Difference between revisions of "UnregisterForKey - ScriptObject"

From the Fallout4 CreationKit Wiki
Jump to navigation Jump to search
imported>Kyllagdrgn
imported>Qazaaq
(Replaced input script with DX Scan Code)
Line 6: Line 6:
Minimum required F4SE Version: 0.3.0
Minimum required F4SE Version: 0.3.0


Unregisters the given [[Input_Script#DXScanCodes|DXScanCode]] for [[OnKeyDown - ScriptObject|OnKeyDown]] and [[OnKeyUp - ScriptObject|OnKeyUp]] events after prior registration via [[RegisterForKey - ScriptObject|RegisterForKey]]. (This function requires F4SE)
Unregisters the given [[DirectX Scan Codes|Scan Code]] for [[OnKeyDown - ScriptObject|OnKeyDown]] and [[OnKeyUp - ScriptObject|OnKeyUp]] events after prior registration via [[RegisterForKey - ScriptObject|RegisterForKey]].


== Syntax ==
== Syntax ==
Line 12: Line 12:


== Parameters ==
== Parameters ==
*KeyCode: The [[Input_Script#DXScanCodes|DXScanCode]] of the key to stop listening for.
*KeyCode: The [[DirectX Scan Codes|Scan Code]] of the key to stop listening for.


== Return Value ==
== Return Value ==
NONE
None


== Examples ==
== Examples ==
Line 24: Line 24:
== See Also ==
== See Also ==
*[[ScriptObject Script]]
*[[ScriptObject Script]]
*[[Input Script]]
*[[RegisterForKey - ScriptObject]]
*[[RegisterForKey - ScriptObject]]
*[[OnKeyDown - ScriptObject]]
*[[OnKeyDown - ScriptObject]]
*[[OnKeyUp - ScriptObject]]
*[[OnKeyUp - ScriptObject]]
*[[DirectX Scan Codes]]

Revision as of 14:51, 6 April 2017

F4SE Member of: ScriptObject Script

Minimum required F4SE Version: 0.3.0

Unregisters the given Scan Code for OnKeyDown and OnKeyUp events after prior registration via RegisterForKey.

Syntax

Function UnregisterForKey(Int KeyCode) Native

Parameters

  • KeyCode: The Scan Code of the key to stop listening for.

Return Value

None

Examples

UnregisterForKey(160) ; L-Shift

Notes

NONE

See Also