Difference between revisions of "Ar Find"
Jump to navigation
Jump to search
imported>QQuix (Organizing the Array Functions category list) |
imported>QQuix (added Ar_BadNumericIndex/Ar_BadStringIndex info and example) |
||
| Line 1: | Line 1: | ||
{{Function | {{Function | ||
| origin = OBSE | | origin = OBSE | ||
| summary = Locates the first occurrence of the specified value within an array and returns the key associated with it. A range may optionally be specified using range notation, i.e. <tt>let key := ar_Find "tofind" arrayVar lowerBound:upperBound</tt>. If the value is not found, the function returns an empty string | | summary = Locates the first occurrence of the specified value within an array and returns the key associated with it. A range may optionally be specified using range notation, i.e. <tt>let key := ar_Find "tofind" arrayVar lowerBound:upperBound</tt>. If the value is not found, the function returns [[Ar_BadStringIndex]] (an empty string) for string-indexed arrays or [[Ar_BadNumericIndex]] (the value -99999.0) for numeric-indexed arrays. | ||
| name = ar_Find | | name = ar_Find | ||
| returnVal = key | | returnVal = key | ||
| Line 18: | Line 18: | ||
}} | }} | ||
}} | }} | ||
====Example==== | |||
if eval ( ar_Find MyValue MyArray ) == Ar_BadNumericIndex | |||
;Value not present in array | |||
endif | |||
[[Category:Functions]] | [[Category:Functions]] | ||
Latest revision as of 15:55, 7 September 2015
< [[::Category:Functions|Category:Functions]]
A function added by the Oblivion Script Extender.
Syntax:
(key:stringOrNumber) ar_Find value:stringOrNumberOrForm arrayToSearch:array inRange:range
Locates the first occurrence of the specified value within an array and returns the key associated with it. A range may optionally be specified using range notation, i.e. let key := ar_Find "tofind" arrayVar lowerBound:upperBound. If the value is not found, the function returns Ar_BadStringIndex (an empty string) for string-indexed arrays or Ar_BadNumericIndex (the value -99999.0) for numeric-indexed arrays.
Example
if eval ( ar_Find MyValue MyArray ) == Ar_BadNumericIndex ;Value not present in array endif