Difference between revisions of "RefMapArrayGetFirst"
Jump to navigation
Jump to search
imported>Jazzisparis (Created page with "{{Function |origin = JIP |summary = Returns the <i>Key</i> of the first element of the specified RefMap Array. |name = RefMapArrayGetFirst |alias = RefMapFirst |retur...") |
imported>Jazzisparis |
||
| Line 1: | Line 1: | ||
{{Function | {{Function | ||
|origin = JIP | |origin = JIP | ||
|summary = Returns the | |summary = Returns an '''array_var''' with the first '''Key::Value''' pair in the specified [[RefMap Array]]. The first element in the returned array is the '''Key''' (reference type), and the second element is the '''Value''' (float/reference/string type). | ||
|name = RefMapArrayGetFirst | |name = RefMapArrayGetFirst | ||
|alias = RefMapFirst | |alias = RefMapFirst | ||
|returnType = | |returnType = array_var | ||
|arguments = | |arguments = | ||
{{FunctionArgument | {{FunctionArgument | ||
| Line 10: | Line 10: | ||
|Type = string | |Type = string | ||
}} | }} | ||
|example = | |example = let aKeyValue := RefMapArrayGetFirst "someRefMap" | ||
let aKeyValue := RefMapFirst "someRefMap" | |||
}} | }} | ||
==See Also== | ==See Also== | ||
[[Category:Functions_(JIP)]] | [[Category:Functions_(JIP)]] | ||
[[Category:RefMap Array Functions (JIP)]] | [[Category:RefMap Array Functions (JIP)]] | ||
Revision as of 17:50, 28 January 2017
< [[::Category:Functions|Category:Functions]]
A function added by the JIP NVSE Plugin.
Description
Returns an array_var with the first Key::Value pair in the specified RefMap Array. The first element in the returned array is the Key (reference type), and the second element is the Value (float/reference/string type).
Syntax
(array_var) RefMapArrayGetFirst arrName:string
Or:
(array_var) RefMapFirst arrName:string
Example
let aKeyValue := RefMapArrayGetFirst "someRefMap"
let aKeyValue := RefMapFirst "someRefMap"