Difference between revisions of "OnKeyUp - ScriptObject"
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 | ||
Listens for the release of keys whose [[ | Listens for the release of keys whose [[DirectX Scan Codes|Scan Codes]] have been registered via [[RegisterForKey - ScriptObject|RegisterForKey]]. | ||
== Syntax == | == Syntax == | ||
<source lang="papyrus">Event OnKeyUp( | <source lang="papyrus">Event OnKeyUp(int keyCode, float time)</source> | ||
== Parameters == | == Parameters == | ||
* | *keyCode: The [[DirectX Scan Codes|Scan Code]] of a key release to listen for. | ||
*time: The amount of time the key was held down. | |||
== Examples == | == Examples == | ||
<source lang="papyrus">Event OnKeyUp( | <source lang="papyrus"> | ||
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.") | |||
EndEvent</source> | EndIf | ||
EndEvent | |||
</source> | |||
== Notes == | == Notes == | ||
| Line 28: | Line 30: | ||
== See Also == | == See Also == | ||
*[[ScriptObject Script]] | *[[ScriptObject Script]] | ||
*[[RegisterForKey - ScriptObject]] | *[[RegisterForKey - ScriptObject]] | ||
*[[UnregisterForKey - ScriptObject]] | *[[UnregisterForKey - ScriptObject]] | ||
*[[OnKeyDown - ScriptObject]] | *[[OnKeyDown - ScriptObject]] | ||
*[[DirectX Scan Codes]] | |||
Revision as of 15:13, 6 April 2017
F4SE Member of: ScriptObject Script
Minimum required F4SE Version: 0.3.0
Listens for the release of keys whose Scan Codes have been registered via RegisterForKey.
Syntax
Event OnKeyUp(int keyCode, float time)Parameters
- keyCode: The Scan Code of a key release to listen for.
- time: The amount of time the key was held down.
Examples
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
EndEventNotes
- 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.