Difference between revisions of "RegisterForKey - ScriptObject"

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


Minimum required F4SE Version: 0.3.0
Registers the given [[DirectX Scan Codes|Scan Code]] for [[OnKeyDown - ScriptObject|OnKeyDown]] and [[OnKeyUp - ScriptObject|OnKeyUp]] events.
 
Registers the given [[Input_Script#DXScanCodes|DXScanCode]] for [[OnKeyDown - ScriptObject|OnKeyDown]] and [[OnKeyUp - ScriptObject|OnKeyUp]] events. (This function requires F4SE)


== Syntax ==
== Syntax ==
<source lang="papyrus">Function RegisterForKey(Int Key) Native</source>
<source lang="papyrus">Function RegisterForKey(int key) Native</source>


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


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


== Examples ==
== Examples ==
<source lang="papyrus">RegisterForKey(160) ; L-Shift</source>
<source lang="papyrus">
RegisterForKey(160) ; left shift
</source>


== Notes ==
== Notes ==
None


== See Also ==
== See Also ==
*[[ScriptObject Script]]
*[[ScriptObject Script]]
*[[Input Script]]
*[[UnregisterForKey - ScriptObject]]
*[[UnregisterForKey - ScriptObject]]
*[[OnKeyDown - ScriptObject]]
*[[OnKeyDown - ScriptObject]]
*[[OnKeyUp - ScriptObject]]
*[[OnKeyUp - ScriptObject]]
*[[DirectX Scan Codes]]
[[Category:Scripting]]
[[Category:Papyrus]]
[[Category:F4SE]]

Latest revision as of 18:34, 21 January 2018

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

Registers the given Scan Code for OnKeyDown and OnKeyUp events.

Syntax[edit | edit source]

Function RegisterForKey(int key) Native

Parameters[edit | edit source]

  • keyCode: The Scan Code of the key to listen for.

Return Value[edit | edit source]

None

Examples[edit | edit source]

RegisterForKey(160) ; left shift

Notes[edit | edit source]

None

See Also[edit | edit source]