Difference between revisions of "Osiris/API/CharacterGetEquippedItem"
From Divinity Engine Wiki
(Osiris Core APIs) |
|||
| (3 intermediate revisions by one other user not shown) | |||
| Line 5: | Line 5: | ||
===== Return Values ===== | ===== Return Values ===== | ||
* '''Success/Failure''': Fails if '''_Character''' does not exist, or if no item is equipped in '''_Slotname'''. | * '''Success/Failure''': Fails if '''_Character''' does not exist, or if no item is equipped in '''_Slotname'''. | ||
| − | * '''_ItemGuid''': The item equipped by '''_Character''' in '''_Slotname | + | * '''_ItemGuid''': The item equipped by '''_Character''' in '''_Slotname'''. |
===== Notes ===== | ===== Notes ===== | ||
* The valid values for '''_Slotname''' are: '''Helmet''', '''Amulet''', '''Breast''', '''Belt''', '''Gloves''', '''Leggings''', '''Boots''', '''Weapon''', '''Shield''', '''Ring''', '''Ring2'''. | * The valid values for '''_Slotname''' are: '''Helmet''', '''Amulet''', '''Breast''', '''Belt''', '''Gloves''', '''Leggings''', '''Boots''', '''Weapon''', '''Shield''', '''Ring''', '''Ring2'''. | ||
===== See Also ===== | ===== See Also ===== | ||
| − | * [[Osiris/API/CharacterUnequipItem]] | + | * [[Osiris/API/CharacterUnequipItem|CharacterUnequipItem]] |
| + | * [[Osiris/API/CharacterUnequipItem|CharacterEquipItem]] | ||
| + | * [[Osiris/API/CharacterGetEquippedWeapon|CharacterGetEquippedWeapon]] | ||
| + | * [[Osiris/API/CharacterGetEquippedShield|CharacterGetEquippedShield]] | ||
| − | [[Category:Osiris Queries]] | + | [[Category:Osiris Queries|CharacterGetEquippedItem]] |
Latest revision as of 15:23, 21 December 2017
Full Definition(s)
- query CharacterGetEquippedItem([in](CHARACTERGUID)_Character, [in](STRING)_Slotname, [out](GUIDSTRING)_ItemGUID)
Description
Returns in _ItemGUID the item equipped by _Character in slot _Slotname, if any.
Return Values
- Success/Failure: Fails if _Character does not exist, or if no item is equipped in _Slotname.
- _ItemGuid: The item equipped by _Character in _Slotname.
Notes
- The valid values for _Slotname are: Helmet, Amulet, Breast, Belt, Gloves, Leggings, Boots, Weapon, Shield, Ring, Ring2.
