inputAction: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Text replacement - ">Posted on July ([0-9]{2})[ a-zA-Z]*, ([0-9]{4})" to ">Posted on $2-07-$1")
 
(70 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma2 |= Game name
|game1= arma2
|version1= 1.00


|1.00|= Game version
|game2= arma2oa
____________________________________________________________________________________________
|version2= 1.50


| Return the state of input devices mapped to given input action.
|game3= tkoh
<br>
|version3= 1.00
For Arma 3 inputActions see: [[{{PAGENAME}}/actions]].
<br>
For Arma 3 inputActions bindings see: [[{{PAGENAME}}/actions/bindings]].
<br>
For earlier Arma editions  see [[:Category:Key Actions]].  |DESCRIPTION=
____________________________________________________________________________________________


| '''inputAction''' name |SYNTAX=
|game4= arma3
|version4= 0.50


|p1= name: [[String]] - name of the action |PARAMETER1=  
|gr1= Interaction


| [[Number]] |RETURNVALUE=
|descr= Return the state of input devices mapped to given input action.
<br>
For Arma 3 inputActions and its bindings see: [[{{PAGENAME}}/actions]].
<br>
For earlier Arma editions  see [[:Category:Key Actions]].


|s1= [[inputAction]] name


|x1= <code>[[inputAction]] "leanLeft"</code> Returns 1 if the button mapped to "leanLeft" is pressed currently else 0. |EXAMPLE1=
|p1= name: [[String]] - name of the action


|x2= <code>[] [[spawn]] {
|r1= [[Number]]
[[waitUntil]] {[[inputAction]] "reloadMagazine" > 0}; 
[[hint]] "Reload Key Pressed";
};</code>|EXAMPLE2=


____________________________________________________________________________________________
|x1= <sqf>inputAction "leanLeft";</sqf> Returns 1 if the button mapped to "leanLeft" is pressed currently else 0.


| [[actionKeys]], [[actionKeysImages]], [[actionKeysNames]], [[actionIDs]], [[actionParams]], [[addAction]], [[setUserActionText]], [[inGameUISetEventHandler]], [[showHUD]], [[removeAction]], [[removeAllActions]], [[action]]|SEEALSO=
|x2= <sqf>[] spawn {
waitUntil {inputAction "reloadMagazine" > 0};
hint "Reload Key Pressed";
};</sqf>


| |MPBEHAVIOUR=  
|seealso= [[inputMouse]] [[inputController]] [[actionKeys]] [[actionKeysImages]] [[actionKeysNames]] [[actionIDs]] [[actionParams]] [[addAction]] [[setUserActionText]] [[inGameUISetEventHandler]] [[showHUD]] [[removeAction]] [[removeAllActions]] [[action]]
____________________________________________________________________________________________
}}
}}


<h3 style='display:none'>Notes</h3>
<dl class="command_description">
<dl class='command_description'>
 
<!-- Note Section BEGIN -->
<dt></dt>
<dd class="notedate">Posted on 07:38, 15 October 2010 (CEST)</dd>
<dd class="notedate">Posted on 07:38, 15 October 2010 (CEST)</dd>
<dt class="note">[[User:Worldeater|Worldeater]]</dt>
<dt class="note">[[User:Worldeater|Worldeater]]</dt>
<dd class="note">
<dd class="note">
This command also returns values other than 0 and 1 (like 0.02 or 1.3). Any value greater than zero usually signals that the key or button is pressed. [[inputAction]] does not work reliably when used in RscDisplayMission's onKeyDown event handler (the same is probably true for other input related event handlers).
This command also returns values other than 0 and 1 (like 0.02 or 1.3). Any value greater than zero usually signals that the key or button is pressed. [[inputAction]] does not work reliably when used in RscDisplayMission's onKeyDown event handler (the same is probably true for other input related event handlers).
<!-- Note Section END -->
</dl>


<h3 style='display:none'>Bottom Section</h3>
<dt></dt>
[[Category:ArmA 2: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
<dd class="notedate">Posted on 2014-05-08 - 15:18 (UTC)</dd>
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
<dt class="note">[[User:FlannelMouth|FlannelMouth]]</dt>
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
 
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on May 8, 2014 - 15:18 (UTC)</dd>
<dt class="note">'''[[User:FlannelMouth|FlannelMouth]]'''</dt>
<dd class="note">
<dd class="note">
[[inputAction]] does not return the actual state of the queried key when a dialog screen is open. Instead, it will always return 0.  
[[inputAction]] does not return the actual state of the queried key when a dialog screen is open. Instead, it will always return 0.  
</dd>
</dd>
</dl>
<!-- DISCONTINUE Notes -->


<!-- CONTINUE Notes -->
<dt><dt>
<dl class="command_description">
<dd class="notedate">Posted on 2015-07-31 - 05:33 (UTC)</dd>
<dd class="notedate">Posted on July 31, 2015 - 05:33 (UTC)</dd>
<dt class="note">[[User:Waffle SS.|Waffle SS.]]</dt>
<dt class="note">[[User:Waffle SS.|Waffle SS.]]</dt>
<dd class="note">
<dd class="note">
'''inputAction''' is capable of returning the state of analog inputs. This includes mouse, joystick, and even TrackIR. A joystick axis will return a value from 0 to 1, while mouse movement returns the rate of change, which can be > 1.
'''inputAction''' is capable of returning the state of analog inputs. This includes mouse, joystick, and even TrackIR. A joystick axis will return a value from 0 to 1, while mouse movement returns the rate of change, which can be > 1.
<br/><br/>
<br><br>
Right mouse click is currently not supported, but right mouse hold is. http://feedback.arma3.com/view.php?id=25015
Right mouse click is currently not supported, but right mouse hold is: https://feedback.bistudio.com/T83382
</dd>
</dd>
</dl>
</dl>
<!-- DISCONTINUE Notes -->

Latest revision as of 00:09, 14 May 2023

Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
Hover & click on the images for description

Description

Description:
Return the state of input devices mapped to given input action.
For Arma 3 inputActions and its bindings see: inputAction/actions.
For earlier Arma editions see Category:Key Actions.
Groups:
Interaction

Syntax

Syntax:
inputAction name
Parameters:
name: String - name of the action
Return Value:
Number

Examples

Example 1:
inputAction "leanLeft";
Returns 1 if the button mapped to "leanLeft" is pressed currently else 0.
Example 2:
[] spawn { waitUntil {inputAction "reloadMagazine" > 0}; hint "Reload Key Pressed"; };

Additional Information

See also:
inputMouse inputController actionKeys actionKeysImages actionKeysNames actionIDs actionParams addAction setUserActionText inGameUISetEventHandler showHUD removeAction removeAllActions action

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note
Posted on 07:38, 15 October 2010 (CEST)
Worldeater
This command also returns values other than 0 and 1 (like 0.02 or 1.3). Any value greater than zero usually signals that the key or button is pressed. inputAction does not work reliably when used in RscDisplayMission's onKeyDown event handler (the same is probably true for other input related event handlers).
Posted on 2014-05-08 - 15:18 (UTC)
FlannelMouth
inputAction does not return the actual state of the queried key when a dialog screen is open. Instead, it will always return 0.
Posted on 2015-07-31 - 05:33 (UTC)
Waffle SS.
inputAction is capable of returning the state of analog inputs. This includes mouse, joystick, and even TrackIR. A joystick axis will return a value from 0 to 1, while mouse movement returns the rate of change, which can be > 1.

Right mouse click is currently not supported, but right mouse hold is: https://feedback.bistudio.com/T83382
Retrieved from "https://community.bistudio.com/wiki?title=inputAction&oldid=341070"