Difference between revisions of "AddFormToFormList"

AddFormToFormList (edit)

Revision as of 08:51, 3 August 2009

321 bytes added , 08:51, 3 August 2009

redone

Anonymous user

imported>Omzy

@@ Line 1: / Line 1: @@
-=='''Description'''==
+{{Function
+ |CSWikiPage = AddFormToFormList
-'''AddFormToFormList''' Adds a form to a [[FormList]]. This should be used in the RARE case where we want to add an item to a form list that already exists in the ESM. It's primary use it for modifying lists from the base game in downloadable content. In most cases you should add items to form lists in the editor object windows. This is for those special cases where you want to alter the contents of a list at runtime or want to change it without putting it in your ESP/ESM file. Once altered using this function, it will persist in the save game data.
+ |origin = GECK1
+ |summary = 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.
-It can '''not''' be undone.
-=='''Syntax'''==
- AddFormToFormList ''FormList'' ''FormToAdd''
-(parameters are Base Objects)
-=='''Examples'''==
+This function was originally intended to modify lists from the base game in downloadable content.
+ |name = AddFormToFormList
+ |arguments =
+  {{FunctionArgument
+   |Name = FormListID
+   |Type = ref
+  }}{{FunctionArgument
+   |Name = FormID
+   |Type = ref
+  }}
+ |example = AddFormToFormList AlcoholicDrinks SamAdamsBeer
   AddFormToFormList DialogueAnimationBulkyArmors NewBulkyArmor
+}}
-Animations are now aware of a new armor that is considered "bulky" and will be used to condition certain animations.
+==Notes==
+*This function has been tested to accept any FormIDs, including base objects and dynamically created references.
-=='''Notes'''==
+*If you are performing lots of list modifications through scripts, consider using the FOSE function [[ListAddForm]] instead.
-*This function is new in the GECK, and was not available in the TES4 Construction Set.
+*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'''==
-*[[AddNPCToLeveledList]]
-*[[AddCreatureToLeveledList]]
-*[[AddItemToLeveledList]]
-=='''Reference'''==
-None provided.
+==See Also==
+*[[ListAddForm]]
+*[[ListAddReference]]
+*[[ListRemoveForm]]
+*[[ListRemoveNthForm]]
+*[[ListReplaceForm]]
+*[[ListReplaceNthForm]]
+*[[ListGetForm]]
+*[[ListGetNthForm]]
+*[[ListGetFormIndex]]
+*[[ListGetcount]]
+*[[IsInList]]
+*[[IsWeaponInList]]
-[[Category:Functions]]
+[[Category:List Functions]]
-[[Category:Object Functions]]