Difference between revisions of "Ar Prev"

From the Oblivion ConstructionSet Wiki
Jump to navigation Jump to search
imported>QQuix
(Organizing the Array Functions category list)
imported>QQuix
(Clarified the 'BadIndex' return value)
Line 2: Line 2:
{{Function
{{Function
  | origin = OBSE
  | origin = OBSE
  | summary = Returns the key of the element immediately preceding the passed key, or <tt>BadIndex</tt> if no key precedes it.
  | summary = Returns the key of the element immediately preceding the passed key, or [[Ar_BadNumericIndex]]/[[Ar_BadStringIndex]] if no key precedes it.
  | name = ar_Prev
  | name = ar_Prev
  | returnVal = key
  | returnVal = key

Revision as of 02:27, 26 December 2014

< [[::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, or Ar_BadNumericIndex/Ar_BadStringIndex if no key precedes it.