Difference between revisions of "Ar Prev"

From the Oblivion ConstructionSet Wiki
Jump to navigation Jump to search
imported>CSbot
(Automated import of articles)
 
imported>QQuix
(added another possible return)
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{BotAddedPage|CSbot|DragoonWraith}}
 
{{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.
 
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
Line 19: Line 23:
[[Category:Functions (OBSE)]]
[[Category:Functions (OBSE)]]
[[Category:Functions (OBSE v0017)]]
[[Category:Functions (OBSE v0017)]]
[[Category:Array Variable Functions (OBSE)]]
[[Category:Array Functions (OBSE)]]

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.