Find - FormList | Fallout 4

Found in:

Vanilla

intfunctionFind(FormapForm)Native

Description

Wiki Description

Searches for the specified form in the form list, returning its index (or a negative number if the form isn't found in the list)

Documentation Comment

Finds the specified form in the form list and returns its index.
If not found, returns a negative number

Caveats

Parameters

FormapForm

CK Wiki Description

Form to search for

Examples

; Find the diamond in the form list
int index = GemList.Find(Diamond)
if index < 0
  Debug.Trace("Diamond doesn't exist in the form list!")
else
  Debug.Trace("Diamond is in the form list at position " + location)
endIf; Find the diamond in the form list
int index = GemList.Find(Diamond)
if index < 0
  Debug.Trace("Diamond doesn't exist in the form list!")
else
  Debug.Trace("Diamond is in the form list at position " + location)
endIf

Auto-Generated Example

Form myForm__apForm

int returnedValue = myFormList__toCallFunctionOn.Find(myForm__apForm)

FormList
FormList.HasForm(...)

Additional References

View this function’s page on the Fallout 4 Creation Kit Wiki