Difference between revisions of "ListGetFormIndex"

87 bytes added ,  19:08, 1 July 2014
Clarified
imported>Omzy
m
imported>Odessa
(Clarified)
 
(7 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Function
{{Function
  |origin = FOSE1
  |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
  |name = ListGetFormIndex
|returnVal = index
  |returnType = int
  |returnType = int
  |arguments =
  |arguments =  
   {{FunctionArgument
   {{FunctionArgument
   |Name = FormListID
   |Name = formlist
   |Type = ref
   |Type = ref
   }}{{FunctionArgument
   }}{{FunctionArgument
   |Name = FormID
   |Name = form
   |Type = ref
   |Type = ref
   }}
   }}
|example = ListGetFormIndex myFormList myForm
}}
}}
 
==Example==
<pre>
int iIndex
set iIndex to ListGetFormIndex GoodspringersList, SunnyREF
</pre>
==Notes==
==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==
==See Also==
*[[ListAddForm]]
*[[IsInList]] (Checks for base objects only)
*[[ListAddReference]]
*[[IsRefInList]] (Indexes both exact and base/leveled matches)
*[[ListRemoveForm]]
*[[ListRemoveNthForm]]
*[[ListReplaceForm]]
*[[ListReplaceNthForm]]
*[[ListGetNthForm]]
*[[ListGetCount]]
*[[ListGetCount]]
*[[AddFormToFormList]]
[[Category:Functions_(FOSE)]] [[Category:List_Functions]]
*[[IsInList]]
*[[IsWeaponInList]]
 
[[Category:List Functions]]
Anonymous user