Difference between revisions of "ListReplaceNthForm"

ListReplaceNthForm (edit)

415 bytes removed , 12:24, 27 July 2010

Automated import of articles

Anonymous user

@@ Line 1: / Line 1: @@
+'''ListReplaceNthForm'''
 {{Function
   |origin = FOSE1
-  |summary = Replaces the form in a [[FormList]] at a specified index with another form. The function returns the removed form.
+  |summary = Replaces the nth form of the list with the specified form. Trait name is of the format used by GetUIFloat.
   |name = ListReplaceNthForm
-  |returnVal = removedForm
+  |alias = ListReplaceNth
   |returnType = ref
   |arguments =
    {{FunctionArgument
-    |Name = FormListID
+    |Name = form list
     |Type = ref
    }}{{FunctionArgument
-    |Name = NewFormID
+    |Name = replaceWith
     |Type = ref
    }}{{FunctionArgument
-    |Name = index
+    |Name = formIndex
     |Type = int
+   |Optional = optional
    }}
- |example = ListReplaceNthForm myFormList myNewForm 4
 }}
+[[Category:Functions_(FOSE)]]
-==Notes==
-*See [[ListReplaceForm]] for replacing a form without specifying an index.
-==See Also==
-*[[ListAddForm]]
-*[[ListAddReference]]
-*[[ListRemoveForm]]
-*[[ListRemoveNthForm]]
-*[[ListReplaceForm]]
-*[[ListGetNthForm]]
-*[[ListGetFormIndex]]
-*[[ListGetCount]]
-*[[AddFormToFormList]]
-*[[IsInList]]
-*[[IsWeaponInList]]
-[[Category:List Functions]]
-[[Category:List Functions (FOSE)]]
-[[Category:Functions]]
-[[Category:Functions (FOSE)]]