for: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "]]<dd class="note">" to "]]</dt> <dd class="note">")
m (Text replacement - "{{arma2}}" to "{{GameCategory|arma2|link= y}}")
 
(10 intermediate revisions by 3 users not shown)
Line 19: Line 19:


|descr= This operator creates a [[For Type]] which is used in the for-constructs.
|descr= This operator creates a [[For Type]] which is used in the for-constructs.
{{Feature|important|Alternative syntax {{ic|[[for]] ''array'' [[do]] ''code''}} is [[Code_Optimisation#for|slower]] than the alternative because the condition is checked every iteration.}}
{{Feature|warning|
The alternative syntax <sqf inline>for _array do _code</sqf> is [[Code Optimisation#for|slower]] than the first syntax because the condition is checked in every iteration, and it has a few bugs.<br>
It is only kept for backward compatibility; always use the first syntax <sqf inline>for "_i" from 0 to _end do _code</sqf>.
}}


|pr= {{Feature|arma2|There is an [[{{arma2}}]] issue (not present in {{Name|arma2oa|short}} nor in {{arma3}}) where having a capital letter in the variable name '''will''' throw an error:
|pr= {{Feature|arma2|There is an {{GameCategory|arma2|link= y}} issue (not present in {{Name|arma2oa|short}} nor in {{arma3}}) where having a capital letter in the variable name '''will''' throw an error:
<code>[[for]] "_i" [[from]] 0 [[to]] 2 [[do]] { [[hintSilent]] [[str]] _i; }; {{cc|works}}<br><!--
<sqf>
-->[[for]] "_I" [[from]] 0 [[to]] 2 [[do]] { [[hintSilent]] [[str]] _I; }; {{cc|"variable _i is not defined" error}}</code>}}
for "_i" from 0 to 2 do { hintSilent str _i; }; // works
for "_I" from 0 to 2 do { hintSilent str _I; }; // "variable _i is not defined" error
</sqf>
}}


|s1= [[for]] arguments
|s1= [[for]] arguments
Line 39: Line 45:
|r2= [[For Type]]
|r2= [[For Type]]


|x1= <code>{{cc|will output 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 (the to value being inclusive)}}
|x1= <sqf>
[[for]] "_i" [[from]] 1 [[to]] 10 [[do]] { [[systemChat]] [[str]] _i; };</code>
// will output 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 (the to value being inclusive)
for "_i" from 1 to 10 do { systemChat str _i; };
</sqf>
 
|x2= <sqf>
// will output 9, 7, 5, 3, 1
for "_i" from 9 to 1 step -2 do { systemChat str _i; };
</sqf>


|x2= <code>[[for]] "_i" [[from]] 9 [[to]] 1 [[step]] -2 [[do]] { [[systemChat]] [[str]] _i; };</code>
|x3= <sqf>
// will output 0, 1, 2, 3, 4, 5, 6, 7, 8, 9
for [{ _i = 0 }, { _i < 10 }, { _i = _i + 1 }] do { systemChat str _i };
</sqf>


|x3= <code>[[for]] [{ _i = 0 }, { _i < 10 }, { _i = _i + 1 }] [[do]] { [[systemChat]] [[str]] _i };</code>
|x4= <sqf>
// BAD CODE
_i = 100;
for [{ _i = 0 }, { _i < 5 }, { _i = _i + 1 }] do { /* code */ };
hint str _i; // 5


|x4= <code>{{cc|BAD CODE}}
// GOOD CODE (private keyword is recommended)
_i = 100;  
_i = 100;
[[for]] [{_i = 0}, {_i < 5}, {_i = _i + 1}] [[do]] {};  
for [{ private _i = 0 }, { _i < 5 }, { _i = _i + 1 }] do { /* code */ };
[[hint]] [[str]] _i; {{cc|5}}
hint str _i; // 100


{{cc|GOOD CODE ([[private]] keyword is recommended)}}
// BEST CODE (primary syntax, fastest)
_i = 100;  
_i = 100;
[[for]] [{[[private]] _i = 0}, {_i < 5}, {_i = _i + 1}] [[do]] {};  
for "_i" from 0 to 4 do { /* code */ };
[[hint]] [[str]] _i; {{cc|100}}</code>
hint str _i; // 100
</sqf>


|seealso= [[Control Structures]], [[while]], [[do]]
|seealso= [[Control Structures]] [[while]] [[do]]
}}
}}


<dl class="command_description">
{{Note
|user= Alef
|timestamp= 20100429160600
|text= <sqf>
for "_i" from 0 to  0 do {}; // will do once, with _i = 0
for "_i" from 0 to -1 do {}; // will not do
</sqf>
}}


<dt><dt>
{{Note
<dd class="notedate">Posted on 29 April 2010 (CEST)</dd>
|user= ffur2007slx2_5
<dt class="note">[[User:Alef|alef]]</dt>
|timestamp= 20140415125400
<dd class="note"><code>[[for]] "_i" [[from]] 0 [[to]]  0 [[do]] {}; {{cc|will do once, with _i {{=}} 0}}
|text= <nowiki/>
[[for]] "_i" [[from]] 0 [[to]] -1 [[do]] {}; {{cc|will not do}}
* {{GVI|arma 3|1.16}} Please note the difference between the two syntaxes; {{hl|[[for]] ''arguments''}} detects Boolean in each scope while {{hl|[[for]] ''array''}} doesn’t. e.g.
</code>
{{{!}} class="wikitable"
</dd>
 
<dt><dt>
<dd class="notedate">Posted on Apr 15, 2014 - 12:54</dd>
<dt class="note">[[User:ffur2007slx2_5|ffur2007slx2_5]]</dt>
<dd class="note">
 
* {{GVI|arma 3|1.16}} Please note the difference between the two syntaxes; {{ic|[[for]] ''arguments''}} detects Boolean in each scope while {{ic|[[for]] ''array''}} doesn’t. e.g.
{| class="wikitable"
! command
! command
! Structure
! Structure
! Summary
! Summary
|-
{{!}}-
| [[for]]&nbsp;''array''
{{!}} [[for]]&nbsp;''array''
|
{{!}}
a = 0; b = [[true]];
<sqf>
[[for]] [{ _i = 0 }, { _i < 10 && b }, { _i = _i + 1 }] [[do]] {
a = 0; b = true;
a = a + 1;  
for [{ _i = 0 }, { _i < 10 && b }, { _i = _i + 1 }] do
[[if]] (a >= 7) [[then]] {b = [[false]]}
{
}
a = a + 1;
| loop can be exited via [[Boolean]] control, possible workaround can be e.g [[BIS_fnc_areEqual]]
if (a >= 7) then {b = false}
|-
};
|[[for]]&nbsp;''arguments''
</sqf>
|
{{!}} loop can be exited via [[Boolean]] control, possible workaround can be e.g [[BIS_fnc_areEqual]]
a = 0;
{{!}}-
[[for]] "_i" [[from]] 0 [[to]] 10 [[do]] {
{{!}} [[for]]&nbsp;''arguments''
a = a + 1;
{{!}}
[[if]] (a >= 7) [[exitwith]] {}
<sqf>
};
a = 0;
| has to be exited via [[exitWith]]
for "_i" from 0 to 10 do
{
a = a + 1;
if (a >= 7) exitwith {};
};
</sqf>
{{!}} has to be exited via [[exitWith]]


|}
{{!}}}
* Never try to tell a decimal number via binary number in a loop; otherwise the loop will be infinite:
* Never try to tell a decimal number via binary number in a loop; otherwise the loop will be infinite:
<code>[[for]] [{_a = 0},{_a != 1},{_a = _a + 0.1}] [[do]] {}; {{cc|an infinite loop; _a will never be 1 so the scope will always be true}}</code>
<sqf>for [{_a = 0},{_a != 1},{_a = _a + 0.1}] do {}; // an infinite loop; _a will never be 1 so the scope will always be true</sqf>
Any binary number behind the decimal point is always the sum of 1/2, 1/4, 1/8, 1/16 etc. so decimal number with odd denominator like 1/3 or 1/10 cannot be exactly equal to each other.
Any binary number behind the decimal point is always the sum of 1/2, 1/4, 1/8, 1/16 etc. so decimal number with odd denominator like 1/3 or 1/10 cannot be exactly equal to each other.
* Avoid too large factorial multiply which may loose the leading indicator in result. And 12 is the biggest accessable factor in this example.
* Avoid too large factorial multiply which may loose the leading indicator in result. And 12 is the biggest accessable factor in this example.
<code>[[for]] [{_a = 2; _b = 1;},{_a < 100},{_a = _a + 1}] [[do]] {_b = _b * _a}; {{cc|_b {{=}} 1.#INF}}</code>
<sqf>for [{_a = 2; _b = 1;},{_a < 100},{_a = _a + 1}] do {_b = _b * _a}; // _b = 1.#INF</sqf>
</dd>
}}


<dt><dt>
{{Note
<dd class="notedate">Posted on June 4, 2015 - 19:27 (UTC)</dd>
|user= Killzone_Kid
<dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt>
|timestamp= 20150604192700
<dd class="note">
|text= Variable name doesn't have to start with _. could be:
Variable name doesn't have to start with _. could be:<code>[[for]] "LAlala" [[from]] 0 [[to]] 0 [[do]] {[[hint]] [[str]] LAlala}; {{cc|0}}</code>
<sqf>for "LAlala" from 0 to 0 do { hint str LAlala }; // 0</sqf>
The variable ''LAlala'' will exist only inside [[do]] {} scope and will not overwrite any variable of the same name that existed before.
The variable ''LAlala'' will exist only inside [[do]] {} scope and will not overwrite any variable of the same name that existed before.
</dd>
}}


<dt><dt>
{{Note
<dd class="notedate">Posted on June 4, 2015 - 19:45 (UTC)</dd>
|user= Nickorr
<dt class="note">[[User:Nickorr|Nickorr]]</dt>
|timestamp= 20150604194500
<dd class="note">
|text= Dont use this notation if you plan to change the cycle ranges dynamically. The range values are checked only before the cycle started. Use {{hl|[[for]] ''array''}} instead. <br>
Dont use this notation if you plan to change the cycle ranges dynamically. The range values are checked only before the cycle started. Use {{ic|[[for]] ''array''}} instead. <br>


Example, that won't work correctly:
Example, that won't work correctly:
<code><nowiki>_xy = [1,2,3,4,5,6,7,8,9,10];
<sqf>
for "_i" from 0 to (count _xy - 1) do {
_xy = [1,2,3,4,5,6,7,8,9,10];
if ( _xy select _i == 3 ) then {
for "_i" from 0 to (count _xy - 1) do
{
if ( _xy select _i == 3 ) then
{
_xy deleteAt _i;
_xy deleteAt _i;
_i = _i - 1;
_i = _i - 1;
};
};
};</nowiki></code>
};
(Here the <tt><nowiki>_i = 9</nowiki></tt> step will still be checked by the cycle, which will lead to "out of the array range" error.) <br>
</sqf>
(Here the {{hl|c= <nowiki>_i = 9</nowiki>}} step will still be checked by the cycle, which will lead to "out of the array range" error.) <br>
This code will work correctly:
This code will work correctly:
<code>_xy = [1,2,3,4,5,6,7,8,9,10];
<sqf>
for [{_i = 1},{_i<=(count _xy - 1)},{_i=_i+1}] do {
_xy = [1,2,3,4,5,6,7,8,9,10];
if ( _xy select _i == 3 ) then {
for [{_i = 1},{_i<=(count _xy - 1)},{_i=_i+1}] do
{
if ( _xy select _i == 3 ) then
{
_xy deleteAt _i;
_xy deleteAt _i;
_i = _i - 1;
_i = _i - 1;
};
};
};</code>
};
(The last step here will be <tt><nowiki>_i = 8</nowiki></tt> with array looking like this: <tt><nowiki>[1,2,4,5,6,7,8,9,10]</nowiki></tt>)
</sqf>
</dd>
(The last step here will be {{hl|_i {{=}} 8}} with array looking like this: {{hl|[1,2,4,5,6,7,8,9,10]}})
}}


<dt><dt>
{{Note
<dd class="notedate">Posted on January 29, 2016 - 05:18 (UTC)</dd>
|user= DreadedEntity
<dt class="note">[[User:DreadedEntity|DreadedEntity]]</dt>
|timestamp= 20160129051800
<dd class="note">
|text= For loops can be safely nested. This means that there should not be any problems with recursion.
For loops can be safely nested. This means that there should not be any problems with recursion.
<sqf>
<code>_array = [];
_array = [];
[[for]] "_i" from 0 to 3 do
for "_i" from 0 to 3 do
{
{
[[for]] "_i" from 0 to 3 do
for "_i" from 0 to 3 do
{
{
_array [[pushBack]] _i;
_array pushBack _i;
};
};
_array [[pushBack]] _i;
_array pushBack _i;
};
};
[[hint]] [[str]] _array;</code>
hint str _array;
</dd>
</sqf>
 
}}
</dl>

Latest revision as of 13:01, 19 March 2024

Hover & click on the images for description

Description

Description:
This operator creates a For Type which is used in the for-constructs.
The alternative syntax for _array do _code is slower than the first syntax because the condition is checked in every iteration, and it has a few bugs.
It is only kept for backward compatibility; always use the first syntax for "_i" from 0 to _end do _code.
Problems:
Arma 2
There is an Arma 2 issue (not present in Arma 2:OA nor in Arma 3) where having a capital letter in the variable name will throw an error:
for "_i" from 0 to 2 do { hintSilent str _i; }; // works for "_I" from 0 to 2 do { hintSilent str _I; }; // "variable _i is not defined" error
Groups:
Program Flow

Syntax

Syntax:
for arguments
Parameters:
arguments: String - declares the index variable name like "_myVar". from and to are required, step is optional.
Return Value:
For Type

Alternative Syntax

Syntax:
for [init, condition, codeToExecute]
Parameters:
init: Code - loop variable definition
condition: Code - called code returns false, leave the for-loop
codeToExecute: Code - code to be run on each loop
Return Value:
For Type

Examples

Example 1:
// will output 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 (the to value being inclusive) for "_i" from 1 to 10 do { systemChat str _i; };
Example 2:
// will output 9, 7, 5, 3, 1 for "_i" from 9 to 1 step -2 do { systemChat str _i; };
Example 3:
// will output 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 for [{ _i = 0 }, { _i < 10 }, { _i = _i + 1 }] do { systemChat str _i };
Example 4:
// BAD CODE _i = 100; for [{ _i = 0 }, { _i < 5 }, { _i = _i + 1 }] do { /* code */ }; hint str _i; // 5 // GOOD CODE (private keyword is recommended) _i = 100; for [{ private _i = 0 }, { _i < 5 }, { _i = _i + 1 }] do { /* code */ }; hint str _i; // 100 // BEST CODE (primary syntax, fastest) _i = 100; for "_i" from 0 to 4 do { /* code */ }; hint str _i; // 100

Additional Information

See also:
Control Structures while 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
Alef - c
Posted on Apr 29, 2010 - 16:06 (UTC)
for "_i" from 0 to 0 do {}; // will do once, with _i = 0 for "_i" from 0 to -1 do {}; // will not do
ffur2007slx2_5 - c
Posted on Apr 15, 2014 - 12:54 (UTC)
  • Arma 3 logo black.png1.16 Please note the difference between the two syntaxes; for arguments detects Boolean in each scope while for array doesn’t. e.g.
command Structure Summary
for array

a = 0; b = true; for [{ _i = 0 }, { _i < 10 && b }, { _i = _i + 1 }] do { a = a + 1; if (a >= 7) then {b = false} };

loop can be exited via Boolean control, possible workaround can be e.g BIS_fnc_areEqual
for arguments

a = 0; for "_i" from 0 to 10 do { a = a + 1; if (a >= 7) exitwith {}; };

has to be exited via exitWith
  • Never try to tell a decimal number via binary number in a loop; otherwise the loop will be infinite:

for [{_a = 0},{_a != 1},{_a = _a + 0.1}] do {}; // an infinite loop; _a will never be 1 so the scope will always be true
Any binary number behind the decimal point is always the sum of 1/2, 1/4, 1/8, 1/16 etc. so decimal number with odd denominator like 1/3 or 1/10 cannot be exactly equal to each other.

  • Avoid too large factorial multiply which may loose the leading indicator in result. And 12 is the biggest accessable factor in this example.

for [{_a = 2; _b = 1;},{_a < 100},{_a = _a + 1}] do {_b = _b * _a}; // _b = 1.#INF

Killzone_Kid - c
Posted on Jun 04, 2015 - 19:27 (UTC)
Variable name doesn't have to start with _. could be:
for "LAlala" from 0 to 0 do { hint str LAlala }; // 0
The variable LAlala will exist only inside do {} scope and will not overwrite any variable of the same name that existed before.
Nickorr - c
Posted on Jun 04, 2015 - 19:45 (UTC)
Dont use this notation if you plan to change the cycle ranges dynamically. The range values are checked only before the cycle started. Use for array instead.
Example, that won't work correctly:
_xy = [1,2,3,4,5,6,7,8,9,10]; for "_i" from 0 to (count _xy - 1) do { if ( _xy select _i == 3 ) then { _xy deleteAt _i; _i = _i - 1; }; };
(Here the _i = 9 step will still be checked by the cycle, which will lead to "out of the array range" error.)
This code will work correctly:
_xy = [1,2,3,4,5,6,7,8,9,10]; for [{_i = 1},{_i<=(count _xy - 1)},{_i=_i+1}] do { if ( _xy select _i == 3 ) then { _xy deleteAt _i; _i = _i - 1; }; };
(The last step here will be _i = 8 with array looking like this: [1,2,4,5,6,7,8,9,10])
DreadedEntity - c
Posted on Jan 29, 2016 - 05:18 (UTC)
For loops can be safely nested. This means that there should not be any problems with recursion.
_array = []; for "_i" from 0 to 3 do { for "_i" from 0 to 3 do { _array pushBack _i; }; _array pushBack _i; }; hint str _array;