findIf: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Remove "you") |
Lou Montana (talk | contribs) m (Some wiki formatting) |
||
Line 6: | Line 6: | ||
|gr1= Arrays | |gr1= Arrays | ||
|descr= Searches for an element within array for which the code evaluates to true. | |descr= 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.<br> | ||
Returns the zero-based index on success or -1 if not found.<br> | |||
Code on the right side of the command is evaluated for each element of the array, processed element can be referenced in code as [[Magic Variables#x|_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 [[Magic Variables#x|_x]]. | ||
{{Feature|informative|[[findIf]] terminates as soon as it finds an element that fulfills the condition, thus it is more efficient than [[count]] in scenarios where a check for presence / absence of at least one element should be done (See {{HashLink|#Example 2}}).}} | |||
{{Feature| | |||
|s1= array [[findIf]] code | |s1= array [[findIf]] code | ||
Line 20: | Line 18: | ||
|r1= [[Number]] - Zero-based position of the first array element for which the code evaluate to true, -1 if not found | |r1= [[Number]] - Zero-based position of the first array element for which the code evaluate to true, -1 if not found | ||
|x1= < | |x1= <sqf>[unit1, unit2, unit3] findIf {not alive _x}; // return index of the first dead unit)</sqf> | ||
|x2= < | |x2= <sqf> | ||
// 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 | |||
</sqf> | |||
|seealso= [[find]] [[count]] | |seealso= [[find]] [[count]] | ||
}} | }} |
Revision as of 23:50, 3 May 2022
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:
- Example 2:
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