Difference between revisions of "ListGetFormIndex"

Latest revision as of 18:08, 1 July 2014

< [[::Category:Functions|Category:Functions]]

A function added by the Fallout Script Extender.

Returns the index for the specified form if it is found exactly in the specified form list, otherwise returns constant -1 (not found).

(int) ListGetFormIndex formlist:ref form:ref

int iIndex
set iIndex to ListGetFormIndex GoodspringersList, SunnyREF

The first form in the list is at index 0, and the last is equal to (ListGetCount - 1).

@@ Line 1: / Line 1: @@
 {{Function
   |origin = FOSE1
-  |summary = Returns the index of a form in a [[FormList]].
+  |summary = Returns the index for the specified form if it is found exactly in the specified form list, otherwise returns constant -1 (not found).
   |name = ListGetFormIndex
- |returnVal = index
   |returnType = int
   |arguments =
    {{FunctionArgument
-    |Name = FormListID
+    |Name = formlist
     |Type = ref
    }}{{FunctionArgument
-    |Name = FormID
+    |Name = form
     |Type = ref
    }}
- |example = ListGetFormIndex myFormList myForm
 }}
+==Example==
+<pre>
+int iIndex
+set iIndex to ListGetFormIndex GoodspringersList, SunnyREF
+</pre>
 ==Notes==
-*See [[ListGetNthForm]] to get the form at a specified index.
+*The first form in the list is at index 0, and the last is equal to ([[ListGetCount|ListGetCount - 1]]).
 ==See Also==
-*[[ListAddForm]]
+*[[IsInList]] (Checks for base objects only)
-*[[ListAddReference]]
+*[[IsRefInList]] (Indexes both exact and base/leveled matches)
-*[[ListRemoveForm]]
-*[[ListRemoveNthForm]]
-*[[ListReplaceForm]]
-*[[ListReplaceNthForm]]
-*[[ListGetNthForm]]
 *[[ListGetCount]]
-*[[AddFormToFormList]]
+[[Category:Functions_(FOSE)]] [[Category:List_Functions]]
-*[[IsInList]]
-*[[IsWeaponInList]]
-[[Category:List Functions]]