Difference between revisions of "GetEquipped"

Latest revision as of 05:50, 6 September 2015

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

Link to TES4 Construction Set Wiki: GetEquipped.

A function included in the GECK version 1.1.0.36.

Checks whether or not the calling actor has equipped the target object.

(bool) [Actor].GetEquipped Target:ObjectID

if Player.getEquipped MS06LincolnsHat

Evaluates True (1) if the player is wearing Lincoln's Hat

This function will only check for Armor and Weapon objects. It will not detect Armor Addon objects, such as integrated gloves or pieces of weapons like the Power Fist.
The argument can also be a Form List, in which case the function returns true if any item in the list is currently equipped by the PC.

@@ Line 1: / Line 1: @@
-{{Incomplete}}
+{{Function
+ |CSWikiPage = GetEquipped
+ |origin = GECK1
+ |summary = Checks whether or not the calling actor has equipped the target object.
+ |name = GetEquipped
+ |returnType = bool
+ |referenceType = [Actor]
+ |arguments =
+  {{FunctionArgument
+   |Name = Target
+   |Type = ObjectID
+  }}
+ |example = <pre>if Player.getEquipped MS06LincolnsHat</pre>
+Evaluates True (1) if the player is wearing Lincoln's Hat
+}}
-Link to TES4 Construction Set Wiki: [http://cs.elderscrolls.com/constwiki/index.php/GetEquipped GetEquipped].
+==Notes==
+* This function will only check for Armor and Weapon objects.  It will not detect Armor Addon objects, such as integrated gloves or pieces of weapons like the Power Fist.
+* The argument can also be a [[Form List]], in which case the function returns true if any item in the list is currently equipped by the PC.
+==See Also==
+*[[EquipItem]]
+*[[UnequipItem]]
+*[[GetEquippedObject]] (returns the actual object at a given slot)
+*[[GetEquippedCurrentHealth]]
 [[Category:Functions]]
-[[Category:Functions (GECK 1.0)]]
+[[Category:Functions (GECK 1.1)]]
+[[Category:Object_Functions]]
+[[Category:Condition_Functions]]