BIS_fnc_keyHold

Description

Allows for hold button interactions. Hold action is started by pressing Space.

Syntax

[description, duration, condition, arguments, loaded] spawn BIS_fnc_keyHold

Parameters:

• description: String - description of the performed action, displayed inside the progress bar.
• duration: Number - (Optional, default 2) action duration
• condition: Code or String - (Optional, default { true }) condition that must be met for the action to display
• arguments: Array - (Optional, default []) arguments passed to the condition
• loaded: Boolean - (Optional, default false) defines if function is already loaded. This is handled by the function

Returns: - spawn: Script Handle

• call: true if action was successful or false if it was interrupted.

Examples

Example 1

["Hold that key!", 2, { alive player }] spawn BIS_fnc_keyHold;

Example 2

Function can be called in scheduled environment to return values and be used for further code execution.

0 spawn {
    private _success = ["Hold that key!", 2, { alive player }] call BIS_fnc_keyHold;
    if (_success) then { hint "Function executed" } else { hint "Function interrupted" };
};

See also

BIS_fnc_holdActionAdd · BIS_fnc_holdKey