BIS fnc removeFromPairs: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "^ {{Function\|Comments\=" to "{{Function|Comments=") |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{Function | {{Function | ||
| arma3 | |game1= arma3 | ||
|1.00 | |version1= 1.00 | ||
| | <!--|serverExec= server--> | ||
<!--|arg= local--> | |||
< | <!--|eff= local--> | ||
| | |descr= Removes an item from pair array modifying original array. This can be overriden by setting '_copyArray' param to true. | ||
| | |s1= [array, key, copyArray] call [[BIS_fnc_removeFromPairs]] | ||
| | |p1= array: [[Array]] - Array to search through | ||
| | |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 | ||
|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> | |||
|exec= call | |||
|seealso= [[find]] [[findIf]] [[BIS_fnc_findInPairs]] [[BIS_fnc_getFromPairs]] [[BIS_fnc_addToPairs]] | |||
}} | }} | ||
<h3 style="display:none">Notes</h3> | <h3 style="display:none">Notes</h3> | ||
<dl class="command_description"> | <dl class="command_description"> | ||
Revision as of 09:50, 15 September 2020
Description
- Description:
- Removes an item from pair array modifying original array. This can be overriden by setting '_copyArray' param to true.
- Execution:
- call
- Groups:
- Uncategorised
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
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