Difference between revisions of "GetEquipped"

From the Fallout3 GECK Wiki
Jump to navigation Jump to search
imported>Yukichigai
imported>Odessa
(clarified return + see also for FOSE functions)
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
  |returnVal = 0, 1
  |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>
Returns 1 if the player is wearing Lincoln's Hat
Evaluates True (1) if the player is wearing Lincoln's Hat
}}
}}


Line 21: Line 21:
*[[EquipItem]]
*[[EquipItem]]
*[[UnequipItem]]
*[[UnequipItem]]
*[[GetEquippedObject]] (returns the actual object at a given slot)
*[[GetEquippedCurrentHealth]]


[[Category:Functions]]
[[Category:Functions]]

Revision as of 05:27, 25 July 2014

< [[::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

[help]
(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.

See Also