Difference between revisions of "Osiris/API/CharacterUsedItem"
From Divinity Engine Wiki
(link related routines; mention that this event also gets thrown when pre-casting using an item and then cancelling) |
m |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 2: | Line 2: | ||
* event '''CharacterUsedItem'''(''(CHARACTERGUID)'''''_Character''', ''(ITEMGUID)'''''_Item''') | * event '''CharacterUsedItem'''(''(CHARACTERGUID)'''''_Character''', ''(ITEMGUID)'''''_Item''') | ||
===== Description ===== | ===== Description ===== | ||
| − | Thrown whenever a character uses (player clicks on it, or character uses from story/script) an item | + | Thrown whenever a character uses (player clicks on it, or character uses from story/script) an item. |
===== Parameters ===== | ===== Parameters ===== | ||
* '''_Character''': The character that used the item. | * '''_Character''': The character that used the item. | ||
* '''_Item''': The item that was used. | * '''_Item''': The item that was used. | ||
===== Notes ===== | ===== Notes ===== | ||
| − | * If a player clicks on an item that causes a skill to be cast (such as a grenade, special arrow or scroll), this event will be thrown immediately. This means you get it even if the player then decides to cancel the actual casting e.g. | + | * If a player clicks on an item that causes a skill to be cast (such as a grenade, special arrow or scroll), this event will be thrown immediately. This means you get it even if the player then decides to cancel the actual casting by, e.g., right-clicking instead of left-clicking on a target. |
===== See Also ===== | ===== See Also ===== | ||
* [[Osiris/API/CharacterUsedItemFailed|CharacterUsedItemFailed]] | * [[Osiris/API/CharacterUsedItemFailed|CharacterUsedItemFailed]] | ||
| Line 14: | Line 14: | ||
* Helper [[Osiris/Shared/ProcBlockUseOfItem|ProcBlockUseOfItem]] | * Helper [[Osiris/Shared/ProcBlockUseOfItem|ProcBlockUseOfItem]] | ||
| − | [[Category:Osiris Events]] | + | [[Category:Osiris Events|CharacterUsedItem]] |
Latest revision as of 15:08, 19 December 2017
Full Definition(s)
- event CharacterUsedItem((CHARACTERGUID)_Character, (ITEMGUID)_Item)
Description
Thrown whenever a character uses (player clicks on it, or character uses from story/script) an item.
Parameters
- _Character: The character that used the item.
- _Item: The item that was used.
Notes
- If a player clicks on an item that causes a skill to be cast (such as a grenade, special arrow or scroll), this event will be thrown immediately. This means you get it even if the player then decides to cancel the actual casting by, e.g., right-clicking instead of left-clicking on a target.
