Difference between revisions of "ListGetFormIndex"
Jump to navigation
Jump to search
imported>Kalizar |
imported>Odessa (Clarified) |
||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
{{Function | {{Function | ||
|origin = FOSE1 | |origin = FOSE1 | ||
|summary = Returns the index for the specified form | |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 | ||
|returnType = int | |returnType = int | ||
|arguments = | |arguments = | ||
{{FunctionArgument | {{FunctionArgument | ||
|Name = | |Name = formlist | ||
|Type = ref | |Type = ref | ||
}}{{FunctionArgument | }}{{FunctionArgument | ||
| Line 13: | Line 13: | ||
}} | }} | ||
}} | }} | ||
==Example== | |||
<pre> | |||
int iIndex | |||
set iIndex to ListGetFormIndex GoodspringersList, SunnyREF | |||
</pre> | |||
==Notes== | |||
*The first form in the list is at index 0, and the last is equal to ([[ListGetCount|ListGetCount - 1]]). | |||
==See Also== | |||
*[[IsInList]] (Checks for base objects only) | |||
*[[IsRefInList]] (Indexes both exact and base/leveled matches) | |||
*[[ListGetCount]] | |||
[[Category:Functions_(FOSE)]] [[Category:List_Functions]] | [[Category:Functions_(FOSE)]] [[Category:List_Functions]] | ||
Latest revision as of 18:08, 1 July 2014
< [[::Category:Functions|Category:Functions]]
A function added by the Fallout Script Extender.
Description
Returns the index for the specified form if it is found exactly in the specified form list, otherwise returns constant -1 (not found).
Syntax
(int) ListGetFormIndex formlist:ref form:ref
Example
int iIndex set iIndex to ListGetFormIndex GoodspringersList, SunnyREF
Notes
- The first form in the list is at index 0, and the last is equal to (ListGetCount - 1).
See Also
- IsInList (Checks for base objects only)
- IsRefInList (Indexes both exact and base/leveled matches)
- ListGetCount