ListAddForm

A function added by the Fallout Script Extender.

Description

Adds a form to a FormList with the option to specify an index. If no index is specified, the form is added at the end of the list (with the highest index). This differs from AddFormToFormList. The function returns the index at which the form was successfully added.

Syntax

[help]

(addedAtIndex:int) ListAddForm FormListID:ref FormID:ref index:int

Example

ListAddForm myFormList myForm
ListAddForm yourFormList yourForm 4

Notes

• This function differs from AddFormToFormList in the way that forms are added to a FormList when no index is given.
• This function has been tested to accept any FormIDs, including base objects and dynamically created references.

See Also

• ListAddReference
• ListRemoveForm
• ListRemoveNthForm
• ListReplaceForm
• ListReplaceNthForm
• ListGetNthForm
• ListGetFormIndex
• ListGetCount
• AddFormToFormList
• IsInList
• IsWeaponInList