Difference between revisions of "Osiris/API/CharacterGetEquippedShield"
From Divinity Engine Wiki
(Created page with "===== Full Definition(s) ===== * query '''CharacterGetEquippedShield'''('''''[in]'''(CHARACTERGUID)'''''_Character''',''''' [out]'''''(''GUIDSTRING'')'''_ItemGUID''') ===== De...") |
|||
| Line 2: | Line 2: | ||
* query '''CharacterGetEquippedShield'''('''''[in]'''(CHARACTERGUID)'''''_Character''',''''' [out]'''''(''GUIDSTRING'')'''_ItemGUID''') | * query '''CharacterGetEquippedShield'''('''''[in]'''(CHARACTERGUID)'''''_Character''',''''' [out]'''''(''GUIDSTRING'')'''_ItemGUID''') | ||
===== Description ===== | ===== Description ===== | ||
| − | Returns in '''_ItemGUID''' the | + | Returns in '''_ItemGUID''' the shield wielded by '''_Character''' in their left hand. |
===== Return Values ===== | ===== Return Values ===== | ||
* '''Success/Failure''': Fails if '''_Character''' does not exist, or if the character has no item in their left hand. | * '''Success/Failure''': Fails if '''_Character''' does not exist, or if the character has no item in their left hand. | ||
| − | * '''_ItemGuid''': The | + | * '''_ItemGuid''': The shield equipped by '''_Character''' in their off (left) hand. |
===== Notes ===== | ===== Notes ===== | ||
| − | * This is | + | * This is similar to [[Osiris/API/CharacterGetEquippedItem|CharacterGetEquippedItem]] for the '''Shield''' slot, except '''only''' for shield items. |
===== See Also ===== | ===== See Also ===== | ||
* [[Osiris/API/CharacterUnequipItem|CharacterUnequipItem]] | * [[Osiris/API/CharacterUnequipItem|CharacterUnequipItem]] | ||
Latest revision as of 17:30, 17 February 2018
Full Definition(s)
- query CharacterGetEquippedShield([in](CHARACTERGUID)_Character, [out](GUIDSTRING)_ItemGUID)
Description
Returns in _ItemGUID the shield wielded by _Character in their left hand.
Return Values
- Success/Failure: Fails if _Character does not exist, or if the character has no item in their left hand.
- _ItemGuid: The shield equipped by _Character in their off (left) hand.
Notes
- This is similar to CharacterGetEquippedItem for the Shield slot, except only for shield items.
