BIS fnc conditionalSelect: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
(Page filling and comment cleanup)
Line 1: Line 1:
{{Function|= Comments
{{Function|= Comments
____________________________________________________________________________________________
____________________________________________________________________________________________
Line 8: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>
| This returns a sub-array of elements that satisfy a specific condition '''in the order they have been passed'''.
/************************************************************
{{Feature arma3|use {{Inline code|''items'' [[select]] ''condition''}} syntax instead (since {{arma3}} v1.55}}
Conditional Select


Parameters: [array, {condition}]
In the condition, the currently tested element is assigned to the variable "[[_x]]".
 
The original array is '''not''' modified. |= Description
This returns a sub-array of elements that satisfy a specific condition.
____________________________________________________________________________________________
The originally passed array is NOT modified!
 
The function takes, in order, every element of the passed array,
evaluates it in the condition, and, if the condition is true, adds
it to the return array.
 
In the condition, the currently tested element is assigned to
the variable "_x".
 
Care must be taken that the condition won't cause errors. For
example, if your condition assumes all elements are numbers,
errors will occur if your array includes strings.
 
This function is similar to the "count" command, only it returns
the elements of the array that satisfy the condition, rather
than simply returning the count.


Example: [[10,0,8,2,6,4], {_x > 5}] call BIS_fnc_conditionalSelect
| [items, condition] call [[BIS_fnc_conditionalSelect]] |= Syntax
Returns: [10,8,6]


Example: [[10,true,8,player], {typename _x == "STRING"}] call BIS_fnc_conditionalSelect
|p1= items: [[Array]] - array to check |= Parameter 1
Returns: []


************************************************************/
|p2= condition: [[Code]] - selection code |= Parameter 2


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
| [[Array]] |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_conditionalSelect]]; --> |= Syntax
|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= |= Parameter 1
 
| |= Return value
____________________________________________________________________________________________


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


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


Line 71: Line 45:
[[Category:{{Name|tkoh}}: Functions|{{uc:conditionalSelect}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:conditionalSelect}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:conditionalSelect}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:conditionalSelect}}]]
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on May 8, 2016 - 07:26 (UTC)</dd>
<dt class="note">[[User:AgentRevolution|AgentRev]]</dt>
<dd class="note">
Since Arma 3 v1.55, the [[select]] command can be used to make conditional selections just like this function.
</dd>
</dl>
<!-- DISCONTINUE Notes -->

Revision as of 10:58, 27 April 2018

Logo A2.png1.00
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
use items select condition syntax instead (since Arma 3 v1.55

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

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

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:
selectcount

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=BIS_fnc_conditionalSelect&oldid=106850"