forEach: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Some wiki formatting) |
Lou Montana (talk | contribs) m (Text replacement - "Samatra" to "Sa-Matra") |
||
(10 intermediate revisions by 2 users not shown) | |||
Line 23: | Line 23: | ||
|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]] or a [[HashMap]]. | |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 {{ | {{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}} - available variables: | |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 | * {{hl|[[Magic Variables#x|_x]]}}: iterated item | ||
* {{hl|[[Magic Variables#forEachIndex|_forEachIndex]]}}: item's index | * {{GVI|arma2oa|1.55|size= 0.75}} {{hl|[[Magic Variables#forEachIndex|_forEachIndex]]}}: item's index | ||
|p2= array: [[Array]] - | |p2= array: [[Array]] - the array to iterate over | ||
|r1= [[Anything]] - | |r1= [[Anything]] - will return the value of last executed statement | ||
|s2= code [[forEach]] hashMap | |s2= code [[forEach]] hashMap | ||
Line 48: | Line 66: | ||
* {{hl|[[Magic Variables#forEachIndex|_forEachIndex]]}}: iteration number | * {{hl|[[Magic Variables#forEachIndex|_forEachIndex]]}}: iteration number | ||
|p22= hashMap : [[HashMap]] - | |p22= hashMap : [[HashMap]] - the HashMap to iterate over | ||
|r2= [[Anything]] - | |r2= [[Anything]] - will return the value of last executed statement | ||
|x1= <sqf> | |x1= <sqf> | ||
Line 56: | Line 74: | ||
{ _x setDamage 1 } forEach units player; | { _x setDamage 1 } forEach units player; | ||
</sqf> | </sqf> | ||
< | <sqs> | ||
; SQS | |||
"_x setDammage 1" forEach units player | "_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 - see also [[for]] | |x2= This command can also easily be used to execute a single command multiple times without respect to the array items - see also [[for]] | ||
Line 71: | Line 89: | ||
<sqf> | <sqf> | ||
{ | { | ||
_x setCaptive true; | |||
removeAllWeapons _x; | |||
doStop _x; | |||
} forEach units group this; | } forEach units group this; | ||
</sqf> | </sqf> | ||
Line 119: | Line 137: | ||
</sqf> | </sqf> | ||
|seealso= [[Control Structures]] [[for]] [[apply]] [[while]] [[select]] [[findIf]] [[count]] | |seealso= [[Control Structures]] [[for]] [[apply]] [[while]] [[select]] [[findIf]] [[count]] [[forEachReversed]] | ||
}} | }} | ||
Line 133: | Line 151: | ||
while { _forEachIndex < count _array } do | while { _forEachIndex < count _array } do | ||
{ | { | ||
(_array select _forEachIndex) call code; | |||
_forEachIndex = _forEachIndex + 1; | |||
}; | }; | ||
</sqf> | </sqf> | ||
Line 147: | Line 165: | ||
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. | ||
}} | |||
{{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
Description
- Description:
- Executes the given command(s) on every item of an Array or a HashMap.
- Groups:
- Program FlowArraysHashMap
Syntax
- Syntax:
- code forEach array
- Parameters:
-
Game 1.00 1.00 1.00 1.50 1.00 1.00 String support Code support code: String only in Operation Flashpoint and Armed Assault, 1.00 Code since Armed Assault - available variables:
- _x: iterated item
- 1.55 _forEachIndex: item's index
- 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:
- _x: key
- _y: value
- _forEachIndex: iteration number
- hashMap : HashMap - the HashMap to iterate over
- Return Value:
- Anything - will return the value of last executed statement
Examples
- Example 1:
- 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:
- Example 7:
- Array is edited by reference:
- Example 8:
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
- 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 asSo if you delete your current element from the array the other elements will shift forward. Meaning you skip one element.private _forEachIndex = 0; while { _forEachIndex < count _array } do { (_array select _forEachIndex) call code; _forEachIndex = _forEachIndex + 1; };
Example: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.
- Posted on Apr 02, 2023 - 09:04 (UTC)
- Use new forEachReversed command for deleting array items with deleteAt. Check its examples for details.
Categories:
- Scripting Commands
- Introduced with Operation Flashpoint version 1.00
- Operation Flashpoint: New Scripting Commands
- Operation Flashpoint: Scripting Commands
- Operation Flashpoint: Elite: Scripting Commands
- ArmA: Armed Assault: Scripting Commands
- Arma 2: Scripting Commands
- Arma 2: Operation Arrowhead: Scripting Commands
- Take On Helicopters: Scripting Commands
- Arma 3: Scripting Commands
- Command Group: Program Flow
- Command Group: Arrays
- Command Group: HashMap