BIS fnc removeFromPairs: Difference between revisions

Revision as of 16:34, 13 July 2022

Hover & click on the images for description

Description:: Removes an item from pair array modifying original array. This can be overriden by setting '_copyArray' param to true.
Execution:: call
Groups:: Arrays

Syntax:: [array, key, copyArray] call BIS_fnc_removeFromPairs
Parameters:: array: Array - Array to search through
: key: String - Key to search for
: copyArray: Boolean - (Optional, default false) true to copy the array and return it, false to modify the original array
Return Value:: Array - Resulting modified array or a copy

Example 1:: [[["apple", 3], ["pear", 2]], "pear"] call BIS_fnc_removeFromPairs; // returns "apple", 3

See also:: find findIf BIS_fnc_findInPairs BIS_fnc_getFromPairs BIS_fnc_addToPairs BIS_fnc_setToPairs

: 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

@@ Line 18: / Line 18: @@
 |r1= [[Array]] - Resulting modified array or a copy
-|x1= <code>[[["apple",3],["pear",2]],"pear"] [[call]] [[BIS_fnc_removeFromPairs]]; // Returns <nowiki>[[</nowiki>"apple",3<nowiki>]]</nowiki></code>
+|x1= <sqf>[[["apple", 3], ["pear", 2]], "pear"] call BIS_fnc_removeFromPairs; // returns [["apple", 3]]</sqf>
 |seealso= [[find]] [[findIf]] [[BIS_fnc_findInPairs]] [[BIS_fnc_getFromPairs]] [[BIS_fnc_addToPairs]] [[BIS_fnc_setToPairs]]
 }}