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 "") |
Lou Montana (talk | contribs) m (Some wiki formatting) |
||
| (7 intermediate revisions by 2 users not shown) | |||
| Line 2: | Line 2: | ||
|game1= arma3 | |game1= arma3 | ||
|version1= 1.00 | |version1= 1.00 | ||
|gr1 = Arrays | |gr1= Arrays | ||
|descr= Removes an item from pair array modifying original array | |descr= Removes an item from pair array, modifying or not the original array. | ||
|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>private _pairs = [[["apple", 3], ["pear", 2]], "pear"]; | ||
[_pairs, "pear", true] call BIS_fnc_removeFromPairs; // returns [<nowiki/>["apple", 3]] - _pairs is not modified | |||
[_pairs, "pear"] call BIS_fnc_removeFromPairs; // returns [<nowiki/>["apple", 3]] - _pairs is now [<nowiki/>["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]] | ||
}} | }} | ||
Latest revision as of 19:25, 7 April 2024
Description
- Description:
- Removes an item from pair array, modifying or not the original array.
- 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:
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