Difference between revisions of "ListAddReference"

From GECK

m (Robot: Automated text replacement (-\[\[Category:(.*?)Functions \(GECK 1.0\)\]\] +Category:\1Functions (FOSE)))
(Automated import of articles)
Line 1: Line 1:
 +
'''ListAddReference'''
 
{{Function
 
{{Function
 
  |origin = FOSE1
 
  |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
 
  |name = ListAddReference
  |returnVal = addedAtIndex
+
  |alias = ListAddRef
 
  |returnType = int
 
  |returnType = int
  |referenceType = [Object]
+
  |referenceType = ref
 
  |arguments =  
 
  |arguments =  
 
   {{FunctionArgument
 
   {{FunctionArgument
   |Name = FormListID
+
   |Name = form list
 
   |Type = ref
 
   |Type = ref
 
   }}{{FunctionArgument
 
   }}{{FunctionArgument
 
   |Name = index
 
   |Name = index
 
   |Type = int
 
   |Type = int
   |Optional = y
+
   |Optional = optional
 
   }}
 
   }}
|example = myForm.ListAddReference myFormList
 
yourForm.ListAddReference yourFormList 4
 
 
}}
 
}}
 
+
[[Category:Functions_(FOSE)]]
==Notes==
+
*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]]
+
*[[ListGetNthForm]]
+
*[[ListGetFormIndex]]
+
*[[ListGetCount]]
+
*[[AddFormToFormList]]
+
*[[IsInList]]
+
*[[IsWeaponInList]]
+
 
+
[[Category:List Functions]]
+
[[Category:List Functions (FOSE)]]
+
[[Category:Functions]]
+
[[Category:Functions (FOSE)]]
+

Revision as of 11:22, 27 July 2010

ListAddReference

A function added by the Fallout Script Extender.

Description

Adds the calling reference at the given index (or at the end if not provided)

Syntax

(int) ref.ListAddReference form list:ref index:int 

Or:

(int) ref.ListAddRef form list:ref index:int
Personal tools