BIS fnc CPWaitUntil: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Fix example)
m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)
Line 1: Line 1:
{{Function|Comments=
{{Function


| arma3 |Game name=
| arma3


|1.72|Game version=
|1.72


|gr1 = CombatPatrol |GROUP1=
|gr1 = CombatPatrol


|gr2 = Program Flow |GROUP2=
|gr2 = Program Flow


<!---|arg= local |Multiplayer Arguments=--->
<!---|arg= local |Multiplayer Arguments=--->
Line 13: Line 13:
<!---|eff= local |Multiplayer Effects=--->
<!---|eff= local |Multiplayer Effects=--->


| Function waits until condition becomes true. Condition is checked with given interval. |Description=
| Function waits until condition becomes true. Condition is checked with given interval.


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


|p1= condition: [[Code]] - (Optional, default {{Inline code|{ [[true]] }<nowiki/>}}) Condition to be checked |Parameter 1=
|p1= condition: [[Code]] - (Optional, default {{Inline code|{ [[true]] }<nowiki/>}}) Condition to be checked


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


| [[Nothing]] |Return value=
| [[Nothing]]


|x1= <code>[<nowiki/>{ [[not]] [[alive]] [[player]] }, 2] [[spawn]] [[BIS_fnc_CPWaitUntil]];</code>|Example 1=
|x1= <code>[<nowiki/>{ [[not]] [[alive]] [[player]] }, 2] [[spawn]] [[BIS_fnc_CPWaitUntil]];</code>


|exec= spawn |Execution=
|exec= spawn |Execution=


| [[waitUntil]] |See also=
| [[waitUntil]]
}}
}}

Revision as of 23:05, 17 January 2021

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