forEach: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
No edit summary
Line 1: Line 1:
[[Category:Scripting Commands|FOREACH]]
{{Command|= Comments
[[Category:Scripting Commands OFP 1.96|FOREACH]]
____________________________________________________________________________________________
[[Category:Scripting Commands OFP 1.46|FOREACH]]
[[Category:Scripting Commands ArmA|FOREACH]]


| ofp |= Game name


<h2 style="color:#000066">'''''command'' forEach ''array'''''</h2>
|1.00|= Game version
____________________________________________________________________________________________


| Executes the given command on every item of an array. The array items are represented by _x. All commands are executed within one frame, so this command might cause performance loss when used on very large arrays or with very complex commands. |= Description
____________________________________________________________________________________________


'''Operand types:'''
| command '''forEach''' array |= Syntax


'''command:''' [[String]]
|p1= command: [[String]] |= Parameter 1


'''array:''' [[Array]]
|p2= array: [[Array]] |= Parameter 2


'''Type of returned value:'''
| [[Nothing]] |= Return value
____________________________________________________________________________________________
 
|x1= <pre>{_x setdammage 1} forEach units group player</pre>


[[Nothing]]


'''Description:'''
This command can also easily be used to execute a single command multiple times without respect to the array items.


Execute given '''command''' for each element of '''array'''.
<pre>{player addMagazine "M16"} forEach [1,2,3,4]</pre> |= Example 1
____________________________________________________________________________________________


It is executed as follows:
| [[count]] |= See also


For each element of '''array''' assign element as '''_x''' and execute '''command'''.
}}


<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->


'''Example:'''
<!-- Note Section END -->
</dl>


"'''_x''' [[setDamage]] 1" '''forEach''' [[units grp|units]] [[group]] [[player]]
<h3 style="display:none">Bottom Section</h3>
[[Category:Scripting Commands|FOREACH]]
[[Category:Scripting Commands OFP 1.96|FOREACH]]
[[Category:Scripting Commands OFP 1.46|FOREACH]]
[[Category:Scripting Commands ArmA|FOREACH]]

Revision as of 01:15, 2 August 2006

Logo A0.png1.00
Hover & click on the images for description

Description

Description:
Executes the given command on every item of an array. The array items are represented by _x. All commands are executed within one frame, so this command might cause performance loss when used on very large arrays or with very complex commands.
Groups:
Uncategorised

Syntax

Syntax:
command forEach array
Parameters:
command: String
array: Array
Return Value:
Nothing

Examples

Example 1:
{_x setdammage 1} forEach units group player


This command can also easily be used to execute a single command multiple times without respect to the array items. 

{player addMagazine "M16"} forEach [1,2,3,4]

Additional Information

See also:
count

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

Notes

Bottom Section

Retrieved from "https://community.bistudio.com/wiki?title=forEach&oldid=16992"