Difference between revisions of "FormList Script"
Jump to navigation
Jump to search
imported>CraftySentinel m (→Member Functions: Reverted to List) |
imported>DavidJCobb (→Member Functions: SKSE member functions as of 2015-05-24) |
||
Line 38: | Line 38: | ||
:'''[[Revert - FormList|Revert]]()''' | :'''[[Revert - FormList|Revert]]()''' | ||
:*Removes all script added forms from the form list. | :*Removes all script added forms from the form list. | ||
== SKSE Member Functions == | |||
:'''[[AddForms - FormList|AddForms]](Form[] ''akForms'')''' | |||
:*Adds all forms in an array to the FormList. | |||
:'''Form[] [[ToArray - FormList|ToArray]]()''' | |||
:*Returns an array of all forms in the FormList. | |||
== Events == | == Events == |
Revision as of 17:13, 18 September 2016
Native base script for Formlists in the game.
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)