BIS fnc removeFromPairs: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Some wiki formatting)
 
(22 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma3
____________________________________________________________________________________________
|version1= 1.00


| arma3 |= Game name
|gr1= Arrays


|1.00|= Game version
|descr= Removes an item from pair array, modifying or not the original array.
____________________________________________________________________________________________


| <pre>/*
|s1= [array, key, copyArray] call [[BIS_fnc_removeFromPairs]]


Description:
|p1= array: [[Array]] - array to search through
Removes an item from pair array.
*/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |DESCRIPTION=
|p2= key: [[String]] - key to search for
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_removeFromPairs]]; --> |SYNTAX=
|p3= copyArray: [[Boolean]] - (Optional, default [[false]]) [[true]] to copy the array and return it, [[false]] to modify the original array


|p1= |PARAMETER1=
|r1= [[Array]] - resulting modified array or a copy


| |RETURNVALUE=
|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]]
|x1= <code></code> |=
</sqf>
____________________________________________________________________________________________
 
| |SEEALSO=


|seealso= [[find]] [[findIf]] [[BIS_fnc_findInPairs]] [[BIS_fnc_getFromPairs]] [[BIS_fnc_addToPairs]] [[BIS_fnc_setToPairs]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Arrays|{{uc:removeFromPairs}}]]
[[Category:Functions|{{uc:removeFromPairs}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:removeFromPairs}}]]

Latest revision as of 20:25, 7 April 2024

Arma 3 logo black.png1.00
Hover & click on the images for description

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:
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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_removeFromPairs&oldid=363590"