BIS fnc 3den onKeyDown: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Some wiki formatting)
 
(33 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Function|= Comments
{{RV|type=function


| arma3 |Game name=
|game1= arma3
|version1= 1.56


|1.56|Game version=
|gr1= KeyframeAnimation


<!---|arg= local |Multiplayer Arguments=--->
|descr= Used internally by the [[Arma 3: Key Frame Animation]] system. Called when a button is pressed.


<!---|eff= local |Multiplayer Effects=--->
|s1= [display, button, shift, ctrl, alt] call [[BIS_fnc_3den_onKeyDown]]


| <pre>/*
|p1= display: [[Display]] - the display
Author: Nelson Duarte <@Nelson_G_Duarte>


Description:
|p2= button: [[Number]] - key code of the pressed button
A keyboard key is pressed in 3DEN


Parameter(s):
|p3= shift: [[Boolean]] - {{Controls|Shift}} key
_this select 0: Display - The display control
_this select 1: Scalar - The pressed button
_this select 2: Bool - State of SHIFT
_this select 3: Bool - State of CTRL
_this select 4: Bool - The state of ALT


Returns:
|p4= ctrl: [[Boolean]] - {{Controls|Ctrl}} key
Bool - Whether or not to consume the input
*/</pre>{{Informative|Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]]}} |Description=


|[] call [[BIS_fnc_3den_onKeyDown]]|Syntax=
|p5= alt: [[Boolean]] - {{Controls|Alt}} key


|p1= parameter: Datatype - (Optional, default defValue) description |Parameter 1=
|r1= [[Boolean]] - whether or not to consume the input


|Datatype - description|Return value=
|x1= <sqf>findDisplay 313 displayAddEventHandler ["keyDown", { _this call BIS_fnc_3den_onKeyDown }];</sqf>


|x1= <code></code>|Example 1=
|seealso= [[Arma 3: Key Frame Animation]]
 
|exec= call |Execution=
 
| |See also=
}}
}}
[[Category:Function Group: 3DEN|{{uc:3den_onKeyDown}}]]
[[Category:Functions|{{uc:3den_onKeyDown}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:3den_onKeyDown}}]]

Latest revision as of 10:38, 27 March 2024

Arma 3 logo black.png1.56
Hover & click on the images for description

Description

Description:
Used internally by the Arma 3: Key Frame Animation system. Called when a button is pressed.
Execution:
call
Groups:
KeyframeAnimation

Syntax

Syntax:
[display, button, shift, ctrl, alt] call BIS_fnc_3den_onKeyDown
Parameters:
display: Display - the display
button: Number - key code of the pressed button
shift: Boolean - ⇧ Shift key
ctrl: Boolean - Ctrl key
alt: Boolean - Alt key
Return Value:
Boolean - whether or not to consume the input

Examples

Example 1:
findDisplay 313 displayAddEventHandler ["keyDown", { _this call BIS_fnc_3den_onKeyDown }];

Additional Information

See also:
Arma 3: Key Frame Animation

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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_3den_onKeyDown&oldid=363331"