BIS fnc holdKey: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (game version changed from arma3 dev to arma3, v1.79 to 1.78 (patch version), see https://dev.arma3.com/post/spotrep-00076)
No edit summary
Line 35: Line 35:
</dl>
</dl>
<!-- DISCONTINUE Notes -->
<!-- DISCONTINUE Notes -->
This function does actually return something.<br>
Returns: True if the action was successful, false if it was interrupted.

Revision as of 02:38, 1 April 2018


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

This function does actually return something.
Returns: True if the action was successful, false if it was interrupted.