BIS_fnc_removeFromPairs

From Bohemia Interactive Community
Revision as of 14:02, 17 January 2021 by Lou Montana (talk | contribs) (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl> " to "")
Jump to navigation Jump to search
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

Bottom Section