BIS fnc removeFromPairs: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\|game([0-9])= *([^ ]+) * +\|version([0-9])= *([^ ]+) * " to "|game$1=$2 |version$3=$4 ")
m (Text replacement - "<code>([^<]*)\{\{cc\|([^{}]+)\}\} *<\/code>" to "<code>$1// $2</code>")
Line 18: Line 18:
|r1= [[Array]] - Resulting modified array or a copy
|r1= [[Array]] - Resulting modified array or a copy


|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]]; // 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 23:23, 12 July 2022

Hover & click on the images for description

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