FormList Script

Native base script for Formlists in the game.

See FormList Pseudocode for a more detailed perspective on the vanilla functions using C++.

Definition

ScriptName FormList extends Form

Properties

None

Global Functions

None

Member Functions

AddForm(Form apForm)

• Adds the given form to the form list.

Int Find(Form apForm)

• Finds the specified form in the form list and returns its index or returns -1 if it's not a member.

Form GetAt(Int aiIndex)

• Returns the form in the list at index aiIndex.

Int GetSize()

• Returns the number of forms in the form list.

Bool HasForm(Form akForm)

• Returns whether the passed-in form is in this form list.

RemoveAddedForm(Form apForm)

• Removes the given added form from the form list.

Revert()

• Removes all script added forms from the form list.

SKSE Member Functions

AddForms(Form[] akForms)

• Adds all forms in an array to the FormList.

Form[] ToArray()

• Returns an array of all forms in the FormList.

Events

None

Example Scripts

Cycle Through a List of Objects and Perform an Action on Each Object(FormLists)

Show Gift Inventory and Identify Items Given