BIS fnc conditionalSelect: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "{{Feature arma3|" to "{{Feature|arma3|")
m (Text replacement - "_{10,} " to "")
Line 1: Line 1:
{{Function|Comments=
{{Function|Comments=
____________________________________________________________________________________________


| arma2 |Game name=
| arma2 |Game name=
Line 7: Line 6:


|gr1= Arrays|GROUP1=
|gr1= Arrays|GROUP1=
____________________________________________________________________________________________


| This returns a sub-array of elements that satisfy a specific condition '''in the order they have been passed'''.
| This returns a sub-array of elements that satisfy a specific condition '''in the order they have been passed'''.
Line 14: Line 12:
In the condition, the currently tested element is assigned to the variable "[[_x]]".
In the condition, the currently tested element is assigned to the variable "[[_x]]".
The original array is '''not''' modified. |DESCRIPTION=
The original array is '''not''' modified. |DESCRIPTION=
____________________________________________________________________________________________


| [items, condition] call [[BIS_fnc_conditionalSelect]] |SYNTAX=
| [items, condition] call [[BIS_fnc_conditionalSelect]] |SYNTAX=
Line 23: Line 20:


| [[Array]] |RETURNVALUE=
| [[Array]] |RETURNVALUE=
____________________________________________________________________________________________


|x1= <code><nowiki>[</nowiki>[10,0,8,2,6,4], { [[_x]] > 5 }] [[call]] [[BIS_fnc_conditionalSelect]]; {{codecomment|// will return [10,8,6]}}</code> |EXAMPLE1=
|x1= <code><nowiki>[</nowiki>[10,0,8,2,6,4], { [[_x]] > 5 }] [[call]] [[BIS_fnc_conditionalSelect]]; {{codecomment|// will return [10,8,6]}}</code> |EXAMPLE1=


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


| [[select]], [[count]] |SEEALSO=
| [[select]], [[count]] |SEEALSO=

Revision as of 22:38, 16 January 2021

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