BIS fnc getFromPairs: 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.02|Game version=
|version1= 1.02
____________________________________________________________________________________________


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


Description:
<!--|arg= local-->
Searches the associative array for the 1st occurance of the key string and returns the value associated with it.


Syntax:
<!--|eff= local-->
_value = [_associativeArray:array,_key:string,_defaultValue] call BIS_fnc_getFromPairs;


Example:
|descr= Searches the associative array for the 1st occurance of the key string and returns the value associated with it. Search is not case sensitiv.
2 = [[["apple",3],["pear",2]],"pear"] call BIS_fnc_getFromPairs;


Returns:
|s1= [array, key, defaultValue] call [[BIS_fnc_getFromPairs]]
* if found: value stored under the key
* if not found: nil or _defaultValue
*/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |DESCRIPTION=
|p1= array: [[Array]] - Array to search through
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_getFromPairs]]; --> |SYNTAX=
|p2= key: [[String]] - Key to search for


|p1= |PARAMETER1=
|p3= defaultValue: [[Anything]] - (Optional, default [[nil]]) Default return value if no match was found


| |RETURNVALUE=
|r1= [[Anything]] - Value associated with the key.
____________________________________________________________________________________________


|x1= <code></code> |EXAMPLE1=
|x1= <code>[[["apple",3],["pear","test"]],"pear"] [[call]] [[BIS_fnc_getFromPairs]]; {{cc|Returns "test"}}</code>
____________________________________________________________________________________________


| |SEEALSO=
|x2= <code>[[["apple",3],["pear",6]],"pear"] [[call]] [[BIS_fnc_getFromPairs]]; {{cc|Returns "6"}}</code>


}}
|exec= call


<h3 style="display:none">Notes</h3>
|seealso= [[find]] [[findIf]] [[BIS_fnc_findInPairs]]
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
}}
</dl>


<h3 style="display:none">Bottom Section</h3>
<h3 style="display:none">Bottom Section</h3>

Revision as of 10:39, 15 September 2020

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

Description

Description:
Searches the associative array for the 1st occurance of the key string and returns the value associated with it. Search is not case sensitiv.
Execution:
call
Groups:
Uncategorised

Syntax

Syntax:
[array, key, defaultValue] call BIS_fnc_getFromPairs
Parameters:
array: Array - Array to search through
key: String - Key to search for
defaultValue: Anything - (Optional, default nil) Default return value if no match was found
Return Value:
Anything - Value associated with the key.

Examples

Example 1:
[[["apple",3],["pear","test"]],"pear"] call BIS_fnc_getFromPairs; // Returns "test"
Example 2:
[[["apple",3],["pear",6]],"pear"] call BIS_fnc_getFromPairs; // Returns "6"

Additional Information

See also:
find findIf BIS_fnc_findInPairs

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

Bottom Section

Posted on October 2, 2014 - 01:17 (UTC)
Benargee
BIS_fnc_findInPairs renamed to BIS_fnc_getFromPairs and now supports all variable types Source
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_getFromPairs&oldid=157278"