BIS fnc holdKey: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Text replacement - "_{10,} " to "")
Line 1: Line 1:
{{Function|Comments=
{{Function|Comments=
____________________________________________________________________________________________


| arma3|Game name=
| arma3|Game name=
Line 7: Line 6:


|gr1 = Interaction |GROUP1=
|gr1 = Interaction |GROUP1=
____________________________________________________________________________________________


|Function that executes a user-defined code when a key has been held down for a long enough time. |DESCRIPTION=
|Function that executes a user-defined code when a key has been held down for a long enough time. |DESCRIPTION=
____________________________________________________________________________________________


|[display, key, time, code, control] call '''BIS_fnc_holdKey'''|SYNTAX=
|[display, key, time, code, control] call '''BIS_fnc_holdKey'''|SYNTAX=
Line 21: Line 18:


| None |RETURNVALUE=
| None |RETURNVALUE=
____________________________________________________________________________________________


|x1= <code><nowiki>[</nowiki>[[findDisplay]] 46,36,5, {[[hint]] "Key 'J' pressed for 5 seconds"}] [[call]] [[BIS_fnc_holdKey]]; // Action is added to the mission display</code> |EXAMPLE1=
|x1= <code><nowiki>[</nowiki>[[findDisplay]] 46,36,5, {[[hint]] "Key 'J' pressed for 5 seconds"}] [[call]] [[BIS_fnc_holdKey]]; // Action is added to the mission display</code> |EXAMPLE1=
____________________________________________________________________________________________


| [[BIS_fnc_holdActionAdd]], [[addAction]] |SEEALSO=
| [[BIS_fnc_holdActionAdd]], [[addAction]] |SEEALSO=

Revision as of 00:15, 17 January 2021

Hover & click on the images for description

Description

Description:
Function that executes a user-defined code when a key has been held down for a long enough time.
Execution:
call
Groups:
Interaction

Syntax

Syntax:
[display, key, time, code, control] call BIS_fnc_holdKey
Parameters:
Display - display - Display the event is attached to (map display is default).
Number - key - What key to press.
Number - time - how long the key has to be held down in seconds.
Code - code - Code to be executed when key is held down for long enough.
Control - control - Optional - text control to be used in place of the default "Press X to skip" control.
Return Value:
None

Examples

Example 1:
[findDisplay 46,36,5, {hint "Key 'J' pressed for 5 seconds"}] call BIS_fnc_holdKey; // Action is added to the mission display

Additional Information

See also:
BIS_fnc_holdActionAddaddAction

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

Notes