Difference between revisions of "OnControlUp - ScriptObject"

From the Fallout4 CreationKit Wiki
Jump to navigation Jump to search
imported>Kyllagdrgn
(Created page with "Category:Scripting Category:Papyrus Category:F4SE '''F4SE Member of:''' ScriptObject Script Minimum required F4SE Version: 0.3.0 Listens for the release of g...")
 
imported>Qazaaq
(added required f4se version)
 
(3 intermediate revisions by 2 users 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 game controls that have been registered via [[RegisterForControl - ScriptObject|RegisterForControl]].
Listens for the release of game controls that have been registered via [[RegisterForControl - ScriptObject|RegisterForControl]].


== Syntax ==
== Syntax ==
<source lang="papyrus">
<source lang="papyrus">Event OnControlUp(string control, float time)</source>
Event OnControlUp(string control, float HoldTime)
EndEvent
</source>


== Parameters ==
== Parameters ==
*control: The control press.
*control: The control press.
*time: The amount of time the control was held down in seconds.


*HoldTime: The hold time of the control in seconds.
== Examples ==
== Examples ==
<source lang="papyrus">
<source lang="papyrus">
Event OnControlUp(string control, float HoldTime)
Event OnControlUp(string control, float time)
If control == "Forward"
  If (control == "Forward")
Debug.Trace("The Forward control was released after" + HoldTime + " seconds.")
      Debug.Trace("The Forward control was released after" + time + " seconds.")
EndIf
  EndIf
EndEvent
EndEvent
</source>
</source>
== Control Strings ==


== Notes ==
== Notes ==
Line 33: Line 25:
== See Also ==
== See Also ==
*[[ScriptObject Script]]
*[[ScriptObject Script]]
*[[Input Script]]
*[[RegisterForControl - ScriptObject]]
*[[RegisterForControl - Form]]
*[[UnregisterForControl - ScriptObject]]
*[[UnregisterForControl - Form]]
*[[OnControlDown - ScriptObject]]
*[[UnregisterForAllControls - Form]]
 
*[[OnControlDown - Form]]
 
[[Category:Scripting]]
[[Category:Papyrus]]
[[Category: Events]]
[[Category:F4SE]]

Latest revision as of 18:38, 21 January 2018

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

Listens for the release of game controls that have been registered via RegisterForControl.

Syntax[edit | edit source]

Event OnControlUp(string control, float time)

Parameters[edit | edit source]

  • control: The control press.
  • time: The amount of time the control was held down in seconds.

Examples[edit | edit source]

Event OnControlUp(string control, float time)
   If (control == "Forward")
      Debug.Trace("The Forward control was released after" + time + " seconds.")
   EndIf
EndEvent

Notes[edit | edit source]

  • If multiple controls 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]