Difference between revisions of "Osiris/API/ItemRemoveRune"
From Divinity Engine Wiki
(Documented ItemRemoveRune) |
m |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
===== Full Definition(s) ===== | ===== Full Definition(s) ===== | ||
| − | * | + | * query '''ItemRemoveRune'''('''''[in]'''(CHARACTERGUID)'''''_Character''', '''''[in]'''(ITEMGUID)'''''_Item''', '''''[in]'''(INTEGER)'''''_Slot''', '''''[out]'''(ITEMGUID)'''''_Rune''') |
===== Description ===== | ===== Description ===== | ||
Removes the rune from rune slot '''_Slot''' of item '''_Item'''. If '''_Character''' is valid, the removed rune will be added to its inventory. | Removes the rune from rune slot '''_Slot''' of item '''_Item'''. If '''_Character''' is valid, the removed rune will be added to its inventory. | ||
| Line 7: | Line 7: | ||
===== Return Values ===== | ===== Return Values ===== | ||
* '''Success/Failure''': Fails if '''_Item''' is invalid, if '''_Slot''' is >= than the number of slots the item has, or if no rune is inserted in the specified slot. Specifying a value < 0 for '''_Slot''' will result in undefined behaviour. | * '''Success/Failure''': Fails if '''_Item''' is invalid, if '''_Slot''' is >= than the number of slots the item has, or if no rune is inserted in the specified slot. Specifying a value < 0 for '''_Slot''' will result in undefined behaviour. | ||
| − | * '''_Rune''': The removed rune. | + | * '''_Rune''': The removed rune. (newly created from the appropriate root template, not equal the inserted item) |
===== Notes ===== | ===== Notes ===== | ||
* This query is new in DOS2 Patch 6. | * This query is new in DOS2 Patch 6. | ||
Latest revision as of 22:23, 22 February 2018
Full Definition(s)
- query ItemRemoveRune([in](CHARACTERGUID)_Character, [in](ITEMGUID)_Item, [in](INTEGER)_Slot, [out](ITEMGUID)_Rune)
Description
Removes the rune from rune slot _Slot of item _Item. If _Character is valid, the removed rune will be added to its inventory.
See ItemGetRuneItemTemplate for the interpretation of the _Slot parameter.
Return Values
- Success/Failure: Fails if _Item is invalid, if _Slot is >= than the number of slots the item has, or if no rune is inserted in the specified slot. Specifying a value < 0 for _Slot will result in undefined behaviour.
- _Rune: The removed rune. (newly created from the appropriate root template, not equal the inserted item)
Notes
- This query is new in DOS2 Patch 6.
