BIS fnc removeFromPairs: Difference between revisions
Jump to navigation
Jump to search
m (Text replacement - "\[\[[cC]ategory:\{\{Name\|arma3\}\}: [fF]unctions\|\{\{uc:[a-z A-Z_]*\}\}\]\]" to "") |
m (Text replacement - " |exec= call " to " ") |
||
| Line 20: | Line 20: | ||
|x1= <code>[[["apple",3],["pear",2]],"pear"] [[call]] [[BIS_fnc_removeFromPairs]]; {{cc|Returns <nowiki>[[</nowiki>"apple",3<nowiki>]]</nowiki>}}</code> | |x1= <code>[[["apple",3],["pear",2]],"pear"] [[call]] [[BIS_fnc_removeFromPairs]]; {{cc|Returns <nowiki>[[</nowiki>"apple",3<nowiki>]]</nowiki>}}</code> | ||
|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:53, 6 February 2021
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