forEach: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "</dd> <dt><dt>" to "</dd> <dt><dt>")
m (Text replacement - "Samatra" to "Sa-Matra")
 
(19 intermediate revisions by 2 users not shown)
Line 2: Line 2:


|game1= ofp
|game1= ofp
|version1= 1.00
|version1= 1.00


|game2= ofpe
|game2= ofpe
|version2= 1.00
|version2= 1.00


|game3= arma1
|game3= arma1
|version3= 1.00
|version3= 1.00


|game4= arma2
|game4= arma2
|version4= 1.00
|version4= 1.00


|game5= arma2oa
|game5= arma2oa
 
|version5= 1.50
|version5= 1.51


|game6= tkoh
|game6= tkoh
|version6= 1.00
|version6= 1.00


|game7= arma3
|game7= arma3
|version7= 0.50
|version7= 0.50


|gr1= Program Flow
|gr1= Program Flow
|gr2=Arrays
|gr2= Arrays
|gr3= HashMap
|gr3= HashMap


|descr= Executes the given command(s) on every item of an array. In {{arma2}} and later, the variable [[Magic Variables#x|_x]] is always [[private]] to the [[forEach]] block so it is safe to nest them.
|descr= Executes the given command(s) on every item of an [[Array]] or a [[HashMap]].
{{Feature|arma2|Since {{arma2}}, the variable [[Magic Variables#x|_x]] is always [[private]] to the [[forEach]] block so it is safe to nest them (see {{Link|#Example 8}}).}}


|s1= code [[forEach]] array
|s1= code [[forEach]] array


|p1= code: [[String]] in {{ofp}} and {{arma1}}, [[Code]] since {{arma1}} - The array item that is currently being iterated over is represented by <tt>[[Magic Variables#x|_x]]</tt>. The index of the current element is accessible via <tt>[[Magic Variables#_forEachIndex|_forEachIndex]]</tt>
|p1= <nowiki/>
{{{!}} class="wikitable align-center float-right"
! Game
{{!}} {{GVI|ofp|1.00}}
{{!}} {{GVI|arma1|1.00}}
{{!}} {{GVI|arma2|1.00}}
{{!}} {{GVI|arma2oa|1.50}}
{{!}} {{GVI|arma3|1.00}}
{{!}} {{GVI|tkoh|1.00}}
{{!}}-
! [[String]] support
{{!}} colspan="2" {{!}} {{Icon|checked}}
{{!}} colspan="4" {{!}} {{Icon|unchecked}}
{{!}}-
! [[Code]] support
{{!}} {{Icon|unchecked}}
{{!}} colspan="5" {{!}} {{Icon|checked}}
{{!}}}
code: [[String]] only in {{ofp}} and {{arma1}}, {{GVI|arma1|1.00|size= 0.75}} [[Code]] since {{arma1}} - available variables:
* {{hl|[[Magic Variables#x|_x]]}}: iterated item
* {{GVI|arma2oa|1.55|size= 0.75}} {{hl|[[Magic Variables#forEachIndex|_forEachIndex]]}}: item's index
 
|p2= array: [[Array]] - the array to iterate over


|p2= array: [[Array]] - The array to iterate over
|r1= [[Anything]] - will return the value of last executed statement


|r1= [[Anything]] - Will return the value of last executed statement
|s2= code [[forEach]] hashMap


|s2= code [[forEach]] hashMap {{Since|arma3|2.02}}
|s2since= arma3 2.02


|p21= code: [[Code]] - Code applied to each key-value pair. The [[Magic Variables|Magic Variable]] <tt>[[Magic Variables#x|_x]]</tt> contains the key, <tt>[[Magic Variables#x|_y]]</tt> the value
|p21= code: [[Code]] - code applied to each key-value pair - available variables:
* {{hl|[[Magic Variables#x|_x]]}}: key
* {{hl|[[Magic Variables#x|_y]]}}: value
* {{hl|[[Magic Variables#forEachIndex|_forEachIndex]]}}: iteration number


|p22= hashMap : [[HashMap]] - The HashMap to iterate over
|p22= hashMap : [[HashMap]] - the HashMap to iterate over


|r2= [[Anything]] - Will return the value of last executed statement
|r2= [[Anything]] - will return the value of last executed statement


|x1= <code>{{cc|SQF}}
|x1= <sqf>
{ [[Magic Variables#x|_x]] [[setDamage]] 1 } [[forEach]] [[units]] [[player]];</code>
// SQF
<code>{{codecomment|; SQS}}
{ _x setDamage 1 } forEach units player;
"[[Magic Variables#x|_x]] [[setDammage]] 1" [[forEach]] [[units]] [[player]]</code>
</sqf>
<sqs>
; SQS
"_x setDammage 1" forEach units player
</sqs>


|x2= This command can also easily be used to execute a single command multiple times without respect to the array items.
|x2= This command can also easily be used to execute a single command multiple times without respect to the array items - see also [[for]]
<code>{ [[player]] [[addMagazine]] "30Rnd_556x45_Stanag"; } [[forEach]] [1, 2, 3, 4];</code>
<sqf>
{ player addMagazine "30Rnd_556x45_Stanag" } forEach [1, 2, 3, 4];
// equivalent to
for "_i" from 1 to 4 do { player addMagazine "30Rnd_556x45_Stanag" };
</sqf>


|x3= You can also use multiple commands in the same block:
|x3= You can also use multiple commands in the same block:
<code>{
<sqf>
    [[Magic Variables|_x]] [[setCaptive]] [[true]];
{
    [[removeAllWeapons]] [[Magic Variables|_x]];
_x setCaptive true;
    [[doStop]] [[Magic Variables|_x]];
removeAllWeapons _x;
} [[forEach]] [[units]] [[group]] [[Magic Variables#this_2|this]];</code>
doStop _x;
} forEach units group this;
</sqf>


|x4= To get the index of a [[forEach]] loop, use [[Magic Variables#forEachIndex|_forEachIndex]]:
|x4= To get the index of a [[forEach]] loop, use [[Magic Variables#forEachIndex|_forEachIndex]]:
<code>{ [[systemChat]] [[str]] _forEachIndex]; } [[forEach]] [1,2,3]; {{cc|will return: "0", "1", "2" in [[systemChat]] messages}}</code>
<sqf>{ systemChat str _forEachIndex; } forEach ["a", "b", "c"]; // will return: "0", "1", "2" in systemChat messages</sqf>
 
|x5= Iterating a [[HashMap]] [[Magic Variables#forEachIndex|_forEachIndex]]:
<code>{ [[systemChat]] [[format]] ["%1-%2", _x, _y]; } [[forEach]] [[createHashMapFromArray]] [[1,"a"], [2,"b"]]; {{cc|will return: "1-a", "2-b" in [[systemChat]] messages}}</code>


|x6= <code>{
|x5= Iterating a [[HashMap]]'s [[Magic Variables#forEachIndex|_forEachIndex]]:
[[if]] ([[Magic Variables#forEachIndex|_forEachIndex]] == 1) [[then]] {
<sqf>
{{cc|Copilot}}
// shows "0, k1, v1", "1, k2, v2" in systemChat messages
_x [[addUniform]] "U_B_Soldier_VR";
{
} [[else]] {
systemChat format ["%1, %2, %3", _forEachIndex, _x, _y];
{{cc|Adams}}
} forEach createHashMapFromArray [
[_x, "B_Soldier_TL_F"] [[call]] [[BIS_fnc_loadInventory]];
["k1", "v1"],
_x [[addUniform]] "U_B_Soldier_VR";
["k2", "v2"]
_x [[setIdentity]] "Bootcamp_B_Adams";
];
};
</sqf>
} [[forEach]] _crew;</code>


|seealso= [[Control Structures]] [[for]] [[apply]] [[while]] [[select]] [[findIf]] [[count]]  
|x6= [[findIf]] equivalent for [[HashMap]]:
}}
<sqf>
private _resultKey = {
if (_y isEqualTo "wantedValue") exitWith { _x };
""
} forEach _hashmap;
</sqf>


<dl class="command_description">
|x7= Array is edited by reference:
<dt><dt>
<sqf>
<dd class="notedate">Posted on July 20, 2010</dd>
_arr1 = [1,2,3];
<dt class="note">[[User:Kronzky|Kronzky]]</dt>
<dd class="note">
If arrays are used in forEach loops, _x uses them by reference, so any changes to _x will be applied to the original:
<code>_arr1 = [1,2,3];
_arr2 = [6,7,8];
_arr2 = [6,7,8];
{ [[Magic Variables#x|_x]] [[set]] [1,"x"] } [[forEach]] [_arr1,_arr2];</code>
_arr3 = [0];
will change _arr1 to [1,"x",3], and _arr2 to [6,"x",8].
{ _x set [1, "changed"] } forEach [_arr1, _arr2, _arr3];
// _arr1 = [1, "changed", 3]
// _arr2 = [6, "changed", 8]
// _arr3 = [0, "changed"]
</sqf>


<dd class="notedate">Posted on January 2, 2015 - 22:35 (UTC)</dd>
|x8= <sqf>
<dt class="note">[[User:Heeeere's Johnny!|Heeeere's Johnny!]]</dt>
{
<dd class="note">
private _verticalValue = _x; // needed, otherwise _horizontalValues' _x made this one inaccessible
{
[_x, _verticalValue] call TAG_fnc_doSomething;
} forEach _horizontalValues;
} forEach _verticalValues;
</sqf>


Using [[exitWith]] inside a '''forEach''' loop will make '''forEach''' actually return something, namely whatever the '''exitWith''' returns:
|seealso= [[Control Structures]] [[for]] [[apply]] [[while]] [[select]] [[findIf]] [[count]] [[forEachReversed]]
<code>_result = {
}}
    if(_x [[isEqualTo]] 3) [[exitWith]] {"Hello"}
} '''forEach''' [1,2,3,4,5];
//_result = "Hello"</code>
</dd>


<dt><dt>
{{Note
<dd class="notedate">Posted on November 28, 2017 - 13:46 (UTC)</dd>
|user= Dedmen
<dt class="note">[[User:dedmen|dedmen]]</dt>
|timestamp= 20171128134600
<dd class="note">
|text= Be careful when deleting ([[deleteAt]]) elements from an Array while you iterate over it.<br>
Be careful when deleting ([[deleteAt]]) elements from an Array while you iterate over it.<br>
[[forEachIndex|_forEachIndex]] will not move to reflect your change.<br>
[[forEachIndex|_forEachIndex]] will not move to reflect your change.<br>


The forEach code is doing the same as
The forEach code is doing the same as
<code>_forEachIndex = 0;
<sqf>
while {_forEachIndex < count _array} do {
private _forEachIndex = 0;
    (_array select _forEachIndex) call code;
while { _forEachIndex < count _array } do
    _forEachIndex = _forEachIndex + 1;
{
}</code>
(_array select _forEachIndex) call code;
_forEachIndex = _forEachIndex + 1;
};
</sqf>


So if you delete your current element from the array the other elements will shift forward. Meaning you skip one element.<br>
So if you delete your current element from the array the other elements will shift forward. Meaning you skip one element.<br>
Example:
Example:
<code>_array = [1,2,3,4,5,6];
<sqf>
{_array deleteAt _forEachIndex} forEach _array;
_array = [1,2,3,4,5,6];
</code>
{ _array deleteAt _forEachIndex } forEach _array;
</sqf>
After the first iteration your Array will be [2,3,4,5,6] and the _forEachIndex will be 1.<br>
After the first iteration your Array will be [2,3,4,5,6] and the _forEachIndex will be 1.<br>
So on next iteration you get the element at index 1 which will be 3. So you've just skipped the 2.<br>
So on next iteration you get the element at index 1 which will be 3. So you've just skipped the 2.<br>
So in the end you will only iterate over 1,3 and 6.
So in the end you will only iterate over 1, 3 and 6.
</dd>
}}
</dl>
 
{{Note
|user= Sa-Matra
|timestamp= 20230402090428
|text= Use new [[forEachReversed]] command for deleting array items with [[deleteAt]]. Check its examples for details.
}}

Latest revision as of 20:58, 4 July 2024

Hover & click on the images for description

Description

Description:
Executes the given command(s) on every item of an Array or a HashMap.
Arma 2
Since Arma 2, the variable _x is always private to the forEach block so it is safe to nest them (see Example 8).
Groups:
Program FlowArraysHashMap

Syntax

Syntax:
code forEach array
Parameters:
Game Logo A0.png1.00 Logo A1 black.png1.00 Logo A2.png1.00 A2 OA Logo.png1.50 Arma 3 logo black.png1.00 tkoh logo small.png1.00
String support Checked Unchecked
Code support Unchecked Checked

code: String only in Operation Flashpoint and Armed Assault, Logo A1 black.png1.00 Code since Armed Assault - available variables:

array: Array - the array to iterate over
Return Value:
Anything - will return the value of last executed statement

Alternative Syntax

Syntax:
code forEach hashMap
Parameters:
code: Code - code applied to each key-value pair - available variables:
hashMap : HashMap - the HashMap to iterate over
Return Value:
Anything - will return the value of last executed statement

Examples

Example 1:
// SQF { _x setDamage 1 } forEach units player;
; SQS "_x setDammage 1" forEach units player
Example 2:
This command can also easily be used to execute a single command multiple times without respect to the array items - see also for
{ player addMagazine "30Rnd_556x45_Stanag" } forEach [1, 2, 3, 4]; // equivalent to for "_i" from 1 to 4 do { player addMagazine "30Rnd_556x45_Stanag" };
Example 3:
You can also use multiple commands in the same block:
Example 4:
To get the index of a forEach loop, use _forEachIndex:
{ systemChat str _forEachIndex; } forEach ["a", "b", "c"]; // will return: "0", "1", "2" in systemChat messages
Example 5:
Iterating a HashMap's _forEachIndex:
// shows "0, k1, v1", "1, k2, v2" in systemChat messages { systemChat format ["%1, %2, %3", _forEachIndex, _x, _y]; } forEach createHashMapFromArray [ ["k1", "v1"], ["k2", "v2"] ];
Example 6:
findIf equivalent for HashMap:
private _resultKey = { if (_y isEqualTo "wantedValue") exitWith { _x }; "" } forEach _hashmap;
Example 7:
Array is edited by reference:
_arr1 = [1,2,3]; _arr2 = [6,7,8]; _arr3 = [0]; { _x set [1, "changed"] } forEach [_arr1, _arr2, _arr3]; // _arr1 = [1, "changed", 3] // _arr2 = [6, "changed", 8] // _arr3 = [0, "changed"]
Example 8:
{ private _verticalValue = _x; // needed, otherwise _horizontalValues' _x made this one inaccessible { [_x, _verticalValue] call TAG_fnc_doSomething; } forEach _horizontalValues; } forEach _verticalValues;

Additional Information

See also:
Control Structures for apply while select findIf count forEachReversed

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
Dedmen - c
Posted on Nov 28, 2017 - 13:46 (UTC)
Be careful when deleting (deleteAt) elements from an Array while you iterate over it.
_forEachIndex will not move to reflect your change.
The forEach code is doing the same as So if you delete your current element from the array the other elements will shift forward. Meaning you skip one element.
Example:
_array = [1,2,3,4,5,6]; { _array deleteAt _forEachIndex } forEach _array;
After the first iteration your Array will be [2,3,4,5,6] and the _forEachIndex will be 1.
So on next iteration you get the element at index 1 which will be 3. So you've just skipped the 2.
So in the end you will only iterate over 1, 3 and 6.
Sa-Matra - c
Posted on Apr 02, 2023 - 09:04 (UTC)
Use new forEachReversed command for deleting array items with deleteAt. Check its examples for details.