ListGetFormIndex

From GECK
Jump to: navigation, search


A function added by the Fallout Script Extender.

Description

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

Syntax

[help]
(formIndex:int) ListGetFormIndex formlist:baseform form:ref 

Example

int iIndex
set iIndex to ListGetFormIndex GoodspringersList, SunnyREF

To determine if SunnyRef is in GoodspringersList, one could check:

if ListGetFormIndex GoodspringersList SunnyREF > -1

Notes

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

See Also