{"name":"BIS_fnc_removeFromPairs","operator":null,"title":"BIS fnc removeFromPairs","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_removeFromPairs","revid":363590,"updated":"2024-04-07T18:25:56Z","groups":["Arrays"],"status":"ok","replaced_by":[],"games":[{"game":"arma3","name":"Arma 3","version":"1.00"}],"since":{"game":"arma3","name":"Arma 3","version":"1.00"},"arma3_since":"1.00","branch":null,"locality":{"argument":null,"effect":null,"server_exec":false},"exec":null,"description":"Removes an item from pair array, modifying or not the original array.","syntaxes":[{"syntax":"[array, key, copyArray] call BIS_fnc_removeFromPairs","since":null,"effect":null,"exec":null,"params":[{"name":"array","type":"Array","optional":false,"default":null,"description":"array to search through","types":["Array"],"since":null,"text":"array: Array - array to search through"},{"name":"key","type":"String","optional":false,"default":null,"description":"key to search for","types":["String"],"since":null,"text":"key: String - key to search for"},{"name":"copyArray","type":"Boolean","optional":true,"default":"false","description":"true to copy the array and return it, false to modify the original array","types":["Boolean"],"since":null,"text":"copyArray: Boolean - (Optional, default false) true to copy the array and return it, false to modify the original array"}],"returns":{"type":"Array","types":["Array"],"description":"resulting modified array or a copy","text":"Array - resulting modified array or a copy"}}],"examples":[{"text":"```sqf\nprivate _pairs = [[[\"apple\", 3], [\"pear\", 2]], \"pear\"];\n[_pairs, \"pear\", true]    call BIS_fnc_removeFromPairs; // returns [[\"apple\", 3]] - _pairs is not modified\n[_pairs, \"pear\"]        call BIS_fnc_removeFromPairs; // returns [[\"apple\", 3]] - _pairs is now [[\"apple\", 3]]\n```","code":["private _pairs = [[[\"apple\", 3], [\"pear\", 2]], \"pear\"];\n[_pairs, \"pear\", true]\tcall BIS_fnc_removeFromPairs; // returns [[\"apple\", 3]] - _pairs is not modified\n[_pairs, \"pear\"]\t\tcall BIS_fnc_removeFromPairs; // returns [[\"apple\", 3]] - _pairs is now [[\"apple\", 3]]"]}],"multiplayer":null,"problems":null,"aliases":[],"see_also":["find","findIf","BIS_fnc_findInPairs","BIS_fnc_getFromPairs","BIS_fnc_addToPairs","BIS_fnc_setToPairs"],"notes":[],"categories":["Arma 3: Functions","Arma 3: New Functions","Function Group: Arrays","Functions","Introduced with Arma 3 version 1.00"],"docblock":null,"filled_from_docblock":[]}