while: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Moved KK's note about unscheduled 10000 iteration limitation into description)
 
(59 intermediate revisions by 9 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| ofpr |= Game name
|game1= ofp
|version1= 1.85


|1.85|= Game version
|game2= ofpe
____________________________________________________________________________________________
|version2= 1.00


| Repeat '''[[Code]]''' while condition is [[true]]. |= Description
|game3= arma1
____________________________________________________________________________________________
|version3= 1.00


| '''while''' condition |= Syntax
|game4= arma2
|version4= 1.00


|p1= condition: [[Code]]
|game5= arma2oa
|version5= 1.50
 
|game6= tkoh
|version6= 1.00


| [[While Type]] |= Return value
|game7= arma3
____________________________________________________________________________________________
|version7= 0.50
 
|x1= <code>[[while]] "a>b" '''[[do]]''' {a<nowiki>=</nowiki>a+1} </code>
|x2=A practical example: Repair all members of a group to such a level that they are able to stand up: <code><nowiki>{</nowiki><br>&nbsp;&nbsp;while <nowiki>{</nowiki>([[not]] [[canStand]] _x) [[and]] ([[alive]] _x)<nowiki>}</nowiki> [[do]] <nowiki>{</nowiki><br>&nbsp;&nbsp;&nbsp;&nbsp;_x [[setDammage]] ([[getDammage]] _x) - 0.01;<br>&nbsp;&nbsp;<nowiki>};</nowiki><br><nowiki>}</nowiki> [[forEach]] units [[group]] unitname; </code> |= Example 2____________________________________________________________


| [[Control Structures]], [[waitUntil]] |= See also
|gr1= Program Flow


|descr= Repeats [[Code]] while the given condition is [[true]]. A part of [[while]]-[[do]] construct.
{{Feature | Important |
* A [[while]] loop does not have any suspension, meaning that if used in [[Scheduler#Scheduled_Environment|scheduled environment]] without any suspension ([[sleep]] or [[uiSleep]]) the code will run multiple times per frame and consumes the 3 ms per frame scheduler execution limit. This should be avoided if not intended (see {{Link|#Example 3}}).
* In [[Scheduler#Unscheduled_Environment|non-scheduled environment]], [[while]] [[do]] loop is limited to 10,000 iterations, after which it exits even if condition is still [[true]].
}}
}}
|s1= [[while]] condition


<h3 style="display:none">Notes</h3>
|p1= condition: [[Code]]
<dl class="command_description">
<!-- Note Section BEGIN -->


<dd class="notedate">Posted on May 14, 2008
|r1= [[While Type]]
<dt class="note">'''[[User:Kronzky|Kronzky]]'''
<dd class="note">The boolean code that's used to evaluate the while condition can be preceded by code that executes a regular command.<br>
e.g. while {_a=_a+1; _a<10} do {...}


<dd class="notedate">Posted on January 2, 2012
|x1= <sqf>while { a < b } do { a = a + 1 };</sqf>
<dt class="note">'''[[User:Lucky44|Lucky44]]'''
<dd class="note">Different than in IF statements, the condition in a WHILE loop can use curly braces not parentheses, unless it has multiple conditions, as shown above. So this will be a problem: while (variable1 == "wait") do...  But this will work: while {variable1 == "wait"} do... <br>


|x2= A practical example: Repair all members of a group to such a level that they are able to stand up:
<sqf>
{
if (alive _x) then
{
while { not canStand _x } do
{
_x setDamage (damage _x - 0.01);
};
};
} forEach units group unitname;
</sqf>


<!-- Note Section END -->
|x3= <sqf>
</dl>
[] spawn {
// warning: while loop without suspension executes multiple times per frame
private _counter = 0;
private _endTime = diag_tickTime + 5;
private _frameNo = diag_frameNo;
while { diag_tickTime < _endTime } do
{
_counter = _counter + 1;
};
// in an empty mission, the _counter may go well over 2000 times per frame!
hint format ["Average Execution: %1 times per frame", _counter / (diag_frameNo - _frameNo)];


<h3 style="display:none">Bottom Section</h3>
// with suspension
private _counter = 0;
private _endTime = diag_tickTime + 5;
private _frameNo = diag_frameNo;
while { diag_tickTime < _endTime } do
{
_counter = _counter + 1;
uiSleep 0.001; // waits at least 1 frame
};
// _counter says one per frame, as expected
hint format ["Average Execution: %1 times per frame", _counter / (diag_frameNo - _frameNo)];
};
</sqf>


|seealso= [[Control Structures]] [[waitUntil]] [[for]] [[do]]
}}


[[Category:Scripting Commands|WHILE]]
{{Note
[[Category:Scripting Commands OFP 1.96|WHILE]]
|user= Kronzky
[[Category:Scripting Commands ArmA|WHILE]]
|timestamp= 20080514084000
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
|text= The boolean code that is used to evaluate the while condition can be preceded by code that executes a regular command.
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
<sqf>while { _a =_a + 1; _a < 10 } do { /* ... */ };</sqf>
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
}}
[[Category:ArmA: Control Structures|WHILE]]
[[Category:Command Group: Program Flow|WHILE]]

Latest revision as of 08:52, 7 November 2023

Logo A0.png1.85ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
Hover & click on the images for description

Description

Description:
Repeats Code while the given condition is true. A part of while-do construct.
⚠
  • A while loop does not have any suspension, meaning that if used in scheduled environment without any suspension (sleep or uiSleep) the code will run multiple times per frame and consumes the 3 ms per frame scheduler execution limit. This should be avoided if not intended (see Example 3).
  • In non-scheduled environment, while do loop is limited to 10,000 iterations, after which it exits even if condition is still true.
Groups:
Program Flow

Syntax

Syntax:
while condition
Parameters:
condition: Code
Return Value:
While Type

Examples

Example 1:
while { a < b } do { a = a + 1 };
Example 2:
A practical example: Repair all members of a group to such a level that they are able to stand up:
{ if (alive _x) then { while { not canStand _x } do { _x setDamage (damage _x - 0.01); }; }; } forEach units group unitname;
Example 3:
[] spawn { // warning: while loop without suspension executes multiple times per frame private _counter = 0; private _endTime = diag_tickTime + 5; private _frameNo = diag_frameNo; while { diag_tickTime < _endTime } do { _counter = _counter + 1; }; // in an empty mission, the _counter may go well over 2000 times per frame! hint format ["Average Execution: %1 times per frame", _counter / (diag_frameNo - _frameNo)]; // with suspension private _counter = 0; private _endTime = diag_tickTime + 5; private _frameNo = diag_frameNo; while { diag_tickTime < _endTime } do { _counter = _counter + 1; uiSleep 0.001; // waits at least 1 frame }; // _counter says one per frame, as expected hint format ["Average Execution: %1 times per frame", _counter / (diag_frameNo - _frameNo)]; };

Additional Information

See also:
Control Structures waitUntil for do

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
Kronzky - c
Posted on May 14, 2008 - 08:40 (UTC)
The boolean code that is used to evaluate the while condition can be preceded by code that executes a regular command.
while { _a =_a + 1; _a < 10 } do { /* ... */ };
Retrieved from "https://community.bistudio.com/wiki?title=while&oldid=347953"