Difference between revisions of "FormList Script"

98 bytes added ,  05:01, 24 October 2013
m
→‎Member Functions: Formatting Change
imported>JustinOther
(Added missing Find function)
imported>CraftySentinel
m (→‎Member Functions: Formatting Change)
Line 17: Line 17:


== Member Functions ==
== Member Functions ==
'''Function [[AddForm - FormList|AddForm]](Form apForm)'''
*Adds the given form to the form list.


'''Int Function [[Find - FormList|Find]](Form apForm)'''
{|class="wikitable" width =100%
*Finds the specified form in the form list and returns its index or returns -1 if it's not a member.
!style="text-align:left;"|Function
!style="text-align:left;"|Description
|-
|[[AddForm - FormList|'''AddForm'''(Form ''apForm'')]]
|Adds the given form to the form list.
|-


'''Form Function [[GetAt - FormList|GetAt]](int aiIndex)'''
|[[Find - FormList|Int '''Find'''(Form ''apForm'')]]
*Returns the form in the list at index ''aiIndex''.
|Finds the specified form in the form list and returns its index or returns -1 if it's not a member.
|-


'''int Function [[GetSize - FormList|GetSize]]()'''
|[[GetAt - FormList|Form '''GetAt'''(Int ''aiIndex'')]]
*Returns the number of forms in the form list.
|Returns the form in the list at index ''aiIndex''.
|-


'''bool Function [[HasForm - FormList|HasForm]](Form akForm)'''
|[[GetSize - FormList|Int '''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)'''
|[[HasForm - FormList|Bool '''HasForm'''(Form ''akForm'')]]
*Removes the given added form from the form list.
|Returns whether the passed-in form is in this form list.
|-


'''Function [[Revert - FormList|Revert]]()'''
|[[RemoveAddedForm - FormList|'''RemoveAddedForm'''(Form ''apForm'')]]
*Removes all script added forms from the form list.
|Removes the given added form from the form list.
|-
 
|[[Revert - FormList|'''Revert'''()]]
|Removes all script added forms from the form list.
|-
 
|}


== Events ==
== Events ==