Difference between revisions of "ListReplaceNthForm"

From GECK

m (Robot: Automated text replacement (-\[\[Category:(.*?)Functions \(GECK 1.0\)\]\] +Category:\1Functions (FOSE)))
(Automated import of articles)
Line 1: Line 1:
 +
'''ListReplaceNthForm'''
 
{{Function
 
{{Function
 
  |origin = FOSE1
 
  |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
 
  |name = ListReplaceNthForm
  |returnVal = removedForm
+
  |alias = ListReplaceNth
 
  |returnType = ref
 
  |returnType = ref
  |arguments =
+
  |arguments =  
 
   {{FunctionArgument
 
   {{FunctionArgument
   |Name = FormListID
+
   |Name = form list
 
   |Type = ref
 
   |Type = ref
 
   }}{{FunctionArgument
 
   }}{{FunctionArgument
   |Name = NewFormID
+
   |Name = replaceWith
 
   |Type = ref
 
   |Type = ref
 
   }}{{FunctionArgument
 
   }}{{FunctionArgument
   |Name = index
+
   |Name = formIndex
 
   |Type = int
 
   |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)]]
+

Revision as of 11:24, 27 July 2010

ListReplaceNthForm

A function added by the Fallout Script Extender.

Description

Replaces the nth form of the list with the specified form. Trait name is of the format used by GetUIFloat.

Syntax

(ref) ListReplaceNthForm form list:ref replaceWith:ref formIndex:int 

Or:

(ref) ListReplaceNth form list:ref replaceWith:ref formIndex:int
Personal tools