Difference between revisions of "OnControlDown - ScriptObject"

imported>Kyllagdrgn
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 pressing of game controls that have been registered via [[RegisterForControl - ScriptObject|RegisterForControl]].
Listens for the pressing of game controls that have been registered via [[RegisterForControl - ScriptObject|RegisterForControl]].


== Syntax ==
== Syntax ==
<source lang="papyrus">
<source lang="papyrus">Event OnControlDown(string control)</source>
Event OnControlDown(string control)
EndEvent
</source>


== Parameters ==
== Parameters ==
Line 20: Line 13:
<source lang="papyrus">
<source lang="papyrus">
Event OnControlDown(string control)
Event OnControlDown(string control)
If control == "Forward"
  If (control == "Forward")
Debug.Trace("The player is pressing the forwards control.")
      Debug.Trace("The player is pressing the forwards control.")
EndIf
  EndIf
EndEvent
EndEvent
</source>
</source>
== Control Strings ==


== Notes ==
== Notes ==
Line 33: Line 24:
== See Also ==
== See Also ==
*[[ScriptObject Script]]
*[[ScriptObject Script]]
*[[Input Script]]
*[[RegisterForControl - ScriptObject]]
*[[RegisterForControl - ScriptObject]]
*[[UnregisterForControl - ScriptObject]]
*[[UnregisterForControl - ScriptObject]]
*[[OnControlUp - ScriptObject]]
*[[OnControlUp - ScriptObject]]
[[Category:Scripting]]
[[Category:Papyrus]]
[[Category: Events]]
[[Category:F4SE]]

Latest revision as of 18:37, 21 January 2018

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

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

SyntaxEdit

Event OnControlDown(string control)

ParametersEdit

  • control: The control press.

ExamplesEdit

Event OnControlDown(string control)
   If (control == "Forward")
      Debug.Trace("The player is pressing the forwards control.")
   EndIf
EndEvent

NotesEdit

  • 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 AlsoEdit