Difference between revisions of "Ar Prev"
Jump to navigation
Jump to search
imported>QQuix (Clarified the 'BadIndex' return value) |
imported>QQuix (added another possible return) |
||
| Line 2: | Line 2: | ||
{{Function | {{Function | ||
| origin = OBSE | | origin = OBSE | ||
| summary = Returns the key of the element immediately preceding the passed key | | summary = Returns the key of the element immediately preceding the passed key. | ||
Returns [[Ar_BadNumericIndex]]/[[Ar_BadStringIndex]] if no key precedes it. | |||
Returns [[Ar_BadNumericIndex]]/[[Ar_BadStringIndex]] if the passed key does not exist in the array. | |||
| name = ar_Prev | | name = ar_Prev | ||
| returnVal = key | | returnVal = key | ||
Latest revision as of 08:04, 3 January 2015
< [[::Category:Functions|Category:Functions]]
A function added by the Oblivion Script Extender.
Syntax:
(key:arrayKey) ar_Prev src:array prevKey:arrayKey
Returns the key of the element immediately preceding the passed key.
Returns Ar_BadNumericIndex/Ar_BadStringIndex if no key precedes it.
Returns Ar_BadNumericIndex/Ar_BadStringIndex if the passed key does not exist in the array.