BIS fnc getFromPairs: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Some wiki formatting)
m (Text replacement - "(\|p[0-9]+ *= *[^(]+\(Optional(, default[^)]*)\) )D([a-z])" to "$1d$3")
Line 15: Line 15:
|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.

Revision as of 13:28, 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