Difference between revisions of "FormList Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Himika
imported>Jog
Line 17: Line 17:


== Member Functions ==
== Member Functions ==
*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.
*Form Function [[GetAt - FormList|GetAt]](int aiIndex)
 
**Returns the form in the list at index ''aiIndex''.
'''Form Function [[GetAt - FormList|GetAt]](int aiIndex)'''
*int Function [[GetSize - FormList|GetSize]]()
*Returns the form in the list at index ''aiIndex''.
**Returns the number of forms in the form list.
 
*bool Function [[HasForm - FormList|HasForm]](Form akForm)
'''int Function [[GetSize - FormList|GetSize]]()'''
**Returns whether the passed-in form is in this form list.
*Returns the number of forms in the form list.
*Function [[RemoveAddedForm - FormList|RemoveAddedForm]](Form apForm)
 
**Removes the given added form from the form list.
'''bool Function [[HasForm - FormList|HasForm]](Form akForm)'''
*Function [[Revert - FormList|Revert]]()
*Returns whether the passed-in form is in this form list.
**Removes all script added forms from the form list.
 
'''Function [[RemoveAddedForm - FormList|RemoveAddedForm]](Form apForm)'''
*Removes the given added form from the form list.
 
'''Function [[Revert - FormList|Revert]]()'''
*Removes all script added forms from the form list.


== Events ==
== Events ==
None
None

Revision as of 12:46, 20 February 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