Difference between revisions of "IsInList"

Revision as of 09:02, 3 August 2009

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

A function included in the GECK version 1.1.0.36.

Checks if the calling reference's base object is contained in the specified FormList.

(0, 1:int) [Object].IsInList FormListID:ref

SamAdamsBeerRef.IsInList AlcoholicDrinks

@@ Line 1: / Line 1: @@
-=='''Description'''==
+{{Function
+ |origin = GECK1
+ |summary = Checks if the calling reference's base object is contained in the specified [[FormList]].
+ |name = IsInList
+ |returnVal = 0, 1
+ |returnType = int
+ |referenceType = [Object]
+ |arguments =
+  {{FunctionArgument
+   |Name = FormListID
+   |Type = ref
+  }}
+ |example = SamAdamsBeerRef.IsInList AlcoholicDrinks
+}}
+==Notes==
+*Use [[ListGetFormIndex]] to find the index of the form in the [[FormList]].
-'''*[[IsInList]]'''  This function takes a FormList as a parameter and returns 1 if the reference's base object is a member of the FormList or 0 if it is not.
+==See Also==
+*[[ListAddForm]]
+*[[ListAddReference]]
+*[[ListRemoveForm]]
+*[[ListRemoveNthForm]]
+*[[ListReplaceForm]]
+*[[ListReplaceNthForm]]
+*[[ListGetForm]]
+*[[ListGetNthForm]]
+*[[ListGetFormIndex]]
+*[[ListGetcount]]
+*[[AddFormToFormList]]
+*[[IsWeaponInList]]
-=='''Syntax'''==
+[[Category:List Functions]]
- IsInList FormListREF
-=='''Examples'''==
- IsInList FormList1
-=='''See Also'''==
-[[IsWeaponInList]]
-=='''Reference'''==
-None provided.
-<!-- [[IsInList_Reference|List of functions that use IsInList]]  (wiki) -->
-[[Category:Functions]]
 [[Category:Condition Functions]]