Difference between revisions of "OnKeyUp - ScriptObject"

From the Fallout4 CreationKit Wiki
Jump to navigation Jump to search
imported>Qazaaq
(Replaced input script with DX Scan Code)
imported>Qazaaq
(added required f4se version)
 
(One intermediate revision 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


Listens for the release of keys whose [[DirectX Scan Codes|Scan Codes]] have been registered via [[RegisterForKey - ScriptObject|RegisterForKey]].
Listens for the release of keys whose [[DirectX Scan Codes|Scan Codes]] have been registered via [[RegisterForKey - ScriptObject|RegisterForKey]].
Line 13: Line 9:
== Parameters ==
== Parameters ==
*keyCode: The [[DirectX Scan Codes|Scan Code]] of a key release to listen for.
*keyCode: The [[DirectX Scan Codes|Scan Code]] of a key release to listen for.
*time: The amount of time the key was held down.
*time: The amount of time the key was held down in seconds.


== Examples ==
== Examples ==
Line 34: Line 30:
*[[OnKeyDown - ScriptObject]]
*[[OnKeyDown - ScriptObject]]
*[[DirectX Scan Codes]]
*[[DirectX Scan Codes]]
[[Category:Scripting]]
[[Category:Papyrus]]
[[Category: Events]]
[[Category:F4SE]]

Latest revision as of 18:40, 21 January 2018

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

Listens for the release of keys whose Scan Codes have been registered via RegisterForKey.

Syntax[edit | edit source]

Event OnKeyUp(int keyCode, float time)

Parameters[edit | edit source]

  • keyCode: The Scan Code of a key release to listen for.
  • time: The amount of time the key was held down in seconds.

Examples[edit | edit source]

Event OnKeyUp(int keyCode, float time)
   Debug.Trace("The registered key " + keyCode + " has been released after being held for " + time + " seconds.")
   If (keyCode == 160 && time > 1.0)
      Debug.Trace("L-Shift been released after being held for longer than 1 second.")
   EndIf
EndEvent

Notes[edit | edit source]

  • 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[edit | edit source]