Difference between revisions of "ListAddReference"

← Older edit

ListAddReference (edit)

Revision as of 11:01, 18 August 2012

545 bytes removed , 11:01, 18 August 2012

no edit summary

Anonymous user

imported>Prideslayer

@@ Line 1: / Line 1: @@
 {{Function
   |origin = FOSE1
-  |summary = Adds a reference to a [[FormList]] with the option to specify an index. If no index is specified, the form is added at the end of the list (with the highest index). This differs from [[AddFormToFormList]]. The function returns the index at which the form was successfully added.
+  |summary = Adds the calling reference at the given index (or at the end if not provided)
   |name = ListAddReference
-  |returnVal = addedAtIndex
+  |alias = ListAddRef
   |returnType = int
-  |referenceType = [Object]
+  |referenceType = ref
   |arguments =
    {{FunctionArgument
-    |Name = FormListID
+    |Name = form list
     |Type = ref
    }}{{FunctionArgument
     |Name = index
     |Type = int
-    |Optional = y
+    |Optional = optional
    }}
- |example = myForm.ListAddReference myFormList
- yourForm.ListAddReference yourFormList 4
 }}
+Note that forms added to a list with this function will not persist across savegames.  If you need to add items to a list that will be preserved in a saved game, use [[AddFormToFormList]]
-==Notes==
+[[Category:Functions_(FOSE)]]
-*If you wish to add a base object form to a [[FormList]], use [[ListAddForm]].
-*This function differs from [[AddFormToFormList]] in the way that forms are added to a [[FormList]] when no index is given.
-==See Also==
-*[[ListAddForm]]
-*[[ListRemoveForm]]
-*[[ListRemoveNthForm]]
-*[[ListReplaceForm]]
-*[[ListReplaceNthForm]]
-*[[ListGetForm]]
-*[[ListGetNthForm]]
-*[[ListGetFormIndex]]
-*[[ListGetcount]]
-*[[AddFormToFormList]]
-*[[IsInList]]
-*[[IsWeaponInList]]
 [[Category:List Functions]]