findIf: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl> " to "") |
Lou Montana (talk | contribs) m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments( \("local" or "global"\))?|Effects|Multiplayer Effects( \("local" or "global"\))?|Multiplayer Exe...) |
||
| Line 1: | Line 1: | ||
{{Command | {{Command | ||
| arma3 | | arma3 | ||
|1.82 | |1.82 | ||
|gr1= Arrays | |gr1= Arrays | ||
| Searches for an element within array for which the code evaluates to true. | | Searches for an element within array for which the code evaluates to true. | ||
| Line 11: | Line 11: | ||
Code on the right side of the command is evaluated for each element of the array, processed element can be referenced in code as [[_x]]. | Code on the right side of the command is evaluated for each element of the array, processed element can be referenced in code as [[_x]]. | ||
{{Informative|[[findIf]] terminates as soon as it finds an element that fulfills the condition, thus it is more efficient than [[count]] in scenarios where you need to check for presence / absence of at least one element that evaluates to true.}} | {{Informative|[[findIf]] terminates as soon as it finds an element that fulfills the condition, thus it is more efficient than [[count]] in scenarios where you need to check for presence / absence of at least one element that evaluates to true.}} | ||
| array [[findIf]] code | | array [[findIf]] code | ||
|p1= array: [[Array]] - array to search in | |p1= array: [[Array]] - array to search in | ||
|p2= code: [[Code]] - code defining an element to find, processed element can be referenced within the code as [[_x]] | |p2= code: [[Code]] - code defining an element to find, processed element can be referenced within the code as [[_x]] | ||
| [[Number]] - Zero-based position of the first array element for which the code evaluate to true, -1 if not found | | [[Number]] - Zero-based position of the first array element for which the code evaluate to true, -1 if not found | ||
|x1= <code>[unit1, unit2, unit3] [[findIf]] {[[not]] [[alive]] [[_x]]}; {{codecomment|// return index of the first dead unit)}}</code> | |x1= <code>[unit1, unit2, unit3] [[findIf]] {[[not]] [[alive]] [[_x]]}; {{codecomment|// return index of the first dead unit)}}</code> | ||
|x2= <code>{{codecomment|// two ways how to 'wait for all units to be dead':}} | |x2= <code>{{codecomment|// two ways how to 'wait for all units to be dead':}} | ||
[[waitUntil]] { [unit1, unit2, unit3] [[findIf]] {[[alive]] [[_x]]} == -1 }; {{codecomment|// fast, terminates as soon as it finds a living unit}} | [[waitUntil]] { [unit1, unit2, unit3] [[findIf]] {[[alive]] [[_x]]} == -1 }; {{codecomment|// fast, terminates as soon as it finds a living unit}} | ||
[[waitUntil]] { {[[alive]] [[_x]]} [[count]] [unit1, unit2, unit3] == 0 }; {{codecomment|// slow, always goes through all array elements}}</code> | [[waitUntil]] { {[[alive]] [[_x]]} [[count]] [unit1, unit2, unit3] == 0 }; {{codecomment|// slow, always goes through all array elements}}</code> | ||
| [[find]] [[count]] | | [[find]] [[count]] | ||
}} | }} | ||
Revision as of 00:35, 18 January 2021
Description
- Description:
- Searches for an element within array for which the code evaluates to true. Returns the zero-based index on success or -1 if not found. Code on the right side of the command is evaluated for each element of the array, processed element can be referenced in code as _x.
- Groups:
- Arrays
Syntax
- Syntax:
- array findIf code
- Parameters:
- array: Array - array to search in
- code: Code - code defining an element to find, processed element can be referenced within the code as _x
- Return Value:
- Number - Zero-based position of the first array element for which the code evaluate to true, -1 if not found
Examples
- Example 1:
[unit1, unit2, unit3] findIf {not alive _x}; // return index of the first dead unit)- Example 2:
// two ways how to 'wait for all units to be dead': waitUntil { [unit1, unit2, unit3] findIf {alive _x} == -1 }; // fast, terminates as soon as it finds a living unit waitUntil { {alive _x} count [unit1, unit2, unit3] == 0 }; // slow, always goes through all array elements
Additional Information
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