BIS fnc setToPairs: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "^ {{Function\|Comments\=" to "{{Function|Comments=")
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *R([a-z ])" to "$1 - r$2")
 
(18 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|Comments=
{{RV|type=function
____________________________________________________________________________________________


| arma3 |Game name=
|game1= arma3
|version1= 1.00


|1.00|Game version=
|gr1= Arrays
____________________________________________________________________________________________


| <pre>/*
|descr= Works similar to the [[BIS_fnc_addToPairs]] but it doesn't try to add values. It just overwrites the volue if the key already exists.


Description:
|s1= [array, key, newValue] call [[BIS_fnc_setToPairs]]
Sets an item in pair array to given value.


Remarks:
|p1= array: [[Array]] - array to search through
Works similar to the BIS_fnc_addToPairs but it doesn't try to add values. It just overwrites the volue if the key already exists.


Example:
|p2= key: [[String]] - key to search for
[["apple",3],["pear",10]] = [[["apple",3],["pear",2]],"pear",10] call BIS_fnc_setToPairs;
*/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |DESCRIPTION=
|p3= newValue: [[Anything]] - (Optional, default 1) new value set if match was found
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_setToPairs]]; --> |SYNTAX=
|r1= [[Array]] - resulting modified array


|p1= |PARAMETER1=
|x1= <sqf>[[["apple",3],["pear",2]],"pear",10] call BIS_fnc_setToPairs; // Returns [["apple",3],["pear",10]]</sqf>
 
| |RETURNVALUE=
____________________________________________________________________________________________
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| [[BIS_fnc_findInPairs]], [[BIS_fnc_addToPairs]] |SEEALSO=


|seealso= [[find]] [[findIf]] [[BIS_fnc_findInPairs]] [[BIS_fnc_getFromPairs]] [[BIS_fnc_addToPairs]] [[BIS_fnc_removeFromPairs]]
}}
}}
<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:setToPairs}}]]
[[Category:Functions|{{uc:setToPairs}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:setToPairs}}]]

Latest revision as of 15:47, 8 November 2023

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

Description

Description:
Works similar to the BIS_fnc_addToPairs but it doesn't try to add values. It just overwrites the volue if the key already exists.
Execution:
call
Groups:
Arrays

Syntax

Syntax:
[array, key, newValue] call BIS_fnc_setToPairs
Parameters:
array: Array - array to search through
key: String - key to search for
newValue: Anything - (Optional, default 1) new value set if match was found
Return Value:
Array - resulting modified array

Examples

Example 1:
[[["apple",3],["pear",2]],"pear",10] call BIS_fnc_setToPairs; // Returns [["apple",3],["pear",10]]

Additional Information

See also:
find findIf BIS_fnc_findInPairs BIS_fnc_getFromPairs BIS_fnc_addToPairs BIS_fnc_removeFromPairs

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_setToPairs&oldid=349084"