BIS fnc 3den onKeyDown: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|= Comments" to "|Comments=")
m (page filled)
Line 1: Line 1:
{{Function|Comments=
{{Function


| arma3 |Game name=
|game1= arma3


|1.56|Game version=
|version1= 1.56


<!---|arg= local |Multiplayer Arguments=--->
<!--|serverExec= server-->


<!---|eff= local |Multiplayer Effects=--->
<!--|arg= local-->


| <pre>/*
<!--|eff= local-->
Author: Nelson Duarte <@Nelson_G_Duarte>


Description:
|descr= Used internally by the [[Arma 3 Key Frame Animation]] system. Called when a button is pressed.
A keyboard key is pressed in 3DEN


Parameter(s):
_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:
|s1= [display, button, shift, ctrl, alt] [[call]] [[BIS_fnc_3den_onKeyDown]]
Bool - Whether or not to consume the input
*/</pre>{{placeholder}}<!-- Remove this after fill-in --> |Description=


|[] call [[BIS_fnc_3den_onKeyDown]]|Syntax=
|p1= display: [[Display]] - The display


|p1= parameter: Datatype - (Optional, default defValue) description |Parameter 1=
|p2= button: [[Number]] - Key code of the pressed button


|Datatype - description|Return value=
|p3= shift: [[Boolean]] - SHIFT key


|x1= <code></code>|Example 1=
|p4= ctrl: [[Boolean]] - CTRL key


|exec= call |Execution=
|p5= alt: [[Boolean]] - ALT key
 
|r1= [[Boolean]] - Whether or not to consume the input
 
|x1= <code>[[findDisplay]] 313 [[displayAddEventHandler]] ["keyDown", {[[_this]] [[call]] [[BIS_fnc_3den_onKeyDown]]}];</code>
 
|exec= call
 
|seealso= [[Arma 3 Key Frame Animation]]


| |See also=
}}
}}


Revision as of 10:11, 23 July 2020

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:
Uncategorised

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=155539"