BIS fnc removeFromPairs: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Some wiki formatting) |
Lou Montana (talk | contribs) m (Some wiki formatting) |
||
| Line 6: | Line 6: | ||
|gr1= Arrays | |gr1= Arrays | ||
|descr= Removes an item from pair array modifying original array. This can be overriden by setting '_copyArray' | |descr= Removes an item from pair array modifying the original array. This can be overriden by setting ''_copyArray'' to true. | ||
|s1= [array, key, copyArray] call [[BIS_fnc_removeFromPairs]] | |s1= [array, key, copyArray] call [[BIS_fnc_removeFromPairs]] | ||
|p1= array: [[Array]] - | |p1= array: [[Array]] - array to search through | ||
|p2= key: [[String]] - | |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]] - | |r1= [[Array]] - resulting modified array or a copy | ||
|x1= <sqf>[[["apple", 3], ["pear", 2]], "pear"] call BIS_fnc_removeFromPairs; // returns [["apple", 3]]</sqf> | |x1= <sqf>private _pairs = [[["apple", 3], ["pear", 2]], "pear"]; | ||
[_pairs, "pear", true] call BIS_fnc_removeFromPairs; // returns [["apple", 3]] - _pairs is not modified | |||
[_pairs, "pear"] call BIS_fnc_removeFromPairs; // returns [["apple", 3]] - _pairs is now [["apple", 3]] | |||
</sqf> | |||
|seealso= [[find]] [[findIf]] [[BIS_fnc_findInPairs]] [[BIS_fnc_getFromPairs]] [[BIS_fnc_addToPairs]] [[BIS_fnc_setToPairs]] | |seealso= [[find]] [[findIf]] [[BIS_fnc_findInPairs]] [[BIS_fnc_getFromPairs]] [[BIS_fnc_addToPairs]] [[BIS_fnc_setToPairs]] | ||
}} | }} | ||
Revision as of 16:38, 13 July 2022
Description
- Description:
- Removes an item from pair array modifying the original array. This can be overriden by setting _copyArray 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:
- private _pairs = [[["apple", 3], ["pear", 2]], "pear"]; [_pairs, "pear", true] call BIS_fnc_removeFromPairs; // returns "apple", 3 - _pairs is not modified [_pairs, "pear"] call BIS_fnc_removeFromPairs; // returns "apple", 3 - _pairs is now "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