BIS fnc removeFromPairs: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Text replacement - "True" to "true")
Line 15: Line 15:
|p2= key: [[String]] - Key to search for
|p2= key: [[String]] - Key to search for


|p3= copyArray: [[Boolean]] - (Optional, default [[false]]) [[True]] to copy the array and return it, [[false]] to modify the original array
|p3= copyArray: [[Boolean]] - (Optional, default [[false]]) [[true]] to copy the array and return it, [[false]] to modify the original array


|r1= [[Array]] - Resulting modified array or a copy
|r1= [[Array]] - Resulting modified array or a copy

Revision as of 18:10, 26 December 2020

Hover & click on the images for description

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

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

Examples

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

Additional Information

See also:
find findIf BIS_fnc_findInPairs BIS_fnc_getFromPairs BIS_fnc_addToPairs BIS_fnc_setToPairs

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