Difference between revisions of "GetEquipped"
Jump to navigation
Jump to search
imported>Yukichigai |
imported>JT |
||
| (One intermediate revision by one other user not shown) | |||
| Line 4: | Line 4: | ||
|summary = Checks whether or not the calling actor has equipped the target object. | |summary = Checks whether or not the calling actor has equipped the target object. | ||
|name = GetEquipped | |name = GetEquipped | ||
| | |returnType = bool | ||
|referenceType = [Actor] | |referenceType = [Actor] | ||
|arguments = | |arguments = | ||
| Line 11: | Line 11: | ||
|Type = ObjectID | |Type = ObjectID | ||
}} | }} | ||
|example = <pre>Player.getEquipped MS06LincolnsHat</pre> | |example = <pre>if Player.getEquipped MS06LincolnsHat</pre> | ||
Evaluates True (1) if the player is wearing Lincoln's Hat | |||
}} | }} | ||
==Notes== | ==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. | * 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== | ==See Also== | ||
*[[EquipItem]] | *[[EquipItem]] | ||
*[[UnequipItem]] | *[[UnequipItem]] | ||
*[[GetEquippedObject]] (returns the actual object at a given slot) | |||
*[[GetEquippedCurrentHealth]] | |||
[[Category:Functions]] | [[Category:Functions]] | ||
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.
Description
Checks whether or not the calling actor has equipped the target object.
Syntax
(bool) [Actor].GetEquipped Target:ObjectID
Example
if Player.getEquipped MS06LincolnsHat
Evaluates True (1) if the player is wearing Lincoln's Hat
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