BIS fnc setToPairs: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "^ {{Function\|Comments\=" to "{{Function|Comments=")
mNo edit summary
Line 1: Line 1:
{{Function|Comments=
{{Function
____________________________________________________________________________________________


| arma3 |Game name=
|game1= arma3


|1.00|Game version=
|version1= 1.00
____________________________________________________________________________________________


| <pre>/*
<!--|serverExec= server-->


Description:
<!--|arg= local-->
Sets an item in pair array to given value.


Remarks:
<!--|eff= local-->
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:
|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.
[["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=
|s1= [array, key, newValue] call [[BIS_fnc_setToPairs]]
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_setToPairs]]; --> |SYNTAX=
|p1= array: [[Array]] - Array to search through


|p1= |PARAMETER1=
|p2= key: [[String]] - Key to search for


| |RETURNVALUE=
|p3= newValue: [[Anything]] - (Optional, default 1) New value set if match was found
____________________________________________________________________________________________


|x1= <code></code> |=
|r1= [[Array]] - Resulting modified array
____________________________________________________________________________________________


| [[BIS_fnc_findInPairs]], [[BIS_fnc_addToPairs]] |SEEALSO=
|x1= <code>[[["apple",3],["pear",2]],"pear",10] [[call]] [[BIS_fnc_setToPairs]]; {{cc|Returns [["apple",3],["pear",10]]}}</code>


}}
|exec= call


<h3 style="display:none">Notes</h3>
|seealso= [[find]] [[findIf]] [[BIS_fnc_findInPairs]] [[BIS_fnc_getFromPairs]] [[BIS_fnc_addToPairs]]
<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:Function Group: Arrays|{{uc:setToPairs}}]]
[[Category:Functions|{{uc:setToPairs}}]]
[[Category:Functions|{{uc:setToPairs}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:setToPairs}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:setToPairs}}]]

Revision as of 10:57, 15 September 2020

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:
Uncategorised

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

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=157289"