BIS fnc conditionalSelect: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Page filling and comment cleanup)
m (Some wiki formatting)
 
(34 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Function|= Comments
{{RV|type=function
____________________________________________________________________________________________


| arma2 |= Game name
|game1= arma2
|version1= 1.00


|1.00|= Game version
|game2= arma2oa
____________________________________________________________________________________________
|version2= 1.50


| This returns a sub-array of elements that satisfy a specific condition '''in the order they have been passed'''.
|game3= tkoh
{{Feature arma3|use {{Inline code|''items'' [[select]] ''condition''}} syntax instead (since {{arma3}} v1.55}}
|version3= 1.00


In the condition, the currently tested element is assigned to the variable "[[_x]]".
|game4= arma3
The original array is '''not''' modified. |= Description
|version4= 0.50
____________________________________________________________________________________________


| [items, condition] call [[BIS_fnc_conditionalSelect]] |= Syntax
|gr1= Arrays


|p1= items: [[Array]] - array to check |= Parameter 1
|descr= This returns a sub-array of elements that satisfy a specific condition '''in the order they have been passed'''.
{{Feature|arma3|Since {{arma3}} v1.55, use <sqf inline>array select condition</sqf> instead.}}


|p2= condition: [[Code]] - selection code |= Parameter 2
In the condition, the currently tested element is assigned to the variable "[[Magic Variables#x|_x]]".
The original array is '''not''' modified.


| [[Array]] |= Return value
|s1= [items, condition] call [[BIS_fnc_conditionalSelect]]
____________________________________________________________________________________________


|x1= <code><nowiki>[</nowiki>[10,0,8,2,6,4], { [[_x]] > 5 }] [[call]] [[BIS_fnc_conditionalSelect]]; {{codecomment|// will return [10,8,6]}}</code> |= Example 1
|p1= items: [[Array]] - array to check


|x2= <code><nowiki>[</nowiki>[10,[[true]],8,[[player]]], { [[typeName]] _x == "STRING" }] [[call]] [[BIS_fnc_conditionalSelect]]; {{codecomment|// will return []}}</code> |= Example 2
|p2= condition: [[Code]] - selection code
____________________________________________________________________________________________


| [[select]], [[count]] |= See also
|r1= [[Array]]
}}


<h3 style="display:none">Notes</h3>
|x1= <sqf>[[10, 0, 8, 2, 6, 4], { _x > 5 }] call BIS_fnc_conditionalSelect; // will return [10,8,6]</sqf>
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|x2= <sqf>[[10, true, 8, player], { typeName _x == "STRING" }] call BIS_fnc_conditionalSelect; // will return []</sqf>
</dl>


<h3 style="display:none">Bottom Section</h3>
|seealso= [[select]] [[count]]
[[Category:Function Group: Arrays|{{uc:conditionalSelect}}]]
}}
[[Category:Functions|{{uc:conditionalSelect}}]]
[[Category:{{Name|arma2}}: Functions|{{uc:conditionalSelect}}]]
[[Category:{{Name|arma2oa}}: Functions|{{uc:conditionalSelect}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:conditionalSelect}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:conditionalSelect}}]]

Latest revision as of 13:57, 13 July 2022

Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
Hover & click on the images for description

Description

Description:
This returns a sub-array of elements that satisfy a specific condition in the order they have been passed.
Arma 3
Since Arma 3 v1.55, use array select condition instead.

In the condition, the currently tested element is assigned to the variable "_x".

The original array is not modified.
Execution:
call
Groups:
Arrays

Syntax

Syntax:
[items, condition] call BIS_fnc_conditionalSelect
Parameters:
items: Array - array to check
condition: Code - selection code
Return Value:
Array

Examples

Example 1:
[[10, 0, 8, 2, 6, 4], { _x > 5 }] call BIS_fnc_conditionalSelect; // will return [10,8,6]
Example 2:
[[10, true, 8, player], { typeName _x == "STRING" }] call BIS_fnc_conditionalSelect; // will return []

Additional Information

See also:
select 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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_conditionalSelect&oldid=327949"