BIS fnc CPWaitUntil: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Fix example)
m (Text replacement - "(\|p[0-9]+ *= *[^(]+\(Optional(, default[^)]*)\) )I([a-z])" to "$1i$3")
 
(15 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|Comments=
{{RV|type=function


| arma3 |Game name=
|game1= arma3
|version1= 1.72


|1.72|Game version=
|gr1= CombatPatrol


|gr1 = CombatPatrol |GROUP1=
|gr2= Program Flow


|gr2 = Program Flow |GROUP2=
|descr= Function waits until condition becomes true. Condition is checked with given interval.


<!---|arg= local |Multiplayer Arguments=--->
|s1= [condition, interval] spawn [[BIS_fnc_CPWaitUntil]]


<!---|eff= local |Multiplayer Effects=--->
|p1= condition: [[Code]] - (Optional, default <sqf inline>{ true }</sqf>) condition to be checked


| Function waits until condition becomes true. Condition is checked with given interval. |Description=
|p2= interval: [[Number]] - (Optional, default 0.5) interval in which the condition will be checked


|[condition, interval] spawn [[BIS_fnc_CPWaitUntil]] |Syntax=
|r1= [[Nothing]]


|p1= condition: [[Code]] - (Optional, default {{Inline code|{ [[true]] }<nowiki/>}}) Condition to be checked |Parameter 1=
|x1= <sqf>[{ not alive player }, 2] spawn BIS_fnc_CPWaitUntil;</sqf>


|p2= interval: [[Number]] - (Optional, default 0.5) Interval in which the condition will be checked |Parameter 2=
|exec= spawn


| [[Nothing]] |Return value=
|seealso= [[waitUntil]]
 
|x1= <code>[<nowiki/>{ [[not]] [[alive]] [[player]] }, 2] [[spawn]] [[BIS_fnc_CPWaitUntil]];</code>|Example 1=
 
|exec= spawn |Execution=
 
| [[waitUntil]] |See also=
}}
}}

Latest revision as of 12:29, 8 November 2023

Hover & click on the images for description

Description

Description:
Function waits until condition becomes true. Condition is checked with given interval.
Execution:
spawn
Groups:
CombatPatrolProgram Flow

Syntax

Syntax:
[condition, interval] spawn BIS_fnc_CPWaitUntil
Parameters:
condition: Code - (Optional, default { true }) condition to be checked
interval: Number - (Optional, default 0.5) interval in which the condition will be checked
Return Value:
Nothing

Examples

Example 1:
[{ not alive player }, 2] spawn BIS_fnc_CPWaitUntil;

Additional Information

See also:
waitUntil

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