Ar First

From the Fallout3 GECK Wiki
Jump to navigation Jump to search
< [[::Category:Functions|Category:Functions]]

A function added by the New Vegas Script Extender.

Description

Returns the first key of an array. For regular arrays (list arrays) this is just equivalent to SomeRegArray[0]. This function is intended for use with map and stringmap arrays, where the first key is dynamic. Note that map and stringmap arrays are always sorted in ascending numeric or alphanumeric order, regardless of the order of element insertion.

Syntax

[help]
(key:int-or-float-or-string) Ar_First Source:array

Example

array_var MyMap
int iKey ; * or float/string_var as appropriate for array

let iKey := Ar_First MyMap

if eval MyMap[iKey] == SunnyREF
    ; * SunnyREF is the value corresponding to first key in MyMap
endif

See Also