BIS fnc holdKey: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (template:command argument fix)
Line 13: Line 13:
|[display, key, time, code, control] call '''BIS_fnc_holdKey'''|SYNTAX=
|[display, key, time, code, control] call '''BIS_fnc_holdKey'''|SYNTAX=


|p1= [[Display]] - display  - Display the event is attached to (map display is default).|= Parameter 1
|p1= [[Display]] - display  - Display the event is attached to (map display is default).|PARAMETER1=
|p2= [[Number]] - key  - What key to press.|= Parameter 2
|p2= [[Number]] - key  - What key to press.|PARAMETER2=
|p3= [[Number]] - time  - how long the key has to be held down in seconds.|= Parameter 3
|p3= [[Number]] - time  - how long the key has to be held down in seconds.|PARAMETER3=
|p4= [[Code]] - code  - Code to be executed when key is held down for long enough.|= Parameter 4
|p4= [[Code]] - code  - Code to be executed when key is held down for long enough.|PARAMETER4=
|p5= [[Control]] - control - Optional - text control to be used in place of the default "Press X to skip" control.|= Parameter 5
|p5= [[Control]] - control - Optional - text control to be used in place of the default "Press X to skip" control.|PARAMETER5=


| 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> |= Example 1
|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=
____________________________________________________________________________________________
____________________________________________________________________________________________



Revision as of 15:30, 7 April 2019


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

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