Difference between revisions of "ListGetCount"

Latest revision as of 05:08, 24 March 2015

< [[::Category:Functions|Category:Functions]]

A function added by the Fallout Script Extender.

Returns the count of items in the specified form list.

(Count:int) ListGetCount Target:formlist

int iCount

set iCount to ListGetCount AmmoList10mm ; * 3

@@ Line 1: / Line 1: @@
 {{Function
   |origin = FOSE1
-  |summary = Returns the size (number of forms) of a [[FormList]].
+  |summary = Returns the count of items in the specified form list.
   |name = ListGetCount
- |returnVal = size
+  |returnType = Count:int
-  |returnType = int
+  |arguments =
-  |arguments =
    {{FunctionArgument
-    |Name = FormListID
+    |Name = Target
-    |Type = ref
+    |Type = formlist
    }}
- |example = ListGetCount myFormList
 }}
+==Example==
+<pre>
+int iCount
-==Notes==
+set iCount to ListGetCount AmmoList10mm ; * 3
-*Useful when you need to loop through a [[FormList]]. See [[Scripting Tutorial: Working with FormLists]].
+</pre>
 ==See Also==
-*[[ListAddForm]]
+*[[ListGetNthForm]]
-*[[ListAddReference]]
-*[[ListRemoveForm]]
 *[[ListRemoveNthForm]]
-*[[ListReplaceForm]]
+*[[Ar_Size]] (equivalent for [[Array Variable|arrays]])
-*[[ListReplaceNthForm]]
+[[Category:Functions_(FOSE)]] [[Category:List_Functions]]
-*[[ListGetNthForm]]
-*[[ListGetFormIndex]]
-*[[AddFormToFormList]]
-*[[IsInList]]
-*[[IsWeaponInList]]
-[[Category:List Functions]]