BIS fnc holdKey: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "(optional, default " to "(Optional, default ")
m (Text replacement - " +(spawn|call) +'''([a-zA-Z0-9_]+)'''[ ]* " to " $1 $2 ")
Line 9: Line 9:
|descr= Function that executes a user-defined code when a key has been held down for a long enough time.
|descr= Function that executes a user-defined code when a key has been held down for a long enough time.


|s1= [display, key, time, code, control] call '''BIS_fnc_holdKey'''
|s1= [display, key, time, code, control] call [[BIS_fnc_holdKey]]


|p1= display: [[Display]] - Display the event is attached to. By default it is the map display
|p1= display: [[Display]] - Display the event is attached to. By default it is the map display

Revision as of 16:17, 12 June 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. By default it is the map display
key: Number - What key to press. See DIK KeyCodes
time: Number - 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. canSuspend returns true inside the code
control: Control - (Optional, default controlNull - Text control to be used in place of the default "Press X to skip" control.
Return Value:
Nothing

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