Difference between revisions of "FormList Script"
Jump to navigation
Jump to search
imported>JustinOther (Added missing Find function) |
imported>CraftySentinel m (→Member Functions: Formatting Change) |
||
| Line 17: | Line 17: | ||
== Member Functions == | == Member Functions == | ||
{|class="wikitable" width =100% | |||
!style="text-align:left;"|Function | |||
!style="text-align:left;"|Description | |||
|- | |||
|[[AddForm - FormList|'''AddForm'''(Form ''apForm'')]] | |||
|Adds the given form to the form list. | |||
|- | |||
|[[Find - FormList|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. | |||
|- | |||
|[[GetAt - FormList|Form '''GetAt'''(Int ''aiIndex'')]] | |||
|Returns the form in the list at index ''aiIndex''. | |||
|- | |||
|[[GetSize - FormList|Int '''GetSize'''()]] | |||
|Returns the number of forms in the form list. | |||
|- | |||
|[[HasForm - FormList|Bool '''HasForm'''(Form ''akForm'')]] | |||
|Returns whether the passed-in form is in this form list. | |||
|- | |||
''' | |[[RemoveAddedForm - FormList|'''RemoveAddedForm'''(Form ''apForm'')]] | ||
|Removes the given added form from the form list. | |||
|- | |||
|[[Revert - FormList|'''Revert'''()]] | |||
|Removes all script added forms from the form list. | |||
|- | |||
|} | |||
== Events == | == Events == | ||
Revision as of 04:01, 24 October 2013
Native base script for Formlists in the game.
Definition
ScriptName FormList extends FormProperties
None
Global Functions
None
Member Functions
| Function | Description |
|---|---|
| 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. |
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