BIS fnc getFromPairs: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " (\|[pr][0-9]+ *= *[^-]+) *- *A([a-z])" to " $1 - a$2")
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *V([a-z ])" to "$1 - v$2")
 
(One intermediate revision by the same user not shown)
Line 13: Line 13:
|p1= array: [[Array]] - array to search through
|p1= array: [[Array]] - array to search through


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


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


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


|x1= <sqf>[[["apple",3],["pear","test"]],"pear"] call BIS_fnc_getFromPairs; // Returns "test"</sqf>
|x1= <sqf>[[["apple",3],["pear","test"]],"pear"] call BIS_fnc_getFromPairs; // Returns "test"</sqf>

Latest revision as of 15:53, 8 November 2023

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

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 BIS_fnc_addToPairs BIS_fnc_removeFromPairs 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
Benargee - c
Posted on Oct 02, 2014 - 01:17 (UTC)
BIS_fnc_findInPairs renamed to BIS_fnc_getFromPairs and now supports all variable types Source