Difference between revisions of "IsWeaponInList"

Revision as of 08:10, 3 August 2009

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

A function included in the GECK version 1.1.0.36.

Checks if the calling actor's currently equipped weapon is in the specified FormList.

(0, 1:int) [Actor].IsWeaponInList FormListID:ref

BuddyRef.IsWeaponInList GunsList

@@ Line 1: / Line 1: @@
-=='''Description'''==
+{{Function
+ |origin = GECK1
+ |summary = Checks if the calling actor's currently equipped weapon is in the specified [[FormList]].
+ |name = IsWeaponInList
+ |returnVal = 0, 1
+ |returnType = int
+ |referenceType = [Actor]
+ |arguments =
+  {{FunctionArgument
+   |Name = FormListID
+   |Type = ref
+  }}
+ |example = BuddyRef.IsWeaponInList GunsList
+}}
+==Notes==
+*None at this time.
-'''[[IsWeaponInList]]''' Determines if the current weapon in the form list. It is called on a reference (should have a container) and takes a form list as the parameter.
+==See Also==
+*[[ListAddForm]]
+*[[ListAddReference]]
+*[[ListRemoveForm]]
+*[[ListRemoveNthForm]]
+*[[ListReplaceForm]]
+*[[ListReplaceNthForm]]
+*[[ListGetForm]]
+*[[ListGetNthForm]]
+*[[ListGetFormIndex]]
+*[[ListGetcount]]
+*[[AddFormToFormList]]
+*[[IsInList]]
-=='''Syntax'''==
+[[Category:List Functions]]
- [''ActorREF''].IsWeaponInList ''FormList''
-=='''Examples'''==
- if BuddyRef.IsWeaponInList GunsList == 1
-Returns true if Buddy's current weapon is in the list.
-=='''Notes'''==
-*None at this time
-=='''See Also'''==
-[[IsInList]]
-=='''Reference'''==
-None provided.
-<!-- [[IsWeaponInList_Reference|List of functions that use IsWeaponInList]]  (wiki) -->
-[[Category:Functions]]
 [[Category:Condition Functions]]