Difference between revisions of "FormList"

From the Fallout3 GECK Wiki
Jump to navigation Jump to search
imported>Quetzilla
m
imported>Omzy
m
 
(10 intermediate revisions by 4 users not shown)
Line 1: Line 1:
The '''FormList''' object is a list of other forms (base objects). Other objects can use these lists for a variety of purposes. The most common is a list of objects that can be used to repair an object.
==Description==
The '''FormList''' object is a list of other forms (editor objects and references). Other objects can use these lists for a variety of purposes.
 
==Common Uses in the GECK==
*The list of food or drink items that belong in a consumable category (e.g. alcoholic drinks).
*The list of [[ArmorAddon|armor addons]] for a suit of armor.
*The list of ingredients in custom weapon recipes.
*The list of weapons that belong in a weapons category (e.g. hand-to-hand weapons).
*The list of residents of a township or territory.
*The list of objects that can be used to repair an object.


=='''FormList Dialog'''==
=='''FormList Dialog'''==
Line 5: Line 14:
*'''Type:''' Type of object.
*'''Type:''' Type of object.
*'''EditorID:''' The ID of the form.
*'''EditorID:''' The ID of the form.
*'''NumericID:''' The numeric ID of the form.
== Editing Form Lists ==
This can be puzzling at first because right clicking in the Form List does not pop up a 'New' option like most other lists in the GECK.  Instead what you do is drag and drop object from the [[Object Window]] to the list.  You can then select an object in the list and press the Delete key to remove it (this only removes it from the list, it does not delete the object from your mod).  The << and >> buttons at the bottom of the screen allow you to order the list however you want, which can be helpful when [[How to Keep Track of Your Records|using Form Lists to keep your mod organized]].


== Notes ==
== Notes ==
* Note: Form list are required when using [[Armor Add-on]]s.
*FormLists may also contain references (not just base objects) if they are added through script functions in FOSE or from the Cell View window.
* If using a form list in a condition that runs continuously (such as on an Ability Game Effect), it may be useful to optimize the list, by sorting the most frequently check items to the top of the list.  If the list has 60 forms in it, and the forms usually checked for are at the bottom of the list, the game has to check every entry above those forms every time the condition runs.  In most cases, though, this effect will be minimal.
*FormLists can also be used in place of [[Ammo]] entries for [[Weapons|Weapon]] items.
*If using a form list in a condition that runs continuously (such as on an Ability Game Effect), it may be useful to optimize the list, by sorting the most frequently check items to the top of the list.  If the list has 60 forms in it, and the forms usually checked for are at the bottom of the list, the game has to check every entry above those forms every time the condition runs.  In most cases, though, this effect will be minimal.
 
== See Also ==
*[[Scripting Tutorial: Working with FormLists]]
*[[How to Keep Track of Your Records]]
*[[IsInList]]
*[[IsWeaponInList]]
*[[AddFormToFormList]]


[[Category:Miscellaneous]]
[[Category:Miscellaneous]]

Latest revision as of 21:40, 3 August 2009

Description[edit | edit source]

The FormList object is a list of other forms (editor objects and references). Other objects can use these lists for a variety of purposes.

Common Uses in the GECK[edit | edit source]

  • The list of food or drink items that belong in a consumable category (e.g. alcoholic drinks).
  • The list of armor addons for a suit of armor.
  • The list of ingredients in custom weapon recipes.
  • The list of weapons that belong in a weapons category (e.g. hand-to-hand weapons).
  • The list of residents of a township or territory.
  • The list of objects that can be used to repair an object.

FormList Dialog[edit | edit source]

  • ID: Unique identifier for this form list.
  • Type: Type of object.
  • EditorID: The ID of the form.
  • NumericID: The numeric ID of the form.

Editing Form Lists[edit | edit source]

This can be puzzling at first because right clicking in the Form List does not pop up a 'New' option like most other lists in the GECK. Instead what you do is drag and drop object from the Object Window to the list. You can then select an object in the list and press the Delete key to remove it (this only removes it from the list, it does not delete the object from your mod). The << and >> buttons at the bottom of the screen allow you to order the list however you want, which can be helpful when using Form Lists to keep your mod organized.

Notes[edit | edit source]

  • FormLists may also contain references (not just base objects) if they are added through script functions in FOSE or from the Cell View window.
  • FormLists can also be used in place of Ammo entries for Weapon items.
  • If using a form list in a condition that runs continuously (such as on an Ability Game Effect), it may be useful to optimize the list, by sorting the most frequently check items to the top of the list. If the list has 60 forms in it, and the forms usually checked for are at the bottom of the list, the game has to check every entry above those forms every time the condition runs. In most cases, though, this effect will be minimal.

See Also[edit | edit source]