Difference between revisions of "FormList Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Jog
imported>Evernewjoy
Line 37: Line 37:
== Events ==
== Events ==
None
None
== Example Scripts ==
[[Complete_Example_Scripts#Cycle_Through_an_Array_of_Objects_and_Perform_an_Action_on_Each_Object.28FormLists.29 | FormList Script Example: Disabling/enabling a large quantity of objects easily]]

Revision as of 07:36, 19 March 2012


Native base script for Formlists in the game.

Definition

ScriptName FormList extends Form

Properties

None

Global Functions

None

Member Functions

Function AddForm(Form apForm)

  • Adds the given form to the form list.

Form Function GetAt(int aiIndex)

  • Returns the form in the list at index aiIndex.

int Function GetSize()

  • Returns the number of forms in the form list.

bool Function HasForm(Form akForm)

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

Function RemoveAddedForm(Form apForm)

  • Removes the given added form from the form list.

Function Revert()

  • Removes all script added forms from the form list.

Events

None

Example Scripts

FormList Script Example: Disabling/enabling a large quantity of objects easily