BIS fnc keyHold: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<code>([^<]*)\[\[([a-zA-Z][a-zA-Z0-9_]+)\]\]([^<]*) *<\/code>" to "<code>$1$2$3</code>")
m (Some wiki formatting)
 
(5 intermediate revisions by 2 users not shown)
Line 8: Line 8:
|eff= local
|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) Duration of the action
|p2= duration: [[Number]] - (Optional, default 2) action duration


|p3= condition: [[Code]] or [[String]] - (Optional, default {[[true]]}) Condition that must be met for the action to display
|p3= condition: [[Code]] or [[String]] - (Optional, default <sqf inline>{ true }</sqf>) condition that must be met for the action to display


|p4= arguments: [[Array]] - (Optional, default []) Arguments passed to the condition
|p4= arguments: [[Array]] - (Optional, default <sqf inline>[]</sqf>) 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= [[Nothing]]
|r1=
* [[spawn]]: [[Script Handle]]
* [[call]]: [[true]] if action was successful or [[false]] if it was interrupted.


|x1= <code>["Hold that key!",2,{alive [[player]]}] [[spawn]] [[BIS_fnc_keyHold]];</code>
|x1= <sqf>["Hold that key!", 2, { alive player }] spawn BIS_fnc_keyHold;</sqf>
 
|x2= Function can be called in [[Scheduler#Scheduled_Environment|scheduled environment]] to return values and be used for further code execution.
<sqf>
0 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
|exec= spawn


|seealso= [[BIS_fnc_holdActionAdd]]
|seealso= [[BIS_fnc_holdActionAdd]] [[BIS_fnc_holdKey]]
}}
}}

Latest revision as of 13:59, 24 May 2023

Arma 3 logo black.png1.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:

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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_keyHold&oldid=341362"