Difference between revisions of "Osiris/API/ItemIsInInventory"
From Divinity Engine Wiki
(Osiris Core APIs) |
m |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 4: | Line 4: | ||
Returns whether '''_Item''' is in an inventory. This includes both character and container inventories. | Returns whether '''_Item''' is in an inventory. This includes both character and container inventories. | ||
===== Return Values ===== | ===== Return Values ===== | ||
| − | * Success/Failure''': | + | * '''Success/Failure''': Default return value. |
* '''_Bool''': 0 if '''_Item''' is not in an inventory (as defined above), 1 if it is. | * '''_Bool''': 0 if '''_Item''' is not in an inventory (as defined above), 1 if it is. | ||
===== Notes ===== | ===== Notes ===== | ||
| − | * / | + | * Unlike [[Osiris/API/GetInventoryOwner|GetInventoryOwner]], this call does not recurse into nested containers. |
===== See Also ===== | ===== See Also ===== | ||
| − | * [[Osiris/API/GetInventoryOwner]] | + | * [[Osiris/API/GetInventoryOwner|GetInventoryOwner]] |
| + | * Helper [[Osiris/Shared/DB_HasStoryEvent|DB_HasStoryEvent]] | ||
| − | [[Category:Osiris Queries]] | + | [[Category:Osiris Queries|ItemIsInInventory]] |
Latest revision as of 15:03, 24 March 2019
Full Definition(s)
- query ItemIsInInventory([in](ITEMGUID)_Item, [out](INTEGER)_Bool)
Description
Returns whether _Item is in an inventory. This includes both character and container inventories.
Return Values
- Success/Failure: Default return value.
- _Bool: 0 if _Item is not in an inventory (as defined above), 1 if it is.
Notes
- Unlike GetInventoryOwner, this call does not recurse into nested containers.
