Difference between revisions of "OnControlDown - 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 pressing of...")
 
imported>Qazaaq
(added required f4se version)
 
(2 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 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 - Form]]
*[[UnregisterForControl - ScriptObject]]
*[[UnregisterForControl - Form]]
*[[OnControlUp - ScriptObject]]
*[[OnControlUp - Form]]
 
 
[[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.

Syntax[edit | edit source]

Event OnControlDown(string control)

Parameters[edit | edit source]

  • control: The control press.

Examples[edit | edit source]

Event OnControlDown(string control)
   If (control == "Forward")
      Debug.Trace("The player is pressing the forwards control.")
   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]