Difference between revisions of "FormList Script"
Jump to navigation
Jump to search
imported>DavidJCobb (→Member Functions: SKSE member functions as of 2015-05-24) |
m (Link to Glitchfinder's pseudocode) |
||
| Line 5: | Line 5: | ||
Native base script for Formlists in the game. | Native base script for Formlists in the game. | ||
== Definition == | See [[FormList Pseudocode]] for a more detailed perspective on the vanilla functions using C++. | ||
==Definition== | |||
<source lang="papyrus"> | <source lang="papyrus"> | ||
ScriptName FormList extends Form | ScriptName FormList extends Form | ||
</source> | </source> | ||
== Properties == | ==Properties== | ||
None | None | ||
== Global Functions == | ==Global Functions== | ||
None | None | ||
== Member Functions == | ==Member Functions== | ||
:'''[[AddForm - FormList|AddForm]](Form ''apForm'')''' | :'''[[AddForm - FormList|AddForm]](Form ''apForm'')''' | ||
:*Adds the given form to the form list. | :*Adds the given form to the form list. | ||
:'''Int [[Find - FormList|Find]](Form ''apForm'')''' | :'''Int [[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. | :*Finds the specified form in the form list and returns its index or returns -1 if it's not a member. | ||
:'''Form [[GetAt - FormList|GetAt]](Int ''aiIndex'')''' | :'''Form [[GetAt - FormList|GetAt]](Int ''aiIndex'')''' | ||
| Line 39: | Line 41: | ||
:*Removes all script added forms from the form list. | :*Removes all script added forms from the form list. | ||
== SKSE Member Functions == | ==SKSE Member Functions == | ||
:'''[[AddForms - FormList|AddForms]](Form[] ''akForms'')''' | :'''[[AddForms - FormList|AddForms]](Form[] ''akForms'')''' | ||
:*Adds all forms in an array to the FormList. | :*Adds all forms in an array to the FormList. | ||
| Line 46: | Line 48: | ||
:*Returns an array of all forms in the FormList. | :*Returns an array of all forms in the FormList. | ||
== Events == | ==Events== | ||
None | None | ||
== Example Scripts == | ==Example Scripts== | ||
[[Complete_Example_Scripts#Cycle_Through_a_List_of_Objects_and_Perform_an_Action_on_Each_Object.28FormLists.29 | Cycle Through a List of Objects and Perform an Action on Each Object(FormLists)]] | [[Complete_Example_Scripts#Cycle_Through_a_List_of_Objects_and_Perform_an_Action_on_Each_Object.28FormLists.29 | Cycle Through a List of Objects and Perform an Action on Each Object(FormLists)]] | ||
[[Complete_Example_Scripts#Show_Gift_Inventory_and_Identify_Items_Given | Show Gift Inventory and Identify Items Given]] | [[Complete_Example_Scripts#Show_Gift_Inventory_and_Identify_Items_Given | Show Gift Inventory and Identify Items Given]] | ||
Revision as of 19:40, 7 March 2022
Native base script for Formlists in the game.
See FormList Pseudocode for a more detailed perspective on the vanilla functions using C++.
Definition
ScriptName FormList extends FormProperties
None
Global Functions
None
Member Functions
- 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.
SKSE Member Functions
- AddForms(Form[] akForms)
- Adds all forms in an array to the FormList.
- Form[] ToArray()
- Returns an array of all forms in the FormList.
Events
None
Example Scripts
Cycle Through a List of Objects and Perform an Action on Each Object(FormLists)