FormList Script

From the CreationKit Wiki
Jump to navigation Jump to search

Native base script for Formlists in the game.

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

Definition[edit | edit source]

ScriptName FormList extends Form

Properties[edit | edit source]


Global Functions[edit | edit source]


Member Functions[edit | edit source]

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.
  • Removes all script added forms from the form list.

SKSE Member Functions[edit | edit source]

AddForms(Form[] akForms)
  • Adds all forms in an array to the FormList.
Form[] ToArray()
  • Returns an array of all forms in the FormList.

Events[edit | edit source]


Example Scripts[edit | edit source]

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

Show Gift Inventory and Identify Items Given