AddFormToFormList

Revision as of 02:44, 16 November 2011 by imported>Yukichigai (This is HIGHLY useful knowledge, particularly for Ammo Lists in FNV)
< [[::Category:Functions|Category:Functions]]

A function included in the GECK version 1.1.0.36.

Description

Adds a form to a FormList. Unlike ListAddForm, this function adds the new form at the 0th index, adding 1 to the indices of the other list entries.

This function was originally intended to modify lists from the base game in downloadable content.

Syntax

AddFormToFormList FormListID:ref FormID:ref

Example

AddFormToFormList AlcoholicDrinks SamAdamsBeer
AddFormToFormList DialogueAnimationBulkyArmors NewBulkyArmor

Notes

  • Using this function to add a FormID already in the list will simply move it to the 0th index. It will not add a duplicate entry of the FormID to the list.
  • This function has been tested to accept any FormIDs, including base objects and dynamically created references.
  • If you are performing lots of list modifications through scripts, consider using the FOSE function ListAddForm instead.
  • In the first example above, the new beer is now considered alcoholic and will produce the same effects of other alcoholic drinks when the game checks this list (the actual list name in the editor is misspelled as AlchoholicDrinks).
  • In the second example above, animations are now aware of a new armor that is considered "bulky" and will be used to condition certain animations.

See Also