BIS fnc keyHold: Difference between revisions

Latest revision as of 13:59, 24 May 2023

1.00

LELocal

Hover & click on the images for description

Description

Description:: Allows for hold button interactions. Hold action is started by pressing Space.
Execution:: spawn
Groups:: Interaction

Syntax

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

Return Value:

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" }; };

Additional Information

See also:: BIS_fnc_holdActionAdd BIS_fnc_holdKey

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

@@ Line 1: / Line 1: @@
-{{Function
+{{RV|type=function
 |game1= arma3
 |version1= 1.00
-|gr1 = Interaction
+|gr1= Interaction
 |eff= local
-|descr= Allows for hold button interactions. Hold action is started by pressing the space bar.
+|descr= Allows for hold button interactions. Hold action is started by pressing {{Controls|Space}}.
+|s1= [description, duration, condition, arguments, loaded] spawn [[BIS_fnc_keyHold]]
-|s1= [description, duration, condition, arguments, loaded] [[spawn]] [[BIS_fnc_keyHold]]
+|p1= description: [[String]] - description of the performed action, displayed inside the progress bar.
-|p1= description: [[String]] - Description of the performed action, displayed inside the progress bar.
+|p2= duration: [[Number]] - (Optional, default 2) action duration
-|p2= duration: [[Number]] - (Optional, default 2) Duration of the action
+|p3= condition: [[Code]] or [[String]] - (Optional, default <sqf inline>{ true }</sqf>) condition that must be met for the action to display
-|p3= condition: [[Code]] or [[String]] - (Optional, default {[[true]]}) Condition that must be met for the action to display
+|p4= arguments: [[Array]] - (Optional, default <sqf inline>[]</sqf>) arguments passed to the condition
-|p4= arguments: [[Array]] - (Optional, default []) Arguments passed to the condition
+|p5= loaded: [[Boolean]] - (Optional, default [[false]]) defines if function is already loaded. This is handled by the function
-|p5= loaded: [[Boolean]] - (Optional, default [[false]]) Defines if function is already loaded. This is handled by the function
+|r1=
+* [[spawn]]: [[Script Handle]]
+* [[call]]: [[true]] if action was successful or [[false]] if it was interrupted.
-|r1= [[Nothing]]
+|x1= <sqf>["Hold that key!", 2, { alive player }] spawn BIS_fnc_keyHold;</sqf>
-|x1= <code>["Hold that key!",2,{[[alive]] [[player]]}] [[spawn]] [[BIS_fnc_keyHold]];</code>
+|x2= Function can be called in [[Scheduler#Scheduled_Environment|scheduled environment]] to return values and be used for further code execution.
+<sqf>
+spawn {
+	private _success = ["Hold that key!", 2, { alive player }] call BIS_fnc_keyHold;
+	if (_success) then { hint "Function executed" } else { hint "Function interrupted" };
+};
+</sqf>
 |exec= spawn
-|seealso= [[BIS_fnc_holdActionAdd]]
+|seealso= [[BIS_fnc_holdActionAdd]] [[BIS_fnc_holdKey]]
 }}
-[[Category:Functions|{{uc:keyHold}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:keyHold}}]]