Difference between revisions of "Osiris/API/CharacterGetEquippedWeapon"
From Divinity Engine Wiki
(Created page with "===== Full Definition(s) ===== * query '''CharacterGetEquippedWeapon'''('''''[in]'''(CHARACTERGUID)'''''_Character''',''''' [out]'''''(''GUIDSTRING'')'''_ItemGUID''') ===== De...") |
|||
| (One intermediate revision by the same user not shown) | |||
| Line 2: | Line 2: | ||
* query '''CharacterGetEquippedWeapon'''('''''[in]'''(CHARACTERGUID)'''''_Character''',''''' [out]'''''(''GUIDSTRING'')'''_ItemGUID''') | * query '''CharacterGetEquippedWeapon'''('''''[in]'''(CHARACTERGUID)'''''_Character''',''''' [out]'''''(''GUIDSTRING'')'''_ItemGUID''') | ||
===== Description ===== | ===== Description ===== | ||
| − | Returns in '''_ItemGUID''' the | + | Returns in '''_ItemGUID''' the weapon wielded by '''_Character''' in their right hand. |
===== Return Values ===== | ===== Return Values ===== | ||
| − | * '''Success/Failure''': Fails if '''_Character''' does not exist, or if | + | * '''Success/Failure''': Fails if '''_Character''' does not exist, or if the character is not wielding a weapon in their right hand. |
* '''_ItemGuid''': The weapon equipped by '''_Character''' in their main (right) hand. | * '''_ItemGuid''': The weapon equipped by '''_Character''' in their main (right) hand. | ||
===== Notes ===== | ===== Notes ===== | ||
Latest revision as of 15:36, 21 December 2017
Full Definition(s)
- query CharacterGetEquippedWeapon([in](CHARACTERGUID)_Character, [out](GUIDSTRING)_ItemGUID)
Description
Returns in _ItemGUID the weapon wielded by _Character in their right hand.
Return Values
- Success/Failure: Fails if _Character does not exist, or if the character is not wielding a weapon in their right hand.
- _ItemGuid: The weapon equipped by _Character in their main (right) hand.
Notes
- This is equivalent to CharacterGetEquippedItem for the Weapon slot.
