Difference between revisions of "Osiris/API/UserRemoveTaggedLocalItems"
From Divinity Engine Wiki
(Documented UserRemoveTaggedLocalItems) |
m |
||
| Line 2: | Line 2: | ||
* query '''UserRemoveTaggedLocalItems'''('''''[in]'''(CHARACTERGUID)'''''_Character''', '''''[in]'''(STRING)'''''_Tag''', '''''[in]'''(INTEGER)'''''_Amount''',''''' [out]'''''(''INTEGER'')'''_AmountRemoved''') | * query '''UserRemoveTaggedLocalItems'''('''''[in]'''(CHARACTERGUID)'''''_Character''', '''''[in]'''(STRING)'''''_Tag''', '''''[in]'''(INTEGER)'''''_Amount''',''''' [out]'''''(''INTEGER'')'''_AmountRemoved''') | ||
===== Description ===== | ===== Description ===== | ||
| − | Removes up to '''_Amount''' items tagged with '''_Tag''' from the inventories of all characters that belong to the [[Osiris/API/CharacterGetReservedUserID|user]] that controls '''_Character''', and returns the number of removed items in ''' | + | Removes up to '''_Amount''' items tagged with '''_Tag''' from the inventories of all characters that belong to the [[Osiris/API/CharacterGetReservedUserID|user]] that controls '''_Character''', and returns the number of removed items in '''_AmountRemoved'''. |
===== Return Values ===== | ===== Return Values ===== | ||
* '''Success/Failure''': Fails if '''_Character''' does not exist or is not assigned to a user. | * '''Success/Failure''': Fails if '''_Character''' does not exist or is not assigned to a user. | ||
Revision as of 20:45, 28 February 2019
Full Definition(s)
- query UserRemoveTaggedLocalItems([in](CHARACTERGUID)_Character, [in](STRING)_Tag, [in](INTEGER)_Amount, [out](INTEGER)_AmountRemoved)
Description
Removes up to _Amount items tagged with _Tag from the inventories of all characters that belong to the user that controls _Character, and returns the number of removed items in _AmountRemoved.
Return Values
- Success/Failure: Fails if _Character does not exist or is not assigned to a user.
- _AmountRemoved: The number of items that were removed.
Notes
- This query succeeds even if fewer than _Amount items were removed (unless you also passed the same number as _AmountRemoved parameter, but even in that case those items will have been removed in spite of the query failing).
