Difference between revisions of "FormList Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Sollar
imported>JustinOther
(Added missing Find function)
Line 19: Line 19:
'''Function [[AddForm - FormList|AddForm]](Form apForm)'''
'''Function [[AddForm - FormList|AddForm]](Form apForm)'''
*Adds the given form to the form list.
*Adds the given form to the form list.
'''Int Function [[Find - FormList|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 Function [[GetAt - FormList|GetAt]](int aiIndex)'''
'''Form Function [[GetAt - FormList|GetAt]](int aiIndex)'''

Revision as of 18:26, 18 February 2013


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.

Int Function 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 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

FormList Script Example: Show Gift Window and Identify Items Given