Difference between revisions of "UnregisterForKey - ScriptObject"

From the Fallout4 CreationKit Wiki
Jump to navigation Jump to search
imported>Kyllagdrgn
imported>Qazaaq
(added required f4se version)
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
[[Category:Scripting]]
[[Category:Papyrus]]
[[Category:F4SE]]
'''F4SE Member of:''' [[ScriptObject Script]]
'''F4SE Member of:''' [[ScriptObject Script]]
{{Template:Papyrus:RequiredF4SE|version=0.3.0}}


Minimum required F4SE Version: 0.3.0
Unregisters the given [[DirectX Scan Codes|Scan Code]] for [[OnKeyDown - ScriptObject|OnKeyDown]] and [[OnKeyUp - ScriptObject|OnKeyUp]] events after prior registration via [[RegisterForKey - ScriptObject|RegisterForKey]].
 
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)


== Syntax ==
== Syntax ==
<source lang="papyrus">Function UnregisterForKey(Int KeyCode) Native</source>
<source lang="papyrus">Function UnregisterForKey(int keyCode) Native</source>


== 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 20:
== 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]]
[[Category:Scripting]]
[[Category:Papyrus]]
[[Category:F4SE]]

Revision as of 18:36, 21 January 2018

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

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