Difference between revisions of "Ar Next"

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 1: Line 1:
{{Function
{{Function
  | origin = OBSE
  | origin = OBSE
  | summary = Returns the key of the element immediately following the passed key, or <tt>BadIndex</tt> if no key follows it.
  | summary = Returns the key of the element immediately following the passed key, or [[Ar_BadNumericIndex]]/[[Ar_BadStringIndex]] if no key follows it.
  | name = ar_Next
  | name = ar_Next
  | 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_Next src:array precedingKey:arrayKey

Returns the key of the element immediately following the passed key, or Ar_BadNumericIndex/Ar_BadStringIndex if no key follows it.