Difference between revisions of "ListAddForm"

← Older edit

ListAddForm (edit)

Revision as of 18:34, 3 September 2010

759 bytes removed , 18:34, 3 September 2010

no edit summary

Anonymous user

imported>Kalizar

@@ Line 1: / Line 1: @@
 {{Function
   |origin = FOSE1
-  |summary = Adds a form 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 form to the list at the given index (or at the end if not provided)
   |name = ListAddForm
- |returnVal = addedAtIndex
+  |returnType = ref
-  |returnType = int
   |arguments =
    {{FunctionArgument
-    |Name = FormListID
+    |Name = form list
     |Type = ref
    }}{{FunctionArgument
-    |Name = FormID
+    |Name = form
     |Type = ref
    }}{{FunctionArgument
     |Name = index
     |Type = int
-    |Optional = y
+    |Optional = optional
    }}
- |example = ListAddForm myFormList myForm
- ListAddForm yourFormList yourForm 4
 }}
+[[Category:Functions_(FOSE)]] [[Category:List_Functions]]
-==Notes==
-*This function differs from [[AddFormToFormList]] in the way that forms are added to a [[FormList]] when no index is given.
-*This function has been tested to accept any FormIDs, including base objects and dynamically created references.
-==See Also==
-*[[ListAddReference]]
-*[[ListRemoveForm]]
-*[[ListRemoveNthForm]]
-*[[ListReplaceForm]]
-*[[ListReplaceNthForm]]
-*[[ListGetNthForm]]
-*[[ListGetFormIndex]]
-*[[ListGetcount]]
-*[[AddFormToFormList]]
-*[[IsInList]]
-*[[IsWeaponInList]]
-[[Category:List Functions]]